OpenMPT Wiki - User contributions [en]

Manual: MIDI Input / Output Plugin

2026-04-01T16:18:23Z

Saga Musix:

[[Image:MIDI Input Output Plugin.png|thumb|418px|MIDI Input / Output plugin window]]

The '''MIDI Input / Output Plugin''' is a versatile plugin for sending MIDI data to external devices or receiving MIDI input from external controllers.
This plugin complements OpenMPT’s other [[Manual: MIDI Reference|MIDI capabilities]] by allowing to access multiple devices, creating routings between MIDI devices or plugins and offering an extended version of the [[Manual: Zxx Macros|MIDI Macro]] functionality.

Multiple instances of the plugin can be used to address different devices simultaneously, though most MIDI drivers do not allow a single device to be used by multiple plugin instances at the same time.

== Configuration ==

=== MIDI Input Device ===
Selects the MIDI input device from which the plugin will receive MIDI messages. The received MIDI data can be sent to another plugin (through the [[Manual: General#Mix Settings|plugin routing settings]]), or be recorded as pattern data through the '''Record Parameter Changes''' and '''Record MIDI Out to Pattern Editor''' options available from the plugin editor’s [[Manual: Plugin Window#Options|menu bar]].

=== MIDI Output Device ===
Selects the destination for MIDI data sent by the plugin. This can be any external MIDI device, or virtual MIDI routing ports. The special '''Internal OpenMPT Output''' option sends MIDI data to the next plugin in the chain instead, allowing the extended MIDI macro system of this plugin (see below) to be used with other plugins.

By default, the MIDI data is sent out at roughly the same moment OpenMPT’s output is heard. To synchronize the MIDI data with other sound sources, you can delay the MIDI output further by entering a positive '''Output Latency''' if the MIDI data is heard too early. On the other hand, if the MIDI data is heard too late, you can also enter a negative latency amount, down to OpenMPT’s own [[Manual: Setup/Soundcard#Latency|configured latency]], to compensate for any delays introduced by the MIDI port or target MIDI device.

When the '''Send timing messages''' box is checked, OpenMPT will send the following additional MIDI messages:
* Song Start (<code>FA</code>) and Song Stop (<code>FC</code>).
* Song Position Pointer (<code>F2</code>) on every manual position change or start of new measure, up to the maximum possible PPQ position of 16,383 sixteenth notes.
* MIDI Clock (<code>F8</code>).

=== Initial MIDI Dump ===
This allows you to configure specific MIDI messages to be sent either when the module plays for the first time (with '''Only send once''' checked) or every time playback restarts. Typical use cases include sending device-specific SysEx configuration messages to external MIDI devices, or setting up initial patch changes and controller values.

The '''Send Now''' button allows to test the entered MIDI messages immediately during playback.

You can import SysEx dump files (.syx) to avoid manual entry of long MIDI messages using the '''Import Dump...''' button.

=== Parameter Macros ===
1,000 plugin parameters are available to be configured to send arbitrary MIDI messages. These macros offer several advantages over regular [[Manual: Zxx Macros|MIDI Macros]]:

* Obviously, you are no longer limited to just 16 different macros.
* While regular MIDI macros have a 31-character limit, plugin macros can contain MIDI message sequences of any length.

The plugin macros follow the same [[Manual: Macro Configuration#Macro Syntax|macro syntax]] as regular MIDI macros. The '''z''' variable is controlled by the plugin parameter value.

You can use [[Manual: Parameter Control Events|Parameter Control Events]] to control these parameters, or, maybe a bit pointlessly, Zxx MIDI macros.

[[Category:Manual|MIDI Input / Output Plugin]]
[[Category:Plugins|MIDI Input / Output Plugin]]
[[Category:Built-In Plugins|MIDI Input / Output Plugin]]

Manual: About OpenMPT

2026-04-01T16:17:36Z

Saga Musix:

== What is Open ModPlug Tracker? ==

OpenMPT is a third-generation '''[https://en.wikipedia.org/wiki/Music_tracker tracker]''' — a music application with a focus on a mostly textual note representation with a strong keyboard focus. It comes with a built-in sampler but may also make use of external sound generators, including external MIDI synthesizers and “virtual synthesizers” called VST instruments. Contrary to many other trackers, OpenMPT makes use of the Windows environment, using the operating system’s native look and feel with sliders and buttons for visual-based input.

While the text display may look intimidating and old-fashioned compared to the big well-known '''sequencers''' at first, it allows for a very fast music composition process for the experienced user. The text-based event editing system is aided by a graphical sample editor and built-in sampler, and note data can be input through the computer’s keyboard or any external MIDI gear. With its flexibility, OpenMPT can appeal to all composers from electronic dance music genres to experimentalists to classical composers.

== Feature Overview ==

* It’s totally '''free'''!
* The workspace is intuitive and efficient, with a simple Windows-oriented interface, plenty of tooltips everywhere, and separate specific sections of work into tabs.
* It allows for a rich set of options and preferences, including:
** Ability to customize the [[Manual: Setup/Display|GUI colour]] (but no skins yet), including colour schemes and custom pattern fonts.
** Optional global [[Manual: Setup/DSP|DSP effects]] including an equalizer.
** Up to 128 channels for pattern data (each with their own volume, pan, and plugin settings, as well as customizable channel names), and separate volume controls for sample playback, instrument plugins, and overall global volume.
** Customizable audio playback quality (interpolation quality, sample rate and bit depth), polyphony, and latency settings.
** Ability to [[Manual: Setup/Paths / Auto Save|automatically save]] the current file at intervals — and to a location — of your choosing.
** Ability to customize most actions with [[Manual: Setup/Keyboard|keyboard shortcuts]], including navigation, input, and opening dialog boxes.
* It has a [[Manual: Tree View|side panel]] with expandable directory view to locate relevant files quickly.
* It can open or import a wide range of [[Manual: Module formats|tracker formats]], including backward compatibility with files saved under previous versions of OpenMPT.
* It can [[Manual: Saving_and exporting|export]] to a variety of streaming audio formats such as WAV, FLAC and MP3, as well as render individual patterns, channels or instruments.
* It can extract instruments and samples from soundfonts, like the General MIDI soundfont that comes pre-installed with Windows (GM.DLS).
* [[Manual: MIDI Input / Output Plugin|MIDI input and output]] to record from and playback on external MIDI devices.
* It can make use of VST 1.x and VST 2.x plugins, as well as DirectX Media Objects.
* It can output audio through many different sound drivers, including WASAPI (default), ASIO, WaveRT, and others.
* It can apply [[Manual: Tunings|alternate tunings]] (including scales and temperaments) to sample playback.

== Limitations ==

* Limited control for editing of sample data.
* Alternate temperaments cannot be applied to instrument plugins.
* Can only use a text-based editing system; no piano-roll or musical score editing.
* Only available as a native Windows program, but can also run in Wine on Mac computers and Linux.

== History ==

The ModPlugin was originally developed in the mid-90s by Olivier Lapicque as a plugin for Internet browsers to listen to tracked music files (such as .mod and .it files). From this plugin, he developed the ModPlug Player and the ModPlug Tracker. ModPlug Player can play a very wide variety of tracked music formats, and offers many different audio effects, such as graphic equalizer, reverb, and Surround Sound. Although it is still available, the Player is not open-source nor is it being developed further.

ModPlug Tracker became completely open-source in 2004, allowing the actual application to be developed and the code altered for the correction of long-standing bugs and the implementation of new features, such as the advanced use of VST plugins and alternate tunings. It has been rated as one of the top five free music trackers by the Computer Music Magazine, and has a vibrant [https://openmpt.org/community community].

[[Category:Manual|About OpenMPT]]

Development: Formats/IT

2026-03-22T22:30:46Z

Saga Musix: /* Edit History */

General information concerning the IT file format. Any variable names in this document refer to the original variable names from [https://github.com/schismtracker/schismtracker/wiki/ITTECH.TXT ITTECH.TXT]. Variable names and hexadecimal numbers (in little-endian formats) are indicated by a <tt>monospace font</tt>.

Note: Impulse tracker is now open source! You can grab the [https://github.com/jthlim/impulse-tracker source code] at GitHub.

== Tracker IDs ==

The IT header contains a field, <tt>Cwt/v</tt>, which is used to identify the application that was used to create the file.
The following custom tracker IDs (read as little-endian hexadecimal numbers) are known to be found in the <tt>Cwt/v</tt> field:

* <tt>0xyy</tt> - Impulse Tracker x.yy - Many other trackers, like ModPlug Tracker, disguise as various versions of Impulse Tracker, so this is not a reliable way to tell if a file was really made with Impulse Tracker. See [[#Detecting other trackers|below]] for detecting such trackers.
* <tt>1xyy</tt> - Schism Tracker x.yy up to Schism Tracker v0.50, later versions encode a timestamp in the version number - see Schism Tracker’s <tt>[https://github.com/schismtracker/schismtracker/blob/master/schism/version.c version.c]</tt> or OpenMPT’s <tt>[https://source.openmpt.org/browse/openmpt/trunk/OpenMPT/soundlib/Load_it.cpp Load_it.cpp]</tt>.
* <tt>4xyy</tt> - pyIT x.yy
* <tt>5xyy</tt> - OpenMPT x.yy - lower two bytes of version number are stored in the "reserved" header field starting from OpenMPT 1.29.10.00 in compatible mode (otherwise OpenMPT song extensions are used as before).
* <tt>6xyy</tt> - BeRoTracker x.yy
* <tt>7xyz</tt> - ITMCK x.y.z (N.B. the user can override the value of the <tt>Cwt/v</tt> header by the <tt>-w</tt> command-line switch or the <tt>#TRACKER-VERSION</tt> command in the input file)
* <tt>7FFF</tt>, <tt>Cmwt = 0215</tt>: munch.py
* <tt>8xyy</tt> - Tralala x.yy; prealpha versions, built from svn, before the first release identify as version 0.00 (i.e. Cwt/v=8000)
* <tt>Cxyy</tt> - ChickDune ChipTune Tracker x.yy (currently non-public alpha version)
* <tt>DAEB</tt> - spc2it (after commit d3d1b524032f668be8ee20d25339e1c635fb9bcf)
* <tt>D1CE</tt> - [https://github.com/chr15m/itwriter itwriter] JavaScript library (user can change this default)
* <tt>EFFF</tt> - rosetracker (in development)

Are you a tracker developer and your tracker can save IT files? Please add your Tracker ID to this list!

Once we run out of tracker IDs, a more sophisticated approach will have to be found. For example, the ID <tt>0FFF</tt> could be reserved, and a pointer to extended tracker information could be placed in the <tt>reserved</tt> header field.

== Detecting other trackers ==

Some trackers disguise as Impulse Tracker 2, but there are ways to uncover this disguise:

=== BeRoTracker ===

Earlier versions of BeRoTracker, which did not use the tracker ID described above, can be identified by the four byte <tt>MODU</tt> magic which can be found after the Edit History / MIDI Macro / ModPlug extension block. <tt>Cwt/v</tt> is <tt>0217</tt> and <tt>Cmwt</tt> is <tt>0214</tt> or <tt>0200</tt> (overlaps with ModPlug Tracker). The edit history flag is set and there are always 0 entries in the edit history.

=== CheeseTracker ===

* <tt>Cwt/v</tt> and <tt>Cmwt</tt> are both <tt>0214</tt>
* Instrument mode flag is always set. The only other flags that can be optionally set are: Stereo Mode, Linear Slides, Old Effects, Compatible Gxx.
* The only <tt>special</tt> flag ever set is the song message flag (even though row highlights are always written).
* <tt>reserved</tt> is <tt>0</tt>
* All sample and instrument filenames read <tt>XXXXXXXX.YYY</tt> (obviously this should not be used as a stand-alone detection criterion, as files re-saved with other trackers will still use these filenames).

=== ChibiTracker ===

<tt>Cwt/v</tt> and <tt>Cmwt</tt> are both <tt>0214</tt>, <tt>reserved</tt> reads <tt>CHBI</tt>.

Further interesting criteria: Sample data is stored directly after header. All sample and instrument filenames read <tt>-DEPRECATED-</tt> (obviously this should not be used as a stand-alone detection criterion, as files re-saved with other trackers will still use these filenames). ChibiTracker also uses a line feed character (<tt>0A</tt> or <tt>\n</tt>) instead of a carriage return (<tt>0D</tt> or <tt>\r</tt>) in the song message.

=== ModPlug Tracker ===

* '''ModPlug Tracker 1.0 pre-alpha 4 (and possibly earlier) - 1.0 alpha 4''': <tt>Cwt/v</tt> is <tt>0202</tt>, <tt>Cmwt</tt> is <tt>0200</tt>, <tt>reserved</tt> is <tt>0</tt>, row highlights are both 0. These attributes alone are not enough to fingerprint these ModPlug Tracker versions, but luckily it also stores the remaining data in a very peculiar order: patterns first, then instrument headers, and then interleaves sample headers and their corresponding sample data. These versions also do not optimize empty 64-row patterns with a 0 parapointer, so they can be identified by checking if the first pattern parapointer is not 0 and less than the first sample parapointer.
* '''ModPlug Tracker 1.0 alpha 5''': <tt>Cwt/v</tt> is <tt>0214</tt>, <tt>Cmwt</tt> is <tt>0200</tt>, <tt>reserved</tt> is <tt>0</tt>. Pattern highlights and edit history flags are not set. Instruments are 560 bytes apart.
* '''ModPlug Tracker 1.0 alpha 6 / beta 1 / beta 2''': <tt>Cwt/v</tt> is <tt>0214</tt>, <tt>Cmwt</tt> is <tt>0200</tt>, <tt>reserved</tt> is <tt>0</tt>. Pattern highlights and edit history flags are set. Instruments are 560 bytes apart up to and including beta 1, in beta 2 they are 557 bytes apart.
* '''ModPlug Tracker 1.0 beta 3.2 - 1.09 build 66 (possibly up to build 77)''': <tt>Cwt/v</tt> is <tt>0214</tt>, <tt>Cmwt</tt> is <tt>0202</tt>, <tt>reserved</tt> is <tt>0</tt>. Instruments are 557 bytes apart.
* Newer versions of '''ModPlug Tracker''', '''OpenMPT 1.17 in compatible mode''': <tt>Cwt/v</tt> is <tt>0217</tt>, <tt>Cmwt</tt> is <tt>0200</tt>, <tt>reserved</tt> is <tt>0</tt>. If there are any instruments in the file, the instrument <tt>TrkVers</tt> field is <tt>0211</tt> for ModPlug Tracker and <tt>0220</tt> for OpenMPT. ModPlug Tracker writes <tt>FF</tt> for unused channels in the panning map, OpenMPT never does this. When an IT file uses all 64 channels (so the panning map cannot be used for distinction), the presence of ModPlug extensions (channel names, plugin chunks, etc.) can help telling MPT 1.16 and OpenMPT 1.17 compatibility export apart. The latter also does not save a final "---" order list item, while MPT 1.16 does.

=== OpenMPT ===

* OpenMPT 1.17.02.20 to OpenMPT 1.17.02.25 wrote the value <tt>0300</tt> in both the <tt>Cwt/v</tt> and <tt>Cmwt</tt> fields.
* OpenMPT 1.17.02.26 to OpenMPT 1.18 wrote the value <tt>0888</tt> in both the <tt>Cwt/v</tt> and <tt>Cmwt</tt> fields.
* Later versions of OpenMPT use the tracker ID provided above. In that case, the <tt>reserved</tt> field reads <tt>OMPT</tt> if the file was saved in normal mode, and is <tt>0</tt> (or the lower two bytes of version information starting from OpenMPT 1.29.10.00) if it was saved in compatible mode.

=== OpenSPC conversions ===

OpenSPC is a tool to convert SNES music from the SPC format to the IT format. If all the following conditions are true, you can be fairly sure that a module was written with OpenSPC:
* <tt>Cwt/v</tt> is <tt>0214</tt>.
* <tt>Cmwt</tt> is <tt>0200</tt>.
* <tt>Flags</tt> is <tt>09</tt> (Linear Slides, Stereo Playback).
* <tt>Special</tt> is <tt>0</tt>.
* Both pattern highlight values are <tt>00</tt>.
* No instruments are used.
* <tt>PatNum</tt> + 1 == <tt>OrdNum</tt>.
* Global volume is 128 decimal.
* Master volume is 100 decimal.
* Initial Speed is 1.
* Pan Separation is 128 decimal.
* Pitch wheel depth is 0.
* There is no song message, i.e. message length and offset are 0.
* <tt>reserved</tt> is 0.

Earlier versions of spc2it (before commit d3d1b524032f668be8ee20d25339e1c635fb9bcf) will be mis-identified as OpenSPC, as the tool closely follows the way its predecessor writes out IT files.

=== Unknown XM to IT conversion tool ===

There is a currently unknown XM to IT conversion tool which can be identified easily by the fact that it writes unsigned samples (which was the default only until Impulse Tracker 2.01). However, only sample slots with actual sample data should be considered for this test, as re-saving such a file in Impulse Tracker will not reset the unsigned flag for empty slots. If the following conditions are true, you can be fairly sure that a module was written with the unknown converter:
* <tt>Cwt/v</tt> is <tt>0204</tt>.
* <tt>Cmwt</tt> is <tt>0200</tt>.
* <tt>Flags</tt>: Stereo Playback, Instrument Mode, Old Effects are always set, Linear Slides are optional.
* <tt>Special</tt> is <tt>0</tt>.
* Both pattern highlight values are <tt>0</tt>.
* Global volume is 128 decimal.
* Master volume is 48 decimal.
* Pan Separation is 128 decimal.
* Pitch wheel depth is 0.
* There is no song message, i.e. message length and offset are 0.
* <tt>reserved</tt> is 0.
* Song title is no longer than 20 characters.
* All channels are panned centre (32) or muted, and their volume is 64 decimal.

To be extra sure, you can check all of these properties, but just checking <tt>Cwt/v</tt>, <tt>Cmwt</tt> and unsigned sample data is probably enough.

=== UNMO3 ===

UNMO3 is a tool to convert an MO3-compressed module file back into its original format.

In IT files created with UNMO3, the following are always true:

* <tt>Cwt/v</tt> and <tt>Cmwt</tt> are <tt>0214</tt>
* <tt>reserved</tt> is <tt>0</tt>
* <tt>pwd</tt> is 0
* Both row highlights are 0
* Flags: Use MIDI Pitch Controller (bit 6) and Request embedded MIDI configuration (bit 7) are never set

This partially overlaps with Impulse Tracker 2.14 and CheeseTracker fingerprints, however:
* CheeseTracker should write non-zero row highlights, even when resaving an UNMO3-ed file.
* It is highly unlikely that Impulse Tracker 2.14 writes a <tt>reserved</tt> value of <tt>0</tt>. If it writes zero row highlights, the row highlight <tt>special</tt> flag is set.
* Impulse Tracker 2.14 never writes an empty edit history (see below).
* CheeseTracker always uses instrument mode.

Some older versions of UNMO3 write out IT files that are malformed in some way or another, but it is easy to detect and work around. Some UNMO3-ed IT files are floating around in the wild, so it may be worthwile to implement those work-arounds:

==== Special flags prior UNMO3 2.4.0.2 ====

* UNMO3 2.4 (released in 2008) and older sets the <tt>special</tt> flag bits 1 (edit history) and 2 (row highlights) whenever bit 3 (MIDI macros) is set as well.
* UNMO3 2.4.0.1 (January 2011) always sets the <tt>special</tt> flag bit 1 (edit history), but the behaviour for bit 2 (row highlights) remains as in previous versions.
* UNMO3 2.4.0.2 (July 2011) never sets the row highlights flag.

==== Sample mode prior to UNMO3 2.4.0.1 ====

UNMO3 2.4 and older reserves space for the instrument parapointers (as many as there are samples) even when the IT file is in sample mode. This can be detected by the fact that 4 * <tt>SmpNum</tt> zero bytes follow after the pattern parapointers. These bytes need to be skipped in order to be able to read MIDI macros and ModPlug plugin settings which may potentially follow.

UNMO3 2.4.0.1 fixes this problem.

==== Edit History prior to UNMO3 2.4.0.1 ====

As mentioned above, UNMO3 older than version 2.4.0.1 may or may not set the edit history flag, but they always write two edit history length bytes (zeroes) in the file anyway. Keep this in mind, as MIDI Macros and ModPlug plugin settings will not load properly if you don’t.

* '''Edit history flag is set''': Nothing needs to be done. We can still use this for identifying UNMO3-saved IT files, because Impulse Tracker never writes an edit history of length 0.
* '''Edit history flag is not set''': This is the troublesome case due to MIDI macros and plugin settings. However, a reliable way to detect such malformed IT files would be to try to read the edit history length if all of the above detection criteria for UNMO3 are fulfilled. For those old UNMO3 versions, you should read two zero bytes. If that is the case, it means that the first MIDI macro would be empty (if MIDI macros are embedded) or the first plugin chunk ID starts with two zero bytes (impossible). Since UNMO3 writes out default values for the nine global MIDI macros, the first MIDI macro would have to start with “FF” (MIDI Start) and not be empty, so it is clear that the two zero bytes belong to the (empty) edit history.

Later version of UNMO3 set the correct header flag for the edit history and write the two zero length bytes.

== Special Header Flags ==

The following "Special" flags are not documented:

* Bit 1 (<tt>02</tt>): If set, edit history information (see [[#Edit History|below]]) is present.
* Bit 2 (<tt>04</tt>): If set, the row highlights (at offset <tt>1E</tt> - <tt>1F</tt>) should be read. If not set, they should be ignored.

== Edit History ==

It is little known that Impulse Tracker 2.08 and later keep track of when an IT file is opened and how long it is left open.
The edit history can be found directly after the IT header and before the possibly present MIDI macro configuration.

A 16-Bit integer <tt>num</tt> tells how many edit history blocks are present. Every block is 8 bytes long, so the 16-bit integer is followed by <tt>8 * num</tt> bytes of edit history information.

Each history block consists of a 16-Bit FAT date, a 16-Bit FAT time and a 32-Bit DOS timer, which contains the time how long the file was open in the editor, in 1/18.2th seconds.
Information on how to decode the FAT date and time stamps can be found on the [https://msdn.microsoft.com/en-us/library/windows/desktop/ms724247%28v=vs.85%29.aspx MSDN].

Note: Many programs don’t write an edit history, but they set the edit history flag in the header and write the two zero bytes for the history length. Many of them also ignore the edit history flag when loading files and always read the two <tt>num</tt> bytes (ignoring the special flag), so if you want to write out an IT file that does not have an edit history and do not mind about the two extra bytes, the safest (most compatible) way is to set the edit history flag and write two zero bytes for <tt>num</tt>.

Also note that none of this is really relevant if you are sure that you never write out the MIDI macro configuration or ModPlug extensions, since these are the only two things that could normally follow the edit history. So if you have no MIDI macros and no ModPlug extensions, it is always safe to not set the special flag and not write the two extra bytes.

== Edit Timer ==

Before the addition of the full Edit History, a simple Edit Timer was stored in the <tt>reserved</tt> field of the file header. Starting from Impulse Tracker 2.07, this field contains the total edit time as a 32-Bit DOS timer (same resolution as in the Edit History). Starting from Impulse Tracker 2.08, the timer is encrypted. To decrypt:

editTime = editTime XOR 'ITRK'
editTime = editTime RoR 7
editTime = -editTime
editTime = editTime RoL 4
editTime = editTime XOR 'JTHL'

== Proposed way to store compressed stereo samples ==

Since Impulse Tracker itself does not support stereo samples, a common way of how to decode compressed stereo samples had to be found - After all, it is possible to just treat them as one continuous stream (not stopping the encoding / decoding process after the end of the left channel), or to treat them as two separate, consecutive streams. XMPlay was probably the only player that could handle compressed stereo samples even before there was a single implementation for saving compressed stereo samples. GreaseMonkey has decided to follow [https://www.un4seen.com/forum/?topic=12448.msg86479#msg86479 XMPlay's way] of decoding compressed stereo samples by treating them as two streams of the same length, so OpenMPT follows this example. If you intend to add IT sample compression support in your application, you should do the same to ensure compatibility across as many applications as possible.

== OpenMPT Hacks ==

For a list of all the file format hacks that ModPlug Tracker / OpenMPT added to the IT format over the years, see the [[Development: OpenMPT Format Extensions|OpenMPT Format Extensions]] article.

[[Category:Development|Formats/IT]]
[[Category:IT Format|Format Specification]]

Development: Test Cases/MOD

2026-01-26T20:23:45Z

Saga Musix: ArpWraparound.mod corrected explanation

{{Testsuite Introduction|format=MOD|tracker=ProTracker}}

{{Testcase|format=mod|name=AmigaLimitsFinetune.mod|pass=1555}}
ProTracker does not always clamp samples to the exact same range of periods — it rather depends on the actual finetune value of the sample. In contrast to that, Scream Tracker 3 always clamps periods to the same range in its Amiga mode. This test file should stay completely in tune at all times.

{{Testcase|format=mod|name=ArpWraparound.mod|pass=1537 + 6738}}
If an arpeggio parameter exceeds the Amiga frequency range, ProTracker wraps it around. In fact, the first note that is too high (which would be C-7 in OpenMPT or C-4 in ProTracker) will play at a period of 0 (which effectively results in a period of 65536), C#7 / C#4 becomes C-4 / C-1, and so on.

{{Testcase|format=mod|name=DelayBreak.mod|pass=2108}}
If there is a row delay (EEx) on the same row as a pattern break (Dxx), the target row of that jump is not played. Instead, the next row is played.

{{Testcase|format=mod|name=finetune.mod}}
ProTracker’s E5x finetune handling is a bit weird. It is also evaluated if there is no note next to the command, and the command is also affected by 3xx portamentos.

{{Testcase|format=mod|name=InstrDelay.mod|pass=4212 + 8653 + 8674}}
ProTracker always loads the new instrument settings (volume, finetune and sample pointer) on the first tick, even if there is a note delay. The new sample pointer is only used if the current sample is looped and its loop end is reached.

This quirk is implemented in ProTracker 1/2 mode.

{{Testcase|format=mod|name=InstrSwapRetrigger.mod|pass=18955 + 18956}}
Instrument swapping should happen instantly (not at the end of the sample or end of sample loop like in [[#PTInstrSwap.mod|PTInstrSwap.mod]]) when there is an E9x retrigger command next to a lone instrument number. As with regular sample swapping, the sample finetune is not updated. The left and right channel of this module should sound identical.

Note that the retrigger command can cause semi-random tiny delays with ProTracker on a real Amiga, so if there are small differences in phase between the left and right channel when playing this test in ProTracker but not in an external player, this is acceptable.

{{Testcase|format=mod|name=NoteDelay-NextRow.mod|pass=8730}}
In ProTracker, a note delay greater than the current speed will cause the delayed note to be played on the first tick of the next row if there is no new note on the next row (even if that new note is also delayed). However, the note is note restarted but rather continues where a previous note left off playing (like an instant portamento).

{{Testcase|format=mod|name=PatLoop-Break.mod|pass=5402}}
Just as with XM and IT, a pattern break should not reset the pattern loop counter. You should hear two noise bursts, followed by the words “success”.

{{Testcase|format=mod|name=PatternDelaysRetrig.mod|pass=9152}}
When there is a row delay (EEx), fine slides and note delays should be executed on every row repetition.

Note. OpenMPT does not apply ProTracker behaviour for this quirk if the MOD file contains more than 4 channels or notes outside of the Amiga frequency range. This is to avoid some potential issues with infinite pattern loops due to row delays that e.g. FastTracker 2 doesn't have (and thus FT2-made MODs would get stuck in an infinite loop where they should not).

{{Testcase|format=mod|name=PatternJump.mod|pass=1321}}
A Bxx command should reset the effect of a Dxx command that is left of the Bxx command. You should hear a voice saying “success”.

{{Testcase|format=mod|name=PortaSmpChange.mod|pass=3578}}
The interpretation of this scenario highly differs between various replayers. If the sample number next to a portamento effect differs from the previous number, the new sample's default volume should be applied and
* the old sample should be played until reaching its end or loop end (ProTracker 1/2). If the sample loops, the new sample should be activated after the loop ended.
* the old sample should keep playing (various other players)
OpenMPT implements the second option in normal playback mode and the first option in ProTracker 1/2 mode.

{{Testcase|format=mod|name=PortaSwapPT.mod|pass=6614 + 8665}}
Related to [[#PortaSmpChange.mod|PortaSmpChange.mod]], this tests the portamento with sample swap behaviour for ProTracker-compatible MODs.
Noteworthy tested behaviours:
* When doing a sample swap without portamento, the new sample keeps using the old sample’s finetune.
* When doing a sample swap with portamento, the new sample’s finetune is instantly applied, and the new sample is started as soon as the old sample’s loop is finished playing.

{{Testcase|format=mod|name=PortaTarget.mod|pass=4726}}
ProTracker’s portamento behaviour is somewhere between FT2 and IT:
* A new note (with no portamento command next to it) does not reset the portamento target. That is, if a previous portamento has not finished yet, calling 3xx or 5xx after the new note will slide it towards the old target.
* Once the portamento target period is reached, the target is reset. This means that if the period is modified by another slide (e.g. 1xx or 2xx), a following 3xx will not slide back to the original target.

{{Testcase|format=mod|name=PTInstrSwap.mod|pass=4223}}
When specifying an instrument number without a note, ProTracker 1/2 instantly applies the new instrument settings, but does not use the new sample until the end of the (loop of the) current sample is reached. In this example, sample 2 should be played at maximum volume as soon as instrument number 1 is encountered in the pattern, then sample 1 should be triggered somewhere around row 10 and then stop playing at around row 18.

{{Testcase|format=mod|name=PTInstrVolume.mod|pass=12249}}
This test verifies that a volume command set together with an instrument but no note will be kept once the note is triggered later.

{{Testcase|format=mod|name=ptoffset.mod|pass=4018}}
ProTracker 1/2 has a slightly buggy offset implementation which adds the offset in two different places (according to tracker_notes.txt coming with libxmp: "once before playing this instrument (as is expected), and once again after this instrument has been played"). The left and right channel of this module should sound identical. OpenMPT emulates this behaviour correctly in ProTracker mode.

{{Testcase|format=mod|name=PTOffsetRetrigger.mod|pass=22218}}
In ProTracker, the retrigger command also re-applies a previous note offset if there is no instrument number. The left and right channels should play identically, and the distorted sound at the beginning of the sample should never be heard.

{{Testcase|format=mod|name=PTRetrigger.mod|pass=14872}}
This tests the E9x implementation against the ProTracker implementation. Left and right channel should retrigger at the same intervals.

In summary, this is how the retrigger effect should work:
* If current tick is 0 and there is a note, do not retrigger
* If effect parameter is greater than 0, and the current tick modulo the parameter is 0, do retrigger

Note that the current tick counts upwards (starting at 0), and is reset on every repetition caused by the EEx (row delay) command.

{{Testcase|format=mod|name=PTStoppedSwap.mod|pass=21029}}
When a non-looped sample stopped playing, it is still possible to perform sample swapping to a looped sample. As a result, on the first and third row, a square wave should be heard, a drum on the second and fourth row, but no new sample should be triggered on the fifth row.

{{Testcase|format=mod|name=PTSwapEmpty.mod|pass=4950}}
ProTracker instrument swapping (see [[#PTInstrSwap.mod|PTInstrSwap.mod]] test case) also works when swapping from an empty sample slot back to a normal slot: If the sample was already swapped, it is restarted immediately.

{{Testcase|format=mod|name=PTSwapNoLoop.mod|pass=11843 + 11844}}
ProTracker instrument swapping (see [[#PTInstrSwap.mod|PTInstrSwap.mod]] test case) should also work when the "source" sample is not looped. However, when the "target" sample is not looped, sample playback should stop as with [[#PTSwapEmpty.mod|PTSwapEmpty.mod]]. Conceptually this can be explained because in this case, the sample loop goes from 0 to 2 in "oneshot" mode, i.e. it will loop a (hopefully) silent part of the sample.

{{Testcase|format=mod|name=TempoChange.mod|pass=8732}}
ProTracker applies any tempo changes after the first tick (so at one tick per row, they happen on the next row).

{{Testcase|format=mod|name=VibratoReset.mod|pass=1556}}
Like many other trackers, ProTracker does not advance the vibrato position on the first tick of the row. However, it also does not ''apply'' the vibrato offset on the first tick, which results in somewhat funky-sounding vibratos. OpenMPT uses this behaviour only in ProTracker 1/2 mode. The same applies to the tremolo effect.

{{Testcase Summary}}

[[Category:Development|Test Cases/MOD]]
[[Category:MOD Format|Test Cases]]

Manual: Samples

2025-12-08T18:21:08Z

Saga Musix: /* Sample Loops */

[[Image:Sample Tab.png|thumb|300px|Sample Tab]]

On the sample tab, you find all the tools needed to load, edit and create new samples or OPL instruments. Samples, besides synthesizer plugins, are the main sound source in OpenMPT. Depending on the module format used, they are directly used without further layers on top (MOD and S3M format) or are referenced by [[Manual: Instruments|instruments]], where their playback can be altered through a variety of envelopes and other effects (all other formats).

In the S3M and MPTM formats, a sample slot can also hold the patch data for an [[#OPL instrument display|FM-synthesized OPL instrument]].

A number of sample properties can be controlled on this tab, such as default volume and panning, loop and sustain points as well as auto vibrato. All options are explained in detail here.

== Toolbar ==

=== File Toolbar ===

[[Image:Sample File Toolbar.png]]

* '''New Sample''': Creates a new sample. In instrument mode, you are asked if the new sample should be assigned with a new instrument. <kbd>Shift</kbd>-clicking this button or choosing the dropdown menu duplicates the current sample. In the S3M and MPTM format, the dropdown menu can also be used to initialize the current sample slot with an [[#OPL instrument display|FM-synthesized instrument]].
* '''Load Sample''': Loads one or more sample in one of the following formats. To enforce loading as a Raw sample, choose “Import Raw Sample” from the dropdown menu.
** Amiga IFF (8SVX / 16SVX / MAUD)
** AIFF / AIFF-C with uncompressed PCM, floating-point, µ-Law and A-Law (AIF / AIFF)
** Sun Audio with uncompressed PCM, floating-point, µ-Law and A-Law (AU / SND)
** SNES Bit Rate Reduction (BRR)
** Apple CAF: Uncompressed PCM (CAF)
** FLAC, OggFlac (FLAC in Ogg Container)
** Impulse Tracker samples (ITS)
** MPEG-1 Audio (MP1 / MP2 / MP3)
** Opus (OPUS)
** Ogg Vorbis (OGG, OGA)
** Gravis UltraSound patches (PAT)
** Headerless PCM data (RAW, PCM)
** Scream Tracker 3 samples and OPL instruments (S3I)
** OPL2 instruments (SBI)
** Sony Wave64: Uncompressed PCM (W64)
** WAV: Uncompressed PCM (up to 32 bits), floating-point (32 / 64 bits), IMA ADPCM, µ-Law and A-Law.
** Fasttracker 2 instruments (XI)
** '''Media Foundation''': OpenMPT makes use of the Media Foundation framework and can load any sample supported by the system. This includes AAC and MP4 audio, compressed WAV files, WMA, audio streams from video files and other formats.
** Trying to load any module as a sample will open it in the [[Manual: Tree View#Instrument Library|Instrument Library]] instead, from where you can drag and drop samples into the sample editor.
* '''Save Sample''': Saves an instrument either in the WAV, FLAC, IFF, S3I or RAW format. Hold <kbd>Shift</kbd> while clicking the button to mass-export all samples at once. In the save dialog, you can then use the variables <code>%sample_number%</code>, <code>%sample_filename%</code> and <code>%sample_name%</code>.

Loading a sample file in an unrecognized sample format, or when using the “Import Raw Sample” option opens the [[Manual: Raw Sample Import|Raw Sample Import]] dialog, where the imported sample format can be specified.

Next to the toolbar buttons are a spin button for dialling up a different sample, a drop-down box for changing the zoom level and sample format information.

=== Edit Toolbar ===

[[Image:Sample Edit Toolbar.png]]

The sample format block is followed by another toolbar that mostly contains tools for editing samples:

* '''Preview Sample''': Plays the current sample at middle-C. Clicking the button again stops the sample.
* '''Normalize''': Amplifies the sample (or a selection of it) as much as possible without distortion. Samples should be normalized before being converted to 8-Bit for optimal usage of the dynamic range. <kbd>Shift</kbd>-clicking this button normalizes all samples independently.
* '''Amplify''': Opens the [[Manual: Amplify|Amplify dialog]], where the sample (or a selection of it) can be faded in or out and amplified by an arbitrary amount.
* '''Remove DC Offset''': Normalizes and shifts the waveform so that it is centered around the center (DC) line. Any DC bias on samples should be removed for optimal headroom usage. <kbd>Shift</kbd>-clicking this button removes DC Offset from all samples.
* '''Change Stereo Separation''': Allows to widen or reduce a stereo sample’s stereo width, or to swap stereo channels by entering a negative separation amount (-100%: swaps channels, no change in stereo width).
* '''Resample''': Opens the [[Manual: Resample|Resample dialog]] which can be used to change the sample’s playback frequency. <kbd>Shift</kbd>-clicking this button resamples all samples.
* '''Reverse''': Reverses the sample or parts of it.
* '''Silence''': Silences a sample selection.
* '''Invert Phase''': Inverts the sample’s or sample selection’s phase.
* '''Sign / Unsign''': Applies a theoretical conversion between signed and unsigned PCM data to the sample or a selection. Usually this would be used for fixing imported RAW samples with mixed up signed / unsigned import options, but it can also produce nifty-sounding distorted samples.
* '''Crossfade''': Opens the [[Manual: Sample Crossfader|Sample Crossfader dialog]], which applies a crossfade between the sample loop start and loop end for seamless sample loops.
* '''Tune sample''': Opens the [[Manual: Sample Tuner|Sample Tuner dialog]], where a sample can be tuned to a given note.

== External Samples ==

In the MPTM format, you may keep references to external samples instead of directly storing them in the module file. This can help reducing disk space taken up by your modules, especially if you want to keep several work-in-progress versions of your song or when using [[Manual:_Setup/Paths / Auto_Save|auto save]]. However, keep in mind that editing these external sample files will also change any module referencing them.

You can enable this feature by checking the '''Keep Sample Data on Disk''' box. This is only available if OpenMPT knows the sample’s location on disk, e.g. after you loaded this sample from or saved the sample to disk during the current editing session. <kbd>Shift</kbd>-clicking the box will enable or disable it for all samples where it is applicable. OpenMPT will only load the external sample’s waveform from disk; any other parameters such as loop points, vibrato and panning settings are stored in the module itself.

The [[Manual:_Tree_View#Song_Folders|Tree View]] offers further facilities for external sample management: There, you can right-click any sample and set its external path (this will also reload the sample from that location), save any changes you made to the sample to the external file and reload the sample from disk in case you edited it in an external application. You can also reload edited samples that way even when not using the external samples functionality.

== Volume, Panning and Pitch ==

* '''Default Volume''': The note velocity that is applied if no volume command is found next to a note. It can be overridden by placing a volume command (vxx in the volume column, or Cxx in the effect column in the MOD format) next to the note. Enabling '''Show default volume commands''' in the [[Manual: Setup/General|General settings]] displays the default volume next to a note if there are no regular volume commands.
* '''Global Volume''': The overall attenuation of the sample. At a global volume of 64, no attenuation is done, at 32 the sample is half as loud, etc.
* '''Set Pan''': Sets the default panning of the sample, which can be overridden by pattern panning commands. If enabled, sample panning overrides the default [[Manual: General#Channel Setup|channel panning]] and [[Manual: Instruments#Volume and Panning|instrument panning]]. In the XM format, every sample is forced to have a default panning, so there is no channel panning or instrument panning.

In the S3M, IT and MPTM format, you can directly define the playback frequency of the Middle-C:

* '''Frequency''': Defines the playback frequency of C-5.
* '''Transpose''': Shows to which note the C-5 frequency is relative to. It can be used to quickly tune the sample to a different note. When changing the transpose value, the frequency is updated instantly.

In the MOD and XM format, you get different options:

* '''Finetune''': Specifies a slight variation (up to a few hundred Hz) from the '''Transpose''' note. Units are 1/8 semitone in MOD format, and are 1/128 semitone in XM format.
* '''Transpose''': Shows to which note the C-5 frequency is relative to. In the MOD format, this value is locked to C-5, i.e. the Middle-C frequency cannot be changed coarsely, only fine-tuning is possible. Higher notes in this drop-down box represent a higher Middle-C frequency, i.e. C#5 means that it is transposed up by a semitone.

== Sample Loops ==

Depending on the module format used, samples can have “normal” and sustain loops. Every loop has a '''Start''' and '''End''' point, and there are several loop types available:

* '''Off''': The loop is not activated.
* '''On''': The loop is repeated from the start to the end.
* '''Bidi''': The loop is played bi-directionally, i.e. it is first played from start to end, then reversed from end to start.

Sustain loops are played as long as no Note Off event is encountered. They are always considered before normal loops, so if the sustain loop is placed beyond the normal loop, the normal loop is ignored at first. As soon as the sustain loop is exited (by means of a Note Off event), playback is resumed in the normal loop.

By default, pressing the spin buttons next to the loop start and end points tries to move the loop point in a way that avoids „clicks“ in the loop. If no such point is found, the loop point will not change. Holding <kbd>Shift</kbd> while pressing the spin buttons changes this behaviour to always increment or decrement the loop point by 1.

Holding <kbd>Ctrl</kbd> while pressing the spin buttons next to the loop start and end points moves both points at the same time, so the loop length remains the same.

Note that sample loops have a peculiar behaviour if the [[Manual: Compatible Playback#MOD compatibility settings|ProTracker one-shot loops]] compatibility setting is enabled in the MOD format: If the loop start is set to 0, the ''complete'' sample is played first, after which it restarts and only the loop part is repeated. Since many MOD players do not support this ProTracker quirk, it is recommended to always trim samples (so that there is no more sample data after the loop end) or not start the sample loop at 0.

== Auto Vibrato ==

OpenMPT’s sample player has an internal oscillator which can be applied to pitch, creating an automatic vibrato effect.
Depending on the format, each sample (IT / MPTM) or instrument (XM) can have its own Auto Vibrato settings.
In the XM format, all samples that are assigned to the same instrument will share the same vibrato settings.

Auto Vibrato can be combined with vibrato effects in the pattern editor — they both function independently.
The Auto Vibrato settings cannot be changed in the patterns, though, so the only way to change the Auto Vibrato amount for a sample is to duplicate it.

The Auto Vibrato is defined by the four following attributes:
* '''Vibrato Waveform''': In this field, you can select the oscillator waveform, i.e. the waveform that is used to modulate the sample pitch.
* '''Vibrato Depth''': Defines how “deep” the vibrato is, in 1⁄64ths of a semitone. The higher the value is, the more the sample pitch is changed.
* '''Vibrato Sweep''': Defines how fast the vibrato reaches the full oscillation depth. The behaviour of this setting is inverse in the XM and IT track formats:
** IT: Full vibrato depth is reached after fading in for <code>(depth × 256 / sweep)</code> ticks, so the higher the value, the quicker the vibrato fades in. 0 means no vibrato at all, 255 means that the full depth is reached after approximately “depth” ticks.
** XM: Full vibrato depth is reached after fading in for “sweep” ticks, so the higher the value, the slower the vibrato fades in.
* '''Vibrato Rate''': The rate (or speed) at which the vibrato will be played. One oscillator cycle has <code>256 / rate</code> ticks, so a higher value implies a faster vibrato effect.

== Pitch Shifting and Time Stretching ==

Pitch Shifting and Time Stretching can be used to alter a sample’s pitch without affecting playback speed and to change a sample’s length without altering its pitch. By default,

* '''Pitch''': The amount of semitones the sample should be shifted upwards or downwards. Custom amounts can be entered, including fractional numbers.
* '''Stretch''': How much the sample is stretched. Values below 100% increase the speed, values above 100% decrease it.
* '''Lo-Fi Mode''': By default, OpenMPT uses a high-quality pitch shift and time stretch algorithm. When checking lo-fi mode, a lower-quality algorithm similar to that found in old hardware samplers is used instead. This mode splits the sample into many equally-sized grains and cross-fades between them.
* '''Grain Size''': In lo-fi mode, this allows to change the size of individual grains. Smaller values avoid the impression of repeating transient sounds, but also sound more metallic. Larger values sound less metallic, but repetitions between individual grains become more obvious. The optimal grain size differs from sample to sample.
* '''Ratio Calculator''': Clicking this buttom opens the [[Manual: Time Stretch Calculator|Time Stretch Calculator dialog]], where you can calculate the correct time stretch ratio for a given tempo and pattern setup.
* '''Process''': Applies the chosen settings to the current sample.

== Sample Display ==

=== Sample Display Toolbar ===

[[Image:Sample Display Toolbar.png]]
* '''Zoom In''' / '''Zoom Out''': Increases or decreases sample zoom. You can also press <kbd>Ctrl</kbd> while scrolling the Mouse Wheel to achieve the same effect.
* '''Toggle Draw Mode''': Enables or disables sample drawing which can be used to fix small mistakes in the sample waveform or to create chip samples. Hold down <kbd>Shift</kbd> while drawing to draw horizontal lines.
* '''Resize Sample''': Changes the length of the sample by either adding silence at the start or end or by resizing it to a given length. This can also be used to create new samples for chip samples if there is no sample yet, or to initialize the sample slot with an [[#OPL instrument display|FM-synthesized instrument]] in the S3M and MPTM format.
* '''Sample Grid Size''': Enables a sample grid which restricts sample selections to equal-sized sample portions. Set the sample grid size to 0 to disable the sample grid again.

=== Sample Display ===

Below the toolbar, the actual sample is displayed. By dragging the mouse, a sample selection can be made. Once a selection has been made, it can be finetuned by dragging its start and end points. <kbd>Shift</kbd>-clicking a point can be used to draw a sample selection from a previously clicked point to that point. <kbd>Ctrl</kbd>-clicking a point plays the sample from that position at the Middle-C frequency. If the sample has any cue points set, they can (by default) be previewed using <kbd>Shift</kbd>+<kbd>1</kbd> through <kbd>Shift</kbd>+<kbd>9</kbd>.

Above the sample display is a timeline which can be used for orientation. The timeline shows various arrows (yellow arrows for cue points, green arrows for regular sample loop points and cyan arrows for sustain loop points) which can be dragged using the mouse. Holding <kbd>Shift</kbd> while dragging allows to place the item more accurately. Holding <kbd>Ctrl</kbd> while dragging loop points moves the other loop point as well, so the loop length remains the same. Right-click the timeline to change the unit used for display or insert a new cue point (if any unused cue points are available). Right-clicking a cue point allows you to delete that cue point. Double-clicking a timeline item opens a dialog where a new position for this item can be typed in.

In the status bar, some information about the sampling point below the mouse cursor and (if existing) the current sample selection:

* If no selection is made, the focussed sampling point is displayed and its position is translated into an Offset [[Manual: Effect Reference|pattern effect]].
* If a selection is made, the selection’s start and end point and the selection length (both in samples and in seconds, based on the Middle-C frequency, as well as in beats based on the current tempo) are displayed in addition to the current position of the mouse cursor in the sample.

Right-clicking the sample waveform opens the context menu.

=== Sample Display Context Menu ===

The sample display’s context menu contents differ depending on whether or not there is a selected block of data.

[[Image: Sample Context Menu.png|thumb|360px|Default sample context menu]]
[[Image: Sample Selection Context Menu.png|thumb|270px|Sample selection context menu]]

* '''Zoom''': Zooms into the current sample selection.
* '''Set as Loop''': When a selection is made, this sets the start and end points of the Sample Loop to that of the selection block.
* '''Set Loop Start''': Uses the selected sample point as the start of the Sample Loop.
* '''Set Loop End''': Uses the selected sample point as the end of the Sample Loop.
* '''Convert to Unidirectional Loop''': Only shown when the sample loop is currently a bidi loop, this converts the loop to a normal loop by inserting a reversed copy of the sample data at the loop end.
* '''Convert to Sustain Loop''': Turns the Sample Loop into a Sustain Loop. If both loops are enabled, their start point, end point and type are swapped.
* '''Set as Sustain Loop''': When a selection is made, this sets the start and end points of the Sustain Loop to that of the selection block.
* '''Set Sustain Start''': Uses the selected point as the start of the Sustain Loop.
* '''Set Sustain End''': Uses the selected sample point as the end of the Sustain Loop.
* '''Convert to Unidirectional Sustain Loop''': Only shown when the sustain loop is currently a bidi loop, this converts the loop to a normal loop by inserting a reversed copy of the sample data at the sustain loop end.
* '''Convert to Normal Loop''': Turns the Sustain Loop into a Sample Loop. If both loops are enabled, their start point, end point and type are swapped.
* '''Set Sample Cue To''': Sets one of the sample cues for the MPTM format’s [[Manual:_Effect_Reference#Volume_Column_4|'''o''' volume column command]] to the selected sample point.
* '''Slice at cue points''': The cue points found in the sub menu of the previous menu entry are used as splitting positions to create several smaller samples.
* '''Slice at grid''': If the [[#Sample Display Toolbar|sample grid]] has been enabled, this menu item is available to split the sample into several smaller samples at the grid lines.
* '''Convert to 8-Bit''': The sample’s bit depth is reduced to 8-Bit, reducing its sound quality in exchange for a smaller sample size.
* '''Convert to 16-Bit''': The sample’s bit depth is increased to 16-Bit. This should only be done if you want to further manipulate the sample (e.g. resample or time-stretch), as the conversion process itself will not improve sample quality.
* '''Convert to Mono''': Offers the following options to convert a stereo sample into a mono sample:
** '''Mix Channels''': Mixes the left and right channels of a stereo sample equally together.
** '''Only Left''': Only keeps the left channel of a stereo sample.
** '''Only Right''': Only keeps the right channel of a stereo sample.
** '''Split Sample''': Create two sample slots for this sample, one containing only the left channel and the other containing just the right channel. If the sample is referenced by an [[Manual: Instruments|instrument]], this is instrument is duplicated as well for the right channel.
* '''Trim''': Deletes all sample data outside of the selected region.
* '''Trim around Loop Points''': Deletes all sample data outside of the sample loop. This is only available if no selection has been made.
* '''Quick Fade''': If the selection includes the beginning of the waveform, this applies a fade-in from the first sample point to the last one in the selected region. If the selected region includes the end of the waveform, then a fade-out from the first sample point of the selection to the last one is applied.
* '''Cut''': Performs a Copy command, then removes the selected sample data.
* '''Copy''': Copies the selected part of the sample (or the whole sample if there is no selection) to the clipboard. You can then paste this sample data into another sample slot; some third-party applications (including some sample editors) can also make use of this clipboard data.
* '''Paste (Replace)''': Replaces the entire sample with the sample data in the clipboard.
* '''Paste (Insert)''': Inserts the sample data in the clipboard into the existing sample. If a selection is made, the selection is replaced by the inserted sample. Otherwise, the sample is inserted at the selected position.
* '''Mix Paste''': Mixes an existing source sample with the sample data in the clipboard.
* '''Undo''': Reverts to the previous waveform data (before the last edit).
* '''Redo''': Reapplies the last undone action.

== OPL instrument display ==

[[Image:OPL Instrument Editor.png|thumb|300px|OPL Instrument Editor]]

In the S3M and MPTM format, it is possible to use simple FM (Frequency Modulation) instruments in addition to samples. This is achieved with a built-in emulator of the [https://en.wikipedia.org/wiki/Yamaha_YMF262 Yamaha YMF262] (also known as OPL3) chip. It offers a limited subset of the features of the well-known Yamaha DX7 synthesizer. In OpenMPT you can use:

* Two operators per voice, either in parallel (additive synthesis) or serially (frequency modulation).
* 8 different waveforms per operator
* Up to 18 simultaneous voices
* Limited panning (left, center and right)

=== Operation Modes ===

OpenMPT supports both additive and frequency modulation synthesis operation modes:

<gallery mode="packed">
File:OPL 2-OP Additive.png|Additive Synthesis
File:OPL 2-OP FM.png|FM Synthesis
</gallery>

In '''additive mode''', both operators function independently and are simply added together. They behave identically, except for the additional possibility to use modulation feedback on the second operator (named “Modulator” in the editor).

In '''FM synthesis mode''', the output from the first operator (Modulator) is sent to the input of the second operator (Carrier) and is used to modulate the frequency of the second operator. In other words, the waveform that is output by the Modulator applies a (very fast) pitch envelope for the Carrier. The Modulator can be understood as an equivalent to the filter in an analog synthesizer — the louder the Modulator, the more open the filter is.

=== Operator Structure ===

Each operator consists of an <abbr title="Attack Decay Sustain Release">ADSR</abbr> volume envelope, several frequency-related settings and a waveform. In FM synthesis mode, the volume of the Modulator is to be understood as the modulation depth — the higher the volume, the more it affects the pitch of the Carrier.

==== Volume ====

* '''Attack Rate''': Specifies how fast the volume envelope fades in from silence to peak volume.
* '''Decay Rate''': Specifies how fast the volume envelope reaches the sustain volume after peaking.
* '''Sustain Level''': Specifies at which level the volume envelope is held before it is released.
* '''Release Rate''': Specifies how fast the volume envelope fades out from the sustain level.
* '''Sustain Sound''': If enabled, the volume envelope stays at the sustain stage and does not enter the release stage of the envelope until a note-off event is encountered. Otherwise, it directly advances from the decay stage to the release stage without waiting for a note-off event.
* '''Volume''': The overall volume of the operator.
* '''Tremolo''': If enabled, adds a tremolo effect with a depth of 1dB.

Pattern volume commands scale the operators’s volume envelope. In additive mode, volume commands affect the volume of both operators. In FM synthesis mode, volume commands only affect the volume of the Carrier, while filter cutoff commands (using instrument filter envelopes or [[Manual: Zxx Macros#Resonant Filter Control|MIDI Macros]]) affect the volume of the Modulator.

In contrast to samples, the volume of the OPL emulator is logarithmic. Reducing the volume by 8 units halves it, so e.g. a <code>v50</code> volume command is half as loud as a <code>v58</code> volume command.

==== Pitch ====

* '''Scale Envelope With Keys''': If enabled, the envelopes of higher notes are played more quickly than those of lower notes.
* '''Key Scale Level''': Attenuates the output level of the operators towards higher pitch by the given amount (disabled, 1.5 dB / octave, 3 dB / octave, 6 dB / octave).
* '''Frequency Multiplier''': Multiplies the frequency of the operator with a value between 0.5 (pitched one octave down) and 15.
* '''Vibrato''': If enabled, adds a vibrato effect with a depth of 7 cents.

==== Waveforms ====

Each operator can use one of the following waveforms:

<gallery mode="packed">
File:OPL-3 Waveform 0.png|Sine
File:OPL-3 Waveform 1.png|Half Sine
File:OPL-3 Waveform 2.png|Absolute Sine
File:OPL-3 Waveform 3.png|Pulse Sine
File:OPL-3 Waveform 4.png|Sine (Even Periods)
File:OPL-3 Waveform 5.png|Absolute Sine (Even Periods)
File:OPL-3 Waveform 6.png|Square
File:OPL-3 Waveform 7.png|Derived Square
</gallery>

Only the first four waveforms (Sine, Half Sine, Absolute Sine and Pulse Sine) are supported by the OPL2 chip, so the remaining four waveforms are not available in S3M modules.

==== Feedback ====

The output of the Modulator can be fed back into itself, creating rich sounds ranging from metallic to noise.

[[Category:Manual|Sample Tab]]
[[Category:Tabs|Sample Tab]]
[[de:Handbuch: Samples]]

Manual: Samples

2025-09-17T20:53:09Z

Saga Musix: /* Sample Display Context Menu */

[[Image:Sample Tab.png|thumb|300px|Sample Tab]]

On the sample tab, you find all the tools needed to load, edit and create new samples or OPL instruments. Samples, besides synthesizer plugins, are the main sound source in OpenMPT. Depending on the module format used, they are directly used without further layers on top (MOD and S3M format) or are referenced by [[Manual: Instruments|instruments]], where their playback can be altered through a variety of envelopes and other effects (all other formats).

In the S3M and MPTM formats, a sample slot can also hold the patch data for an [[#OPL instrument display|FM-synthesized OPL instrument]].

A number of sample properties can be controlled on this tab, such as default volume and panning, loop and sustain points as well as auto vibrato. All options are explained in detail here.

== Toolbar ==

=== File Toolbar ===

[[Image:Sample File Toolbar.png]]

* '''New Sample''': Creates a new sample. In instrument mode, you are asked if the new sample should be assigned with a new instrument. <kbd>Shift</kbd>-clicking this button or choosing the dropdown menu duplicates the current sample. In the S3M and MPTM format, the dropdown menu can also be used to initialize the current sample slot with an [[#OPL instrument display|FM-synthesized instrument]].
* '''Load Sample''': Loads one or more sample in one of the following formats. To enforce loading as a Raw sample, choose “Import Raw Sample” from the dropdown menu.
** Amiga IFF (8SVX / 16SVX / MAUD)
** AIFF / AIFF-C with uncompressed PCM, floating-point, µ-Law and A-Law (AIF / AIFF)
** Sun Audio with uncompressed PCM, floating-point, µ-Law and A-Law (AU / SND)
** SNES Bit Rate Reduction (BRR)
** Apple CAF: Uncompressed PCM (CAF)
** FLAC, OggFlac (FLAC in Ogg Container)
** Impulse Tracker samples (ITS)
** MPEG-1 Audio (MP1 / MP2 / MP3)
** Opus (OPUS)
** Ogg Vorbis (OGG, OGA)
** Gravis UltraSound patches (PAT)
** Headerless PCM data (RAW, PCM)
** Scream Tracker 3 samples and OPL instruments (S3I)
** OPL2 instruments (SBI)
** Sony Wave64: Uncompressed PCM (W64)
** WAV: Uncompressed PCM (up to 32 bits), floating-point (32 / 64 bits), IMA ADPCM, µ-Law and A-Law.
** Fasttracker 2 instruments (XI)
** '''Media Foundation''': OpenMPT makes use of the Media Foundation framework and can load any sample supported by the system. This includes AAC and MP4 audio, compressed WAV files, WMA, audio streams from video files and other formats.
** Trying to load any module as a sample will open it in the [[Manual: Tree View#Instrument Library|Instrument Library]] instead, from where you can drag and drop samples into the sample editor.
* '''Save Sample''': Saves an instrument either in the WAV, FLAC, IFF, S3I or RAW format. Hold <kbd>Shift</kbd> while clicking the button to mass-export all samples at once. In the save dialog, you can then use the variables <code>%sample_number%</code>, <code>%sample_filename%</code> and <code>%sample_name%</code>.

Loading a sample file in an unrecognized sample format, or when using the “Import Raw Sample” option opens the [[Manual: Raw Sample Import|Raw Sample Import]] dialog, where the imported sample format can be specified.

Next to the toolbar buttons are a spin button for dialling up a different sample, a drop-down box for changing the zoom level and sample format information.

=== Edit Toolbar ===

[[Image:Sample Edit Toolbar.png]]

The sample format block is followed by another toolbar that mostly contains tools for editing samples:

* '''Preview Sample''': Plays the current sample at middle-C. Clicking the button again stops the sample.
* '''Normalize''': Amplifies the sample (or a selection of it) as much as possible without distortion. Samples should be normalized before being converted to 8-Bit for optimal usage of the dynamic range. <kbd>Shift</kbd>-clicking this button normalizes all samples independently.
* '''Amplify''': Opens the [[Manual: Amplify|Amplify dialog]], where the sample (or a selection of it) can be faded in or out and amplified by an arbitrary amount.
* '''Remove DC Offset''': Normalizes and shifts the waveform so that it is centered around the center (DC) line. Any DC bias on samples should be removed for optimal headroom usage. <kbd>Shift</kbd>-clicking this button removes DC Offset from all samples.
* '''Change Stereo Separation''': Allows to widen or reduce a stereo sample’s stereo width, or to swap stereo channels by entering a negative separation amount (-100%: swaps channels, no change in stereo width).
* '''Resample''': Opens the [[Manual: Resample|Resample dialog]] which can be used to change the sample’s playback frequency. <kbd>Shift</kbd>-clicking this button resamples all samples.
* '''Reverse''': Reverses the sample or parts of it.
* '''Silence''': Silences a sample selection.
* '''Invert Phase''': Inverts the sample’s or sample selection’s phase.
* '''Sign / Unsign''': Applies a theoretical conversion between signed and unsigned PCM data to the sample or a selection. Usually this would be used for fixing imported RAW samples with mixed up signed / unsigned import options, but it can also produce nifty-sounding distorted samples.
* '''Crossfade''': Opens the [[Manual: Sample Crossfader|Sample Crossfader dialog]], which applies a crossfade between the sample loop start and loop end for seamless sample loops.
* '''Tune sample''': Opens the [[Manual: Sample Tuner|Sample Tuner dialog]], where a sample can be tuned to a given note.

== External Samples ==

In the MPTM format, you may keep references to external samples instead of directly storing them in the module file. This can help reducing disk space taken up by your modules, especially if you want to keep several work-in-progress versions of your song or when using [[Manual:_Setup/Paths / Auto_Save|auto save]]. However, keep in mind that editing these external sample files will also change any module referencing them.

You can enable this feature by checking the '''Keep Sample Data on Disk''' box. This is only available if OpenMPT knows the sample’s location on disk, e.g. after you loaded this sample from or saved the sample to disk during the current editing session. <kbd>Shift</kbd>-clicking the box will enable or disable it for all samples where it is applicable. OpenMPT will only load the external sample’s waveform from disk; any other parameters such as loop points, vibrato and panning settings are stored in the module itself.

The [[Manual:_Tree_View#Song_Folders|Tree View]] offers further facilities for external sample management: There, you can right-click any sample and set its external path (this will also reload the sample from that location), save any changes you made to the sample to the external file and reload the sample from disk in case you edited it in an external application. You can also reload edited samples that way even when not using the external samples functionality.

== Volume, Panning and Pitch ==

* '''Default Volume''': The note velocity that is applied if no volume command is found next to a note. It can be overridden by placing a volume command (vxx in the volume column, or Cxx in the effect column in the MOD format) next to the note. Enabling '''Show default volume commands''' in the [[Manual: Setup/General|General settings]] displays the default volume next to a note if there are no regular volume commands.
* '''Global Volume''': The overall attenuation of the sample. At a global volume of 64, no attenuation is done, at 32 the sample is half as loud, etc.
* '''Set Pan''': Sets the default panning of the sample, which can be overridden by pattern panning commands. If enabled, sample panning overrides the default [[Manual: General#Channel Setup|channel panning]] and [[Manual: Instruments#Volume and Panning|instrument panning]]. In the XM format, every sample is forced to have a default panning, so there is no channel panning or instrument panning.

In the S3M, IT and MPTM format, you can directly define the playback frequency of the Middle-C:

* '''Frequency''': Defines the playback frequency of C-5.
* '''Transpose''': Shows to which note the C-5 frequency is relative to. It can be used to quickly tune the sample to a different note. When changing the transpose value, the frequency is updated instantly.

In the MOD and XM format, you get different options:

* '''Finetune''': Specifies a slight variation (up to a few hundred Hz) from the '''Transpose''' note. Units are 1/8 semitone in MOD format, and are 1/128 semitone in XM format.
* '''Transpose''': Shows to which note the C-5 frequency is relative to. In the MOD format, this value is locked to C-5, i.e. the Middle-C frequency cannot be changed coarsely, only fine-tuning is possible. Higher notes in this drop-down box represent a higher Middle-C frequency, i.e. C#5 means that it is transposed up by a semitone.

== Sample Loops ==

Depending on the module format used, samples can have “normal” and sustain loops. Every loop has a '''Start''' and '''End''' point, and there are several loop types available:

* '''Off''': The loop is not activated.
* '''On''': The loop is repeated from the start to the end.
* '''Bidi''': The loop is played bi-directionally, i.e. it is first played from start to end, then reversed from end to start.

Sustain loops are played as long as no Note Off event is encountered. They are always considered before normal loops, so if the sustain loop is placed beyond the normal loop, the normal loop is ignored at first. As soon as the sustain loop is exited (by means of a Note Off event), playback is resumed in the normal loop.

Holding <kbd>Ctrl</kbd> while pressing the spin buttons next to the loop start and end points moves both points at the same time, so the loop length remains the same.

Note that sample loops have a peculiar behaviour if the [[Manual: Compatible Playback#MOD compatibility settings|ProTracker one-shot loops]] compatibility setting is enabled in the MOD format: If the loop start is set to 0, the ''complete'' sample is played first, after which it restarts and only the loop part is repeated. Since many MOD players do not support this ProTracker quirk, it is recommended to always trim samples (so that there is no more sample data after the loop end) or not start the sample loop at 0.

== Auto Vibrato ==

OpenMPT’s sample player has an internal oscillator which can be applied to pitch, creating an automatic vibrato effect.
Depending on the format, each sample (IT / MPTM) or instrument (XM) can have its own Auto Vibrato settings.
In the XM format, all samples that are assigned to the same instrument will share the same vibrato settings.

Auto Vibrato can be combined with vibrato effects in the pattern editor — they both function independently.
The Auto Vibrato settings cannot be changed in the patterns, though, so the only way to change the Auto Vibrato amount for a sample is to duplicate it.

The Auto Vibrato is defined by the four following attributes:
* '''Vibrato Waveform''': In this field, you can select the oscillator waveform, i.e. the waveform that is used to modulate the sample pitch.
* '''Vibrato Depth''': Defines how “deep” the vibrato is, in 1⁄64ths of a semitone. The higher the value is, the more the sample pitch is changed.
* '''Vibrato Sweep''': Defines how fast the vibrato reaches the full oscillation depth. The behaviour of this setting is inverse in the XM and IT track formats:
** IT: Full vibrato depth is reached after fading in for <code>(depth × 256 / sweep)</code> ticks, so the higher the value, the quicker the vibrato fades in. 0 means no vibrato at all, 255 means that the full depth is reached after approximately “depth” ticks.
** XM: Full vibrato depth is reached after fading in for “sweep” ticks, so the higher the value, the slower the vibrato fades in.
* '''Vibrato Rate''': The rate (or speed) at which the vibrato will be played. One oscillator cycle has <code>256 / rate</code> ticks, so a higher value implies a faster vibrato effect.

== Pitch Shifting and Time Stretching ==

Pitch Shifting and Time Stretching can be used to alter a sample’s pitch without affecting playback speed and to change a sample’s length without altering its pitch. By default,

* '''Pitch''': The amount of semitones the sample should be shifted upwards or downwards. Custom amounts can be entered, including fractional numbers.
* '''Stretch''': How much the sample is stretched. Values below 100% increase the speed, values above 100% decrease it.
* '''Lo-Fi Mode''': By default, OpenMPT uses a high-quality pitch shift and time stretch algorithm. When checking lo-fi mode, a lower-quality algorithm similar to that found in old hardware samplers is used instead. This mode splits the sample into many equally-sized grains and cross-fades between them.
* '''Grain Size''': In lo-fi mode, this allows to change the size of individual grains. Smaller values avoid the impression of repeating transient sounds, but also sound more metallic. Larger values sound less metallic, but repetitions between individual grains become more obvious. The optimal grain size differs from sample to sample.
* '''Ratio Calculator''': Clicking this buttom opens the [[Manual: Time Stretch Calculator|Time Stretch Calculator dialog]], where you can calculate the correct time stretch ratio for a given tempo and pattern setup.
* '''Process''': Applies the chosen settings to the current sample.

== Sample Display ==

=== Sample Display Toolbar ===

[[Image:Sample Display Toolbar.png]]
* '''Zoom In''' / '''Zoom Out''': Increases or decreases sample zoom. You can also press <kbd>Ctrl</kbd> while scrolling the Mouse Wheel to achieve the same effect.
* '''Toggle Draw Mode''': Enables or disables sample drawing which can be used to fix small mistakes in the sample waveform or to create chip samples. Hold down <kbd>Shift</kbd> while drawing to draw horizontal lines.
* '''Resize Sample''': Changes the length of the sample by either adding silence at the start or end or by resizing it to a given length. This can also be used to create new samples for chip samples if there is no sample yet, or to initialize the sample slot with an [[#OPL instrument display|FM-synthesized instrument]] in the S3M and MPTM format.
* '''Sample Grid Size''': Enables a sample grid which restricts sample selections to equal-sized sample portions. Set the sample grid size to 0 to disable the sample grid again.

=== Sample Display ===

Below the toolbar, the actual sample is displayed. By dragging the mouse, a sample selection can be made. Once a selection has been made, it can be finetuned by dragging its start and end points. <kbd>Shift</kbd>-clicking a point can be used to draw a sample selection from a previously clicked point to that point. <kbd>Ctrl</kbd>-clicking a point plays the sample from that position at the Middle-C frequency. If the sample has any cue points set, they can (by default) be previewed using <kbd>Shift</kbd>+<kbd>1</kbd> through <kbd>Shift</kbd>+<kbd>9</kbd>.

Above the sample display is a timeline which can be used for orientation. The timeline shows various arrows (yellow arrows for cue points, green arrows for regular sample loop points and cyan arrows for sustain loop points) which can be dragged using the mouse. Holding <kbd>Shift</kbd> while dragging allows to place the item more accurately. Holding <kbd>Ctrl</kbd> while dragging loop points moves the other loop point as well, so the loop length remains the same. Right-click the timeline to change the unit used for display or insert a new cue point (if any unused cue points are available). Right-clicking a cue point allows you to delete that cue point. Double-clicking a timeline item opens a dialog where a new position for this item can be typed in.

In the status bar, some information about the sampling point below the mouse cursor and (if existing) the current sample selection:

* If no selection is made, the focussed sampling point is displayed and its position is translated into an Offset [[Manual: Effect Reference|pattern effect]].
* If a selection is made, the selection’s start and end point and the selection length (both in samples and in seconds, based on the Middle-C frequency, as well as in beats based on the current tempo) are displayed in addition to the current position of the mouse cursor in the sample.

Right-clicking the sample waveform opens the context menu.

=== Sample Display Context Menu ===

The sample display’s context menu contents differ depending on whether or not there is a selected block of data.

[[Image: Sample Context Menu.png|thumb|360px|Default sample context menu]]
[[Image: Sample Selection Context Menu.png|thumb|270px|Sample selection context menu]]

* '''Zoom''': Zooms into the current sample selection.
* '''Set as Loop''': When a selection is made, this sets the start and end points of the Sample Loop to that of the selection block.
* '''Set Loop Start''': Uses the selected sample point as the start of the Sample Loop.
* '''Set Loop End''': Uses the selected sample point as the end of the Sample Loop.
* '''Convert to Unidirectional Loop''': Only shown when the sample loop is currently a bidi loop, this converts the loop to a normal loop by inserting a reversed copy of the sample data at the loop end.
* '''Convert to Sustain Loop''': Turns the Sample Loop into a Sustain Loop. If both loops are enabled, their start point, end point and type are swapped.
* '''Set as Sustain Loop''': When a selection is made, this sets the start and end points of the Sustain Loop to that of the selection block.
* '''Set Sustain Start''': Uses the selected point as the start of the Sustain Loop.
* '''Set Sustain End''': Uses the selected sample point as the end of the Sustain Loop.
* '''Convert to Unidirectional Sustain Loop''': Only shown when the sustain loop is currently a bidi loop, this converts the loop to a normal loop by inserting a reversed copy of the sample data at the sustain loop end.
* '''Convert to Normal Loop''': Turns the Sustain Loop into a Sample Loop. If both loops are enabled, their start point, end point and type are swapped.
* '''Set Sample Cue To''': Sets one of the sample cues for the MPTM format’s [[Manual:_Effect_Reference#Volume_Column_4|'''o''' volume column command]] to the selected sample point.
* '''Slice at cue points''': The cue points found in the sub menu of the previous menu entry are used as splitting positions to create several smaller samples.
* '''Slice at grid''': If the [[#Sample Display Toolbar|sample grid]] has been enabled, this menu item is available to split the sample into several smaller samples at the grid lines.
* '''Convert to 8-Bit''': The sample’s bit depth is reduced to 8-Bit, reducing its sound quality in exchange for a smaller sample size.
* '''Convert to 16-Bit''': The sample’s bit depth is increased to 16-Bit. This should only be done if you want to further manipulate the sample (e.g. resample or time-stretch), as the conversion process itself will not improve sample quality.
* '''Convert to Mono''': Offers the following options to convert a stereo sample into a mono sample:
** '''Mix Channels''': Mixes the left and right channels of a stereo sample equally together.
** '''Only Left''': Only keeps the left channel of a stereo sample.
** '''Only Right''': Only keeps the right channel of a stereo sample.
** '''Split Sample''': Create two sample slots for this sample, one containing only the left channel and the other containing just the right channel. If the sample is referenced by an [[Manual: Instruments|instrument]], this is instrument is duplicated as well for the right channel.
* '''Trim''': Deletes all sample data outside of the selected region.
* '''Trim around Loop Points''': Deletes all sample data outside of the sample loop. This is only available if no selection has been made.
* '''Quick Fade''': If the selection includes the beginning of the waveform, this applies a fade-in from the first sample point to the last one in the selected region. If the selected region includes the end of the waveform, then a fade-out from the first sample point of the selection to the last one is applied.
* '''Cut''': Performs a Copy command, then removes the selected sample data.
* '''Copy''': Copies the selected part of the sample (or the whole sample if there is no selection) to the clipboard. You can then paste this sample data into another sample slot; some third-party applications (including some sample editors) can also make use of this clipboard data.
* '''Paste (Replace)''': Replaces the entire sample with the sample data in the clipboard.
* '''Paste (Insert)''': Inserts the sample data in the clipboard into the existing sample. If a selection is made, the selection is replaced by the inserted sample. Otherwise, the sample is inserted at the selected position.
* '''Mix Paste''': Mixes an existing source sample with the sample data in the clipboard.
* '''Undo''': Reverts to the previous waveform data (before the last edit).
* '''Redo''': Reapplies the last undone action.

== OPL instrument display ==

[[Image:OPL Instrument Editor.png|thumb|300px|OPL Instrument Editor]]

In the S3M and MPTM format, it is possible to use simple FM (Frequency Modulation) instruments in addition to samples. This is achieved with a built-in emulator of the [https://en.wikipedia.org/wiki/Yamaha_YMF262 Yamaha YMF262] (also known as OPL3) chip. It offers a limited subset of the features of the well-known Yamaha DX7 synthesizer. In OpenMPT you can use:

* Two operators per voice, either in parallel (additive synthesis) or serially (frequency modulation).
* 8 different waveforms per operator
* Up to 18 simultaneous voices
* Limited panning (left, center and right)

=== Operation Modes ===

OpenMPT supports both additive and frequency modulation synthesis operation modes:

<gallery mode="packed">
File:OPL 2-OP Additive.png|Additive Synthesis
File:OPL 2-OP FM.png|FM Synthesis
</gallery>

In '''additive mode''', both operators function independently and are simply added together. They behave identically, except for the additional possibility to use modulation feedback on the second operator (named “Modulator” in the editor).

In '''FM synthesis mode''', the output from the first operator (Modulator) is sent to the input of the second operator (Carrier) and is used to modulate the frequency of the second operator. In other words, the waveform that is output by the Modulator applies a (very fast) pitch envelope for the Carrier. The Modulator can be understood as an equivalent to the filter in an analog synthesizer — the louder the Modulator, the more open the filter is.

=== Operator Structure ===

Each operator consists of an <abbr title="Attack Decay Sustain Release">ADSR</abbr> volume envelope, several frequency-related settings and a waveform. In FM synthesis mode, the volume of the Modulator is to be understood as the modulation depth — the higher the volume, the more it affects the pitch of the Carrier.

==== Volume ====

* '''Attack Rate''': Specifies how fast the volume envelope fades in from silence to peak volume.
* '''Decay Rate''': Specifies how fast the volume envelope reaches the sustain volume after peaking.
* '''Sustain Level''': Specifies at which level the volume envelope is held before it is released.
* '''Release Rate''': Specifies how fast the volume envelope fades out from the sustain level.
* '''Sustain Sound''': If enabled, the volume envelope stays at the sustain stage and does not enter the release stage of the envelope until a note-off event is encountered. Otherwise, it directly advances from the decay stage to the release stage without waiting for a note-off event.
* '''Volume''': The overall volume of the operator.
* '''Tremolo''': If enabled, adds a tremolo effect with a depth of 1dB.

Pattern volume commands scale the operators’s volume envelope. In additive mode, volume commands affect the volume of both operators. In FM synthesis mode, volume commands only affect the volume of the Carrier, while filter cutoff commands (using instrument filter envelopes or [[Manual: Zxx Macros#Resonant Filter Control|MIDI Macros]]) affect the volume of the Modulator.

In contrast to samples, the volume of the OPL emulator is logarithmic. Reducing the volume by 8 units halves it, so e.g. a <code>v50</code> volume command is half as loud as a <code>v58</code> volume command.

==== Pitch ====

* '''Scale Envelope With Keys''': If enabled, the envelopes of higher notes are played more quickly than those of lower notes.
* '''Key Scale Level''': Attenuates the output level of the operators towards higher pitch by the given amount (disabled, 1.5 dB / octave, 3 dB / octave, 6 dB / octave).
* '''Frequency Multiplier''': Multiplies the frequency of the operator with a value between 0.5 (pitched one octave down) and 15.
* '''Vibrato''': If enabled, adds a vibrato effect with a depth of 7 cents.

==== Waveforms ====

Each operator can use one of the following waveforms:

<gallery mode="packed">
File:OPL-3 Waveform 0.png|Sine
File:OPL-3 Waveform 1.png|Half Sine
File:OPL-3 Waveform 2.png|Absolute Sine
File:OPL-3 Waveform 3.png|Pulse Sine
File:OPL-3 Waveform 4.png|Sine (Even Periods)
File:OPL-3 Waveform 5.png|Absolute Sine (Even Periods)
File:OPL-3 Waveform 6.png|Square
File:OPL-3 Waveform 7.png|Derived Square
</gallery>

Only the first four waveforms (Sine, Half Sine, Absolute Sine and Pulse Sine) are supported by the OPL2 chip, so the remaining four waveforms are not available in S3M modules.

==== Feedback ====

The output of the Modulator can be fed back into itself, creating rich sounds ranging from metallic to noise.

[[Category:Manual|Sample Tab]]
[[Category:Tabs|Sample Tab]]
[[de:Handbuch: Samples]]

Manual: Keyboard Actions

2025-09-17T13:14:33Z

Saga Musix: Slice at Grid

This is a list of all customisable keyboard actions in OpenMPT. They can be configured in the [[Manual: Setup/Keyboard|Keyboard Setup dialog]].

Default key combinations listed in the tables below assume a US keyboard layout. Generally, alphanumeric keys in shortcuts will stay the same in other keyboard layouts (so <kbd>Ctrl</kbd>+<kbd>Z</kbd> does not turn into <kbd>Ctrl</kbd>+<kbd>Y</kbd> on a German layout), with the exception of note entry keys, which are set up based on their position on the keyboard instead (so on a French keyboard, <kbd>A</kbd>, <kbd>Q</kbd> and <kbd>W</kbd> are used for playing a C across three octaves even though the table below says <kbd>Q</kbd>, <kbd>A</kbd> and <kbd>Z</kbd>). Non-alphanumeric keys generally vary a lot between keyboard layouts, so there might not be a direct mapping to your keyboard layout — the key might have a completely different label or not exist at all. You can always review the ''actual'' key combinations used by OpenMPT on your setup by reviewing them in the Keyboard setup dialog.

'''Note''': Keyboard shortcuts that clash with the default text editing shortcuts of the operating system (e.g. <kbd>Ctrl</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>+<kbd>Z</kbd>, etc.) are ignored when the input focus is within a text field.

== Global Keys ==

Global keyboard shortcuts work on most parts of OpenMPT as long as one of the program’s windows is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| File/New || <kbd>Ctrl</kbd>+<kbd>N</kbd> || Creates a new song. The currently edited song is not closed, as OpenMPT can have multiple documents open at the same time.
|-
| File/Open || <kbd>Ctrl</kbd>+<kbd>O</kbd> || Opens one or more existing songs.
|-
| File/Append Module || || [[Manual: Module Merging|Appends]] (merges) the song data (samples, instruments, plugins, patterns and sequences) of one or more existing songs to the currently active song.
|-
| File/Close || <kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes the current song. You are prompted to save the song if it has been modified.
|-
| File/Close All || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes all open songs. You are prompted to save modified songs.
|-
| File/Save || <kbd>Ctrl</kbd>+<kbd>S</kbd> || Saves the song to disk.
|-
| File/Save As || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>S</kbd> || Allows you to save the file with a new name or in another folder.
|-
| File/Save Copy || || Allows you to save a copy of the file. The next Save action will update the file at its original location again.
|-
| File/Save As Template || || Creates a template from the current song.
|-
| File/Open Template || || Opens a file picker in the template module folder.
|-
| File/Stream Export || || Exports the current track into a lossless or lossy [[Manual: Saving and exporting#Stream Export|streaming file]].
|-
| File/Export as MIDI || || Exports the current track into the .mid format. See the section on [[Manual: Saving and exporting#MIDI Export|MIDI export]] for a detailed explanation of how this file is exported.
|-
| File/Export OPL Register Dump || || Exports the current track into one of several OPL register dump formats. See the section on [[Manual: Saving and exporting#OPL Export|OPL export]] for a detailed explanation of how this file is exported.
|-
| File/Compatibility Export || || Exports the current track without any [[Manual: Saving and exporting#Compatibility Export|file format hacks]] to its original format.
|-
| File/Import MIDI Library || || Imports the MIDI Instrument Library of your choosing. The MIDI Library can be accessed from the [[Manual: Tree View#MIDI Library|Tree View]].
|-
| File/Add Sound Bank || || Imports a sound bank of your choosing. Sound banks can be accessed from the [[Manual: Tree View#Sound Banks|Tree View]].
|-
| Previous Document || || Goes to the previous module file that is open (these are visible in the Windows Menu).
|-
| Next Document || || Goes to the next module file that is open (these are visible in the Windows Menu).
|-
| Play Song / Pause Song || <kbd>F5</kbd> || Toggles the playback of the current track. The playback cursor is not reset when using this toggle; that is, it plays from where the cursor left off when it was last pressed.
|-
| Play Song / Stop Song || || Toggles the playback of the current track. The playback cursor is reset to the start of the song.
|-
| Pause Song || <kbd>F8</kbd> || Only stops the playback of the current track but does not reset the playback pointer.
|-
| Stop Song || <kbd>Escape</kbd> || Stops the playback of the current track and resets the playback cursor to the start of the song.
|-
| Play Song from Start || <kbd>F6</kbd> || Resets the playback cursor to the very first row and begins playback from there.
|-
| Play Song from Cursor / Pause || || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there if playback is currently stopped, otherwise it pauses playback. Playback will continue until the end of the track.
|-
| Play Song from Cursor || <kbd>Ctrl</kbd>+<kbd>F6</kbd> || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there. Playback will continue until the end of the track.
|-
| Play Song from Pattern Start / Pause || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there if playback is currently stopped, otherwise it pauses playback.
|-
| Play Song from Pattern Start || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there.
|-
| Play Pattern from Start || <kbd>F7</kbd> || Loops the current pattern, starting at the first row of the pattern.
|-
| Play Pattern from Cursor || <kbd>Ctrl</kbd>+<kbd>F7</kbd> || Loops the current pattern, starting at the row where the editing cursor is currently placed.
|-
| Toggle Loop Song || || Enables or disables the song loop status.
|-
| Panic || || Stops all sample, OPL and plugin instrument voices.
|-
| Estimate Song Length || || Estimates the playback length of the entire track.
|-
| Show Approx. Real BPM || || Estimates the beats per minute of the song, based on the current tempo and the number of ticks per row, plus the Tempo Mode in the Song Properties dialog.
|-
| Toggle MIDI Record || <kbd>F9</kbd> || Toggles the MIDI Record option.
|-
| Increase Tempo || || Increases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo || || Decreases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Tempo (Fine) || || Increases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo (Fine) || || Decreases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Ticks per Row || || Increases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Decrease Ticks per Row || || Decreases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Undo || <kbd>Ctrl</kbd>+<kbd>Z</kbd> || Rescinds the last edit in the pattern or sample editor.
|-
| Redo || <kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd> || Reapplies the last undone action.
|-
| Cut || <kbd>Ctrl</kbd>+<kbd>X</kbd> || Copies the selected pattern, sample or instrument data into the clipboard, then removes it from the selection it occupies.
|-
| Copy || <kbd>Ctrl</kbd>+<kbd>C</kbd> || Copies the selected pattern, sample or instrument data into the clipboard.
|-
| Paste || <kbd>Ctrl</kbd>+<kbd>V</kbd>, <kbd>Shift</kbd>+<kbd>Insert</kbd> || Pastes data from the clipboard. In the pattern editor, it is pasted at the location of the cursor, overwriting any pattern data that falls within the paste area. With sample data, clipboard contents replace the '''whole''' sample.
|-
| Mix Paste || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>V</kbd> || Mixes clipboard contents with existing data. In the pattern editor, clipboard contents are pasted in the same row at the same column of the current (visible) pattern where the cursor is located, except where there is already any data in any corresponding field of the paste area. In the sample editor, the source and clipboard sample waveforms are mixed together.
|-
| Mix Paste (IT Style) || || For detailed differences between Mix Paste and Mix Paste (IT Style), consult the [[Manual: Patterns#Paste Modes|Pattern Editor help]]. The two commands are identical when used in the sample editor.
|-
| Paste Flood || <kbd>Shift</kbd>+<kbd>V</kbd> || Clipboard contents are pasted from the cursor, repeating the data paste until every row in the pattern has been filled and pasting over any data in its path.
|-
| Push Forward Paste (Insert) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>V</kbd> || Patterns: Clipboard contents are inserted at the row of the cursor, and pushing all data below that row further down the pattern. Any data of the affected channels pushed beyond the pattern’s last row is deleted. Samples: The sample data from the clipboard replaces the current selection. If there is no selection, the sample is inserted at the last selected position.
|-
| Select All || <kbd>Ctrl</kbd>+<kbd>5</kbd> || Selects all pattern or sample data.
|-
| Find / Replace || <kbd>Ctrl</kbd>+<kbd>F</kbd> || Opens the Find/Replace dialog, which allows you to search for and/or replace given pattern data. Find starts from the cursor location.
|-
| Find Next || <kbd>F3</kbd> || Applies the current Find settings and searches for the next data that matches it, starting from the current cursor location.
|-
| View General || <kbd>Alt</kbd>+<kbd>G</kbd> || Opens the [[Manual: General|General Tab]] of the currently focussed module.
|-
| View Pattern || <kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Patterns|Pattern Tab]].
|-
| View Samples || <kbd>Alt</kbd>+<kbd>S</kbd> || Opens the [[Manual: Samples|Sample Tab]].
|-
| View Instruments || <kbd>Alt</kbd>+<kbd>N</kbd> || Opens the [[Manual: Instruments|Instrument Tab]].
|-
| View Comments || <kbd>Alt</kbd>+<kbd>C</kbd>, <kbd>Shift</kbd>+<kbd>F9</kbd> || Opens the [[Manual: Comments|Comments Tab]].
|-
| Toggle Main Toolbar || || Shows / hides the [[Manual: Main Toolbar|Main Toolbar]].
|-
| Toggle Tree View || <kbd>Ctrl</kbd>+<kbd>F2</kbd> || Shows / hides the [[Manual: Tree View|Tree View]].
|-
| View Options || <kbd>Ctrl</kbd>+<kbd>F1</kbd> || Opens the [[Manual: Setup|Setup dialog]].
|-
| View Channel Manager || || Opens the [[Manual: Channel Manager|Channel Manager]].
|-
| View Plugin Manager || || Opens the [[Manual: Plugin Manager|Plugin Manager dialog]].
|-
| View Song Properties || || Opens the [[Manual: Song Properties|Song Properties dialog]].
|-
| View Global Tempo Swing Settings || || Opens the [[Manual: Tempo Swing Settings|Tempo Swing Settings dialog]] for the song’s global time signature. If modern tempo mode is not enabled yet, the [[Manual: Song Properties|Song Properties dialog]] is opened instead so that it can be enabled.
|-
| View Zxx Macro Configuration || || Opens the [[Manual: Macro Configuration|MIDI Macro Configuration]] dialog.
|-
| View MIDI Mapping || <kbd>Ctrl</kbd>+<kbd>F3</kbd> || Opens the [[Manual: MIDI Mapping|MIDI Mapping dialog]].
|-
| View Edit History || || Opens the [[Manual: Edit History|Edit History]].
|-
| Toggle Between Upper / Lower View || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd> || Switches keyboard focus between the upper and lower half of the currently focussed song view.
|-
| Switch to Instrument Library || <kbd>Alt</kbd>+<kbd>I</kbd> || Sets keyboard focus to the [[Manual: Tree View|Instrument Library]], or switches back to the last used editor window if the tree view already has focus.
|-
| Help || <kbd>F1</kbd> || Opens the manual.
|-
| Open Context Menu || <kbd>▤ Application</kbd>, <kbd>Shift</kbd>+<kbd>F10</kbd> || Opens the context menu for the currently selected item.
|-
| Previous Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad/</kbd>, <kbd>Ctrl</kbd>+<kbd>Up</kbd> || Changes the current instrument to the previous one. In the sample editor, the previous sample is chosen.
|-
| Next Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad*</kbd>, <kbd>Ctrl</kbd>+<kbd>Down</kbd> || Changes the current instrument to the next one. In the sample editor, the next sample is chosen.
|-
| Previous Octave || <kbd>Numpad/</kbd> || Changes the current octave to the next lower octave.
|-
| Next Octave || <kbd>Numpad*</kbd> || Changes the current octave to the next higher octave.
|-
| Previous Order || <kbd>Ctrl</kbd>+<kbd>Left</kbd> || Changes the current pattern to the previous one in the pattern order.
|-
| Next Order || <kbd>Ctrl</kbd>+<kbd>Right</kbd> || Changes the current pattern to the next one in the pattern order.
|-
| Previous Order (Transition at end of current measure) || || Changes the current pattern to the previous one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current measure) || || Changes the current pattern to the next one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current beat) || || Changes the current pattern to the previous one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current beat) || || Changes the current pattern to the next one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current row) || || Changes the current pattern to the previous one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current row) || || Changes the current pattern to the next one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Dummy Shortcut || || Some keyboard shortcuts are created automatically by OpenMPT (e.g. the combinations of pressing the selection key together with navigation keys). If you need to prevent OpenMPT from automatically assigning a specific key combination, you can assign it to this dummy shortcut instead, so it will not be usable by automatically generated shortcuts. This will also prevent the key combination from being used by new default key combinations added by future OpenMPT updates.
|-
|}

== Pattern ==

=== Order List ===

These keyboard shortcuts operate while the cursor focus is in the Order List.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Delete Order || <kbd>Delete</kbd> || Erases the currently selected pattern(s) in the Order List (the pattern itself is not removed, only the reference).
|-
| Insert Order || <kbd>Insert</kbd> || Duplicates the currently selected pattern ''reference''(s) in the Order List.
|-
| Insert Separator || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Inserts a separator item (+++) at the next position.
|-
| Copy Orders || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Copies the currently selected pattern ''references'' in the Order List to the clipboard.
|-
| Edit Pattern || <kbd>Enter</kbd> || Resets the Pattern Editor to show the highlighted pattern.
|-
| Switch to Pattern Editor || <kbd>Tab</kbd> || Moves the cursor focus to the Pattern Editor. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Previous Order || <kbd>Left</kbd>, <kbd>Up</kbd> || Selects the previous pattern in the Order List.
|-
| Next Order || <kbd>Right</kbd>, <kbd>Down</kbd> || Selects the following pattern in the Order List.
|-
| First Order || <kbd>Home</kbd> || Selects the first pattern in the Order List.
|-
| Last Order || <kbd>End</kbd> || Selects the final pattern in the Order List.
|-
| Pattern Index Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the respective numeral into the pattern ID box.
|-
| Increase Pattern Index || <kbd>=</kbd>, <kbd>Numpad+</kbd> || Adds one to the pattern number, up to the highest indexed pattern.
|-
| Decrease Pattern Index || <kbd>-</kbd>, <kbd>Numpad-</kbd> || Subtracts one from the pattern number, to a minimum of index 0.
|-
| Separator Index || <kbd>I</kbd> || Adds a separator pattern item (+++) at the current position.
|-
| Stop Index || <kbd>Space</kbd> || Adds a stop pattern item (---) at the current position.
|-
| Lock Playback to Selection || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Song playback is locked to the patterns in the current order selection.
|-
| Unlock Playback || <kbd>Ctrl</kbd>+<kbd>U</kbd> || If playback has been limited to an order selection before, the playback lock can be removed here.
|-
| Queue Pattern (Transition at end of current pattern) || <kbd>Q</kbd> || The selected order list item is queued to be played next, after the current pattern has finished playing.
|-
| Queue Pattern (Transition at end of current measure) || <kbd>Shift</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current measure has finished playing.
|-
| Queue Pattern (Transition at end of current beat) || <kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current beat has finished playing.
|-
| Queue Pattern (Transition at end of current row) || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current row has finished playing.
|-
| Stream Export || || Opens the [[Manual: Saving and exporting#Stream Export|Wave Export dialog]] for the selected patterns.
|-
|}

=== Quick Channel Settings ===

These keyboard shortcuts operate while the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] is open.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Channel || <kbd>Alt</kbd>+<kbd>Left</kbd>, <kbd>Shift</kbd>+<kbd>Backspace</kbd> || Shows the channel settings for the previous channel.
|-
| Next Channel || <kbd>Alt</kbd>+<kbd>Right</kbd>, <kbd>Shift</kbd>+<kbd>Enter</kbd> || Shows the channel settings for the next channel.
|-
| Pick Color from Previous Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Left</kbd> || Assigns the color of the previous channel to the current channel.
|-
| Pick Color from Next Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Right</kbd> || Assigns the color of the next channel to the current channel.
|-
| Switch to Pattern Editor || <kbd>Enter</kbd> || Closes the dialog and returns to the Pattern Editor.
|-
|}

=== General Context ===

These keyboard shortcuts will work if the cursor focus is within any of the columns of the Pattern Editor, except where noted. When navigating (moving the cursor) to before the first row or after the last row in the pattern, the cursor “wraps” to the other side of the same pattern, if the “Cursor Wrap” option is enabled (in the Options section of the [[Manual: Setup/General|General tab]] of the Setup dialog). If navigating beyond the first or last row when the “Continuous Scroll” option is enabled, the cursor will instead move to the previous/next pattern in the order list.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Navigate Down by 1 Row || <kbd>Down</kbd> || Moves the cursor to the next row in the same column.
|-
| Navigate Up by 1 Row || <kbd>Up</kbd> || Moves the cursor to the previous row in the same column.
|-
| Navigate Down by Spacing || <kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor down by the value in the Row Spacing field.
|-
| Navigate Up by Spacing || <kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor up by the value in the Row Spacing field.
|-
| Navigate Left || <kbd>Left</kbd> || Moves the cursor to the previous column in the same row, going to the previous channel′s last column if moving from the first column of the current channel.
|-
| Navigate Right || <kbd>Right</kbd> || Moves the cursor to the next column in the same row, going to the next channel’s first column if moving from the last column of the current channel.
|-
| Navigate to Next Channel || <kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the next channel.
|-
| Navigate to Previous Channel || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the previous channel.
|-
| Jump Down by Measure || <kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Up by Measure || <kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Down by Beat || <kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump Up by Beat || <kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Measure || || Moves the cursor down to the first row of the next measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Up to Measure || || Moves the cursor up to the first row of the previous measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down to the first row of the next beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Snap Up to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up to the first row of the previous beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump to Previous Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column above the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the previous patterns.
|-
| Jump to Next Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column below the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the next patterns.
|-
| Go to First Channel || <kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the same row.
|-
| Go to First Row || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Moves the cursor to the first row of the same channel in the same column.
|-
| Go to First Row of First Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the first row.
|-
| Go to Last Channel || <kbd>End</kbd> || Moves the cursor to the last column of the last channel in the same row.
|-
| Go to Last Row || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Moves the cursor to the last row of the same channel in the same column.
|-
| Go to Last Row of Last Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>End</kbd> || Moves the cursor to the last column of the last channel in the last row.
|-
| Go to note column || || Moves the cursor to the note column of the current pattern cell.
|-
| Go to instrument column || || Moves the cursor to the instrument column of the current pattern cell.
|-
| Go to volume effect column || || Moves the cursor to the volume effect column of the current pattern cell.
|-
| Go to effect comamnd column || || Moves the cursor to the effect command column of the current pattern cell.
|-
| Go to effect parameter column || || Moves the cursor to the effect parameter column of the current pattern cell.
|-
| Previous Pattern || <kbd>Numpad-</kbd> || Displays the previous pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Next Pattern || <kbd>Numpad+</kbd> || Displays the next pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Previous Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>-</kbd> || Cycles to the previous sequence. If the current sequence is the first, the last sequence is selected.
|-
| Next Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>+</kbd> || Cycles to the next sequence. If the current sequence is the last, the first sequence is selected.
|-
| Scroll Left || || Scrolls the pattern editor to the left without changing the cursor position.
|-
| Scroll Right || || Scrolls the pattern editor to the right without changing the cursor position.
|-
| Scroll Up || || Scrolls the pattern editor up without changing the cursor position.
|-
| Scroll Down || || Scrolls the pattern editor down without changing the cursor position.
|-
| Selection Key || <kbd>Shift</kbd> || The modifier key to be used to extend the selection when navigating with keyboard shortcuts.
|-
| Copy Select Key || <kbd>Ctrl</kbd> || The modifier key to be used to copy the selection when dragging with the mouse.
|-
| Select Channel / Select All || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Selects all events of the channel where the cursor is located in the current pattern, or all events in the pattern if the entire channel is already selected.
|-
| Select Column || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Selects the column in which the cursor is located in all rows of the current pattern.
|-
| Select Row || || Completely selects all rows covered by the current selection.
|-
| Select Event || || Completely selects all events covered by the current selection.
|-
| Select Beat || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a beat and ends on the last row of a beat.
|-
| Select Measure || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a measure and ends on the last row of a measure.
|-
| Lose Selection || || Resets the selection rectangle to contain only the cursor position.
|-
| Copy and Lose Selection || || Copies the selected events to the clipboard and unselects them.
|-
| Quick Copy || <kbd>Enter</kbd> || Copies only one event of data (where the cursor is located) to OpenMPT′s “Quick” clipboard; the standard clipboard is not erased. Each column pair has its own Quick clipboard.
|-
| Quick Paste || <kbd>Space</kbd> || Pastes the data in OpenMPT′s “Quick” clipboard to the location of the cursor. The data last saved in that column’s clipboard will be pasted in the cursor′s corresponding column.
|-
| Cut to Pattern Channel Clipboard || || Copies and clears the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Cut to Pattern Clipboard || || Copies and clears the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Copy to Pattern Channel Clipboard || || Copies the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Copy to Pattern Clipboard || || Copies the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Paste from Pattern Channel Clipboard || || Replaces the contents of the channel the cursor is located in with the contents of the pattern channel clipboard.
|-
| Paste from Pattern Clipboard || || Replaces the contents of the current pattern with the contents of the pattern clipboard.
|-
| Toggle Clipboard Manager || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Toggles the visibility of the pattern clipboard manager.
|-
| Cycle to Previous Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Left</kbd> || Makes the previous internal clipboard the current clipboard.
|-
| Cycle to Next Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Right</kbd> || Makes the next internal clipboard the current clipboard.
|-
| Clear Row || || Deletes all event data in the same row in the current channel.
|-
| Clear Field || <kbd>Delete</kbd> || Deletes the selected pattern data, or just the data under the current cursor position if no selection has been made.
|-
| Clear Field (IT Style) || <kbd>Shift</kbd>+<kbd>.</kbd> || Same as “Clear field”, but also clears the instrument number if a note event is selected.
|-
| Clear Row and Step || <kbd>Ctrl</kbd>+<kbd>Delete</kbd> || Same as “Clear row”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step || || Same as “Clear field”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step (IT Style) || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Clear field (IT Style)”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Delete Row(s) || <kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; the data is moved up to replace the cleared data, and empty rows are added at the end of the affected channels.
|-
| Delete Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; the data is moved up to replace the cleared data, and empty rows are added at the end of the pattern.
|-
| Delete Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; this also affect all following patterns as no empty rows are inserted.
|-
| Delete Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; this also affect all following patterns as no empty rows are inserted.
|-
| Insert Row(s) || <kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last row of those channels is deleted.
|-
| Insert Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last row of all channels is deleted.
|-
| Insert Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Insert Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Mute Current Channel || <kbd>F10</kbd> || Toggles the sound output (mute) for the channel(s) covered by the current selection.
|-
| Solo Current Channel || <kbd>Ctrl</kbd>+<kbd>F10</kbd> || Toggles the sound output (mute) for all channels except the channel(s) covered by the current selection.
|-
| Unmute All Channels || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F10</kbd> || Unmutes the sound output for all channels.
|-
| (Un)mute Channel on Pattern Transition || || Toggles the sound output (mute) for the channel(s) covered by the current selection, but the change takes place when the current pattern is finished playing.
|-
| Unmute All Channels on Pattern Transition || || Unmutes the sound output for all channels when the current pattern is finished playing.
|-
| Solo Channel on Pattern Transition || || Toggles the sound output (mute) for all channels except the one where the cursor is located, but the change takes place when the current pattern is finished playing.
|-
| Channel Record Select || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Toggles the channel(s) covered by the current selection to belong to the primary record group.
|-
| Channel Split Record Select || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Toggles the channel(s) covered by the current selection to belong to the [[Manual: Keyboard Split|split record]] group.
|-
| Reset Channel || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Stops all note processing, and resets all channel variables to their defaults (volume, panning, etc.) on the selected channel(s).
|-
| Transpose Channel || || Changes the pitch of all notes on the selected channel in all patterns by a selectable amount of semitones.
|-
| Duplicate Channel || || Adds a new channel to the module and carries over all note data from the channel containing the edit cursor to this new channel.
|-
| Add Channel Before Current || || Adds a new empty channel before the channel containing the edit cursor.
|-
| Add Channel After Current || || Adds a new empty channel after the channel containing the edit cursor.
|-
| Remove Current || || Removes the channel containing the edit cursor. If the channel contains any data on any pattern, a confirmation prompt is shown.
|-
| Move Channels to Left || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the left by one channel.
|-
| Move Channels to Right || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the right by one channel.
|-
| Quick Channel Settings || || Opens the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] for the channel where the cursor is located.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the note number of the currently selected notes.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the note number of the currently selected notes.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the octave number of the currently selected notes.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the octave number of the currently selected notes.
|-
| Transpose Custom || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Lowers or raises the selected notes by an arbitrary amount of semitones.
|-
| Transpose Custom (Quick) || || Applies a previously chosen custom transpose amount. If no amount has been chosen before, the behaviour of this shortcut is identical to Transpose Custom.
|-
| Data Entry +1 || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry -1 || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry Up (Coarse) || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Data Entry Down (Coarse) || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Insert New Pattern || || Inserts a new blank pattern after the current pattern, displays it, and moves the cursor to the same position in it. Also functions when cursor focus is in the Order list.
|-
| Duplicate Pattern || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Inserts a new pattern with the current pattern′s contents.
|-
| Split Pattern || || Splits the current pattern at the cursor location.
|-
| Amplify Selection || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens a dialog to change the note volume commands of the selected volume data.
|-
| Interpolate Note || || Transitions smoothly (using all available notes) between notes in the selection, filling in (and replacing if necessary) all rows with new note data.
|-
| Interpolate Instrument || || Transitions smoothly (using all available instrument numbers) between instrument numbers in the selection, filling in all rows with new instrument data.
|-
| Interpolate Volume || <kbd>Ctrl</kbd>+<kbd>J</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new volume effects. The first and last rows of the selection must contain the same volume effect, or one of the two rows might be empty.
|-
| Interpolate Effect || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new effect data. The first and last rows of the selection must contain the same effect, or one of the two rows might be empty. Different effects within the selection are not overwritten.
|-
| Apply Current Instrument || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Applies the current instrument to all cells in the selection that contain note data.
|-
| Apply Current Instrument to Existing Only || || Applies the current instrument to all cells in the selection that contain an instrument numbers. Notes without instrument numbers are not updated.
|-
| Grow Selection || <kbd>Alt</kbd>+<kbd>E</kbd> || “Expands” the selection by doubling the number of the selected rows, and evenly spacing out the event data within it. The expansion will replace event data below it in the same channels as the selection.
|-
| Shrink Selection || <kbd>Alt</kbd>+<kbd>D</kbd> || “Shrinks” the selection by deleting every other row of the selection. However, if only part of any row is selected, the data corresponding to the deleted selected data is also deleted.
|-
| Expand Pattern || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>E</kbd> || “Expands” the entire pattern by doubling the number of the rows, and evenly spacing out the event data within it.
|-
| Shrink Pattern || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>D</kbd> || “Shrinks” the entire pattern by removing every other row.
|-
| Toggle Follow Song || <kbd>F11</kbd> || Toggles the “Follow Song” function.
|-
| Toggle Loop Pattern || <kbd>Shift</kbd>+<kbd>F11</kbd> || Toggles the Loop Pattern feature.
|-
| Play Row || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Process and play only the events in the current row where the cursor is located.
|-
| Go to Row/Channel/… || <kbd>Ctrl</kbd>+<kbd>G</kbd> || Opens the [[Manual: Go To|Go To]] dialog to allow you to jump to a different position in the module.
|-
| Pick Up Nearest Instrument Number || || Seeks for the nearest instrument number in the pattern channel the cursor currently is in. If an instrument number is found, it is set as the currently active instrument.
|-
| Enable Recording || <kbd>Ctrl</kbd>+<kbd>Space</kbd> || Toggles the Event Record feature. When enabled, patterns may be edited.
|-
| Toggle Metronome || <kbd>Alt</kbd>+<kbd>M</kbd> || Toggles the [[Manual: Metronome Settings|Metronome]].
|-
| Set Edit Step on Note Entry || <kbd>Alt</kbd> || The modifier key(s) that, when pressed with digits 0-9, allows you to change the Edit Step amount without using the mouse or moving the cursor focus out of the editor.
|-
| Increase Edit Step || || Increases the Edit Step by one row.
|-
| Decrease Edit Step || || Decreases the Edit Step by one row.
|-
| Switch to Order List || <kbd>Ctrl</kbd>+<kbd>Tab</kbd> || Toggles the cursor focus between the pattern editor and the current pattern in the Pattern Order list. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Toggle PC Event/Instrument Plugin Editor || <kbd>Ctrl</kbd>+<kbd>/</kbd> || Opens the editor for the plugin of the selected Parameter Control Event or instrument number.
|-
| Toggle Channel’s Plugin Editor || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the editor for the current channel′s assigned plugin.
|-
| Show Note Properties || <kbd>▤ Application</kbd> || Opens the [[Manual: Note Properties|Note Properties]] dialog, where you can assign any event data to the current row of the current channel.
|-
| Show Pattern Properties || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Pattern Properties|Pattern Properties]] dialog.
|-
| Split Keyboard Settings Dialog || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Keyboard Split|Keyboard Split]] dialog.
|-
| Open Effect Visualizer || <kbd>Alt</kbd>+<kbd>B</kbd> || Opens the [[Manual: Parameter Editor|Parameter Editor]] dialog.
|-
| Show Chord Editor || || opens the [[Manual: Chord Editor|Chord Editor]] dialog.
|-
| Show Context (Right-Click) Menu || || Opens the edit context menu at the cursor location without using the mouse.
|-
| Show Channel Context (Right-Click) Menu || || Opens the channel context menu at the cursor location without using the mouse.
|-
| Show Channel Plugin Context (Right-Click) Menu || || Opens the plugin context menu of the channel at the cursor location without using the mouse.
|-
| Show Playback Time at Current Row || <kbd>Ctrl</kbd>+<kbd>P</kbd> || Shows the estimated time within the track at the start of the current row.
|-
| Lock Playback to Rows || || If a selection is made, playback is locked to the selected rows. Otherwise, a previous playback lock is removed.
|-
| Quantize Settings || <kbd>Alt</kbd>+<kbd>Q</kbd> || Opens the record quantization settings.
|-
| Toggle row playback when navigating || || Toggles the state of the "play whole row when navigating" feature. The new state of the feature is announced in the status bar.
|-
| Toggle Overflow Paste || || When enabled, pasting will continue to the next pattern if the data overflows the current pattern.
|-
| Toggle Note Off Record (PC Keyboard) || || Toggles the recording of Note Off events from the PC keyboard in the pattern editor (also configurable from the [[Manual: Setup/General#Record note off|General setup]] page).
|-
| Toggle Note Off Record (MIDI) || || Toggles the recording of Note Off events from MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Apply Octave Transpose to incoming MIDI Notes || || Toggles application of the base octave transposition to notes received via MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Continue Song when MIDI Note is received || || Toggles whether pattern playback continues when a note is received via MIDI (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Respond to Play / Continue / Stop Song MIDI messages || || Toggles whether pattern playback starts / stops / continues when the corresponding MIDI commands are received (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Velocity || || Toggles whether MIDI velocity is recorded (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Pitch Bend || || Toggles whether MIDI pitch bends are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI CCs || || Toggles whether MIDI CC events are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Instrument Column Visibility || || Shows or hides the instrument column.
|-
| Toggle Volume Column Visibility || || Shows or hides the volume column.
|-
| Toggle Effect Column Visibility || || Shows or hides the effect column.
|}

=== Note Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the note column (the first column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Base Octave [note] || <kbd>Q</kbd>, <kbd>W</kbd>, ... || Enters a note in the octave indicated in the Octave field.
|-
| Base Octave +1 [note] || <kbd>A</kbd>, <kbd>S</kbd>, ... || Enters a note in the next higher octave indicated in the Octave field.
|-
| Base Octave +2 [note] || <kbd>Z</kbd>, <kbd>X</kbd>, ... || Enters a note two octaves higher than the one indicated in the Octave field.
|-
| Base Octave +3 [note] || || Enters a note three octaves higher than the one indicated in the Octave field.
|-
| Base Octave +4 [note] || || Enters a note four octaves higher than the one indicated in the Octave field.
|-
| Set Octave [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Sets the selected note’s octave.
|-
| Chord Modifier || <kbd>Shift</kbd> || The modifier key(s) that calls a chord rather than a note. The chords are set and assigned in the [[Manual: Chord Editor|Chord Editor]].
|-
| Note Cut || <kbd>`</kbd> || Enters a Note Cut command (^^). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>1</kbd>.
|-
| Note Off || <kbd>=</kbd> || Enters a Note Off command (==). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>Backspace</kbd>.
|-
| Note Fade || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a Note Fade command (~~). Note: The default shortcut is position-independent and is bound to the key that is usually lef of <kbd>Backspace</kbd>.
|-
| Parameter Control || <kbd>Shift</kbd>+<kbd>-</kbd> || Enters an absolute [[Manual:_Parameter_Control_Events|Parameter Control event]] (PC). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
| Parameter Control (Smooth) || <kbd>-</kbd> || Enters a smooth sliding Parameter Control event (PCs). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
|}

=== Instrument Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the instrument column (the second column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Instrument Digit [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the instrument field, moving the existing digits to the left.
|-
|}

=== Volume Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the volume column (the third column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Volume Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left.
|-
| Set Volume Digit [A - F] || || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left. By default, volume column parameters are shown in decimal and these shortcuts are not assigned. You can use them after enabling the [[Manual: Hidden Settings#.5BPattern Editor.5D|Pattern Editor.VolumeColumnInHex]] hidden setting.
|-
| Volume Command - Volume || <kbd>V</kbd> || Enters a note volume (vxx) command into the pattern.
|-
| Volume Command - Panning || <kbd>P</kbd> || Enters a panning command (pxx) into the pattern.
|-
| Volume Command - Volume Slide Up || <kbd>C</kbd> || Enters volume slide up (cxx) into the pattern.
|-
| Volume Command - Volume Slide Down || <kbd>D</kbd> || Enters a volume slide down (dxx) into the pattern.
|-
| Volume Command - Fine Volume Slide Up || <kbd>A</kbd> || Enters a fine volume slide up (axx) into the pattern.
|-
| Volume Command - Fine Volume Slide Down || <kbd>B</kbd> || Enters a fine volume slide down (bxx) into the pattern.
|-
| Volume Command - Vibrato Speed || <kbd>U</kbd> || Enters a vibrato speed command (uxx) into the pattern.
|-
| Volume Command - Vibrato Depth || <kbd>H</kbd> || Enters a vibrato depth command (hxx) into the pattern.
|-
| Volume Command - XM Pan Slide Left || <kbd>L</kbd> || Enters a pan slide to the left (lxx) into the pattern.
|-
| Volume Command - XM Pan Slide Right || <kbd>R</kbd> || Enters a pan slide to the right (rxx) into the pattern.
|-
| Volume Command - Tone Portamento || <kbd>G</kbd> || Enters a tone portamento command (gxx) into the pattern.
|-
| Volume Command - Portamento Up || <kbd>F</kbd> || Enters a pitch bend up command (fxx) into the pattern.
|-
| Volume Command - Portamento Down || <kbd>E</kbd> || Enters a pitch bend down command (exx) into the pattern.
|-
| Volume Command - Offset || <kbd>O</kbd> || Enters a coarse sample offset command (oxx) into the pattern.
|-
|}

=== Effect Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect column (the fourth column). Alphanumeric effect letters (0-9, A-Z) are currently not editable — they are automatically assigned to the respective keys on your keyboard.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Smooth MIDI Macro Slide || <kbd>\</kbd> || Enters a Smooth MIDI Macro Slide (\xx) into the pattern.
|-
| Combined Note Delay and Note Cut || <kbd>;</kbd>, <kbd>Shift</kbd>+<kbd>;</kbd> || Enters a Delay-Cut (:xy) command into the pattern.
|-
| Parameter Extension Command || <kbd>/</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Parameter Extension Command]] (#xx) into the pattern.
|-
| Finetune || <kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Finetune Command]] (+xx) into the pattern.
|-
| Finetune (Smooth) || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Smooth Finetune Command]] (*xx) into the pattern.
|-
|}

=== Effect Parameter Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect parameter column (the fifth column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Effect Parameter Digit [0 – F] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd>, <kbd>A</kbd>-<kbd>F</kbd> || Enters the digit into the rightmost place in the effect parameter field, moving the existing digits to the left.
|-
|}

== Sample Editor ==

These shortcuts are applied when the [[Manual: Samples|Samples Tab]] is active.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Trim Sample around Loop Points || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Trims the sample to the selection, if there is one. Otherwise, if loop points are specified, all sample data outside of these start/end times are deleted.
|-
| Trim to Loop End || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>T</kbd> || If loop points are specified, all sample data past the loop end is deleted.
|-
| Silence Sample Selection || <kbd>Backspace</kbd> || All of the sample data within the selected area is set to zero, effectively placing silence in that span.
|-
| Normalize Sample || <kbd>Shift</kbd>+<kbd>N</kbd> || Applies Normalisation to the sample.
|-
| Amplify Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens the [[Manual: Amplify|Amplify]] dialog, allowing you to alter the volume of the sample and apply Fade In or Fade Out (from / to silence).
|-
| Reverse Sample || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>R</kbd> || Puts the selected sample data in reverse order, so it is being played backwards.
|-
| Delete Sample Selection || <kbd>Delete</kbd> || Deletes the sample data within the selection, moving the remaining data together.
|-
| Toggle Sample Drawing || || Turns sample drawing mode on or off.
|-
| Add Silence / Create Sample || || Opens the dialog for adding silence, resizing samples and initializing FM instruments.
|-
| Configure Sample Grid || || Opens the dialog for setting the sample grid properties.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the data-to-display ratio, effectively zooming in to show more graphic detail of the sample data.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the data-to-display ratio, effectively zooming out to show less graphic detail of the sample data.
|-
| Zoom into Selection || <kbd>Space</kbd> || Zooms so much into the sample data that the current selection covers as much of the sample display as possible. If no selection has been made, auto-zoom is enabled.
|-
| Zoom into Sample Start || <kbd>1</kbd> || Zooms into the sample and ensures that the sample start is visible in the view.
|-
| Zoom into Sample End || <kbd>2</kbd> || Zooms into the sample and ensures that the sample end is visible in the view.
|-
| Center Loop Start in View || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Ensures that the normal sample loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Loop End in View || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Ensures that the normal sample loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop Start in View || <kbd>Ctrl</kbd>+<kbd>3</kbd> || Ensures that the sample sustain loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop End in View || <kbd>Ctrl</kbd>+<kbd>4</kbd> || Ensures that the sample sustain loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Convert Ping-Pong Loop to Unidirectional || || Turns a bidi-looped sample loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Convert Ping-Pong Sustain Loop to Unidirectional || || Turns a bidi-looped sustain loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Toggle Loop || || Switches the sample loop to the next supported loop type (off, on, bidi).
|-
| Toggle Sustain Loop || || Switches the sustain loop to the next supported loop type (off, on, bidi).
|-
| Convert to 8-bit / 16-bit || <kbd>Ctrl</kbd>+<kbd>8</kbd> || Changes the sample’s bit depth between 8-bit and 16-bit.
|-
| Convert to Mono (Mix) || <kbd>Shift</kbd>+<kbd>M</kbd> || Mixes the left and right channels of a stereo sample equally together.
|-
| Convert to Mono (Left Channel) || <kbd>Shift</kbd>+<kbd>L</kbd> || Only keeps the left channel of a stereo sample.
|-
| Convert to Mono (Right Channel) || <kbd>Shift</kbd>+<kbd>R</kbd> || Only keeps the right channel of a stereo sample.
|-
| Convert to Mono (Split Sample) || <kbd>Shift</kbd>+<kbd>S</kbd> || Create two sample slots for this sample, one containing only the left channel and the other containing just the right channel. If the sample is referenced by an instrument, this instrument is duplicated as well for the right channel.
|-
| Change Stereo Separation || <kbd>Shift</kbd>+<kbd>P</kbd> || Adjusts the stereo separation of the sample by a given amount, either widening or narrowing the stereo width.
|-
| Upsample || <kbd>Shift</kbd>+<kbd>F</kbd>|| Doubles the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Downsample || <kbd>Shift</kbd>+<kbd>G</kbd>|| Halves the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Resample || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Changes the sample’s middle-C frequency to a new arbitrary frequency.
|-
| Invert Sample Phase || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Inverts the sample’s phase, i.e. it is mirrored along the time axis.
|-
| Signed / Unsigned Conversion || <kbd>Ctrl</kbd>+<kbd>U</kbd> || Re-interprets the sample data as a signed or unsigned sample.
|-
| Remove DC Offset || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Removes an unwanted static DC Offset from the waveform, i.e. it is centered around the time axis.
|-
| Quick Fade || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Applies a fade-in for the selected sample data if the selection includes the beginning of the sample, or applies a fade-out if the selection includes the end of the sample. If neither the beginning or end of the waveform is part of the selection, the Amplify dialog is shown.
|-
| Crossfade Sample Loop || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Opens the Crossfade Loop dialog to crossfade the sample loop’s end with the loop start, to create seamless loop transitions.
|-
| Tune Sample to Given Note || || Opens the [[Manual: Sample Tuner|Sample Tuner]] dialog, where the sample can be tuned to a given note.
|-
| Load Sample || <kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. This command also works in the Instrument Tab, importing an instrument to the current Instrument slot.
|-
| Load Raw Sample || <kbd>Shift</kbd>+<kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. The [[Manual: Raw Sample Import|Raw Sample Import]] is shown, ignoring the sample format even if it is known to OpenMPT.
|-
| Save Sample || || Opens the Save File dialog to allow you to save the sample as a Wave Audio or Raw file into a folder of your choice. This command also works in the Instrument Tab, saving the instrument and its accompanying samples as an .iti, .xi or .sfz file.
|-
| New Sample || || Creates a blank sample in the next unused slot. This command also works in the Instrument Tab.
|-
| Duplicate Sample || || Duplicates the current sample slot into the next unused slot.
|-
| Initialize OPL Instrument || || Configures the current sample slot to be a synthesized OPL instrument and recalls the default instrument parameters.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises the middle-C frequency by one semitone.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers the middle-C frequency by one semitone.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises (doubles) the middle-C frequency by one octave.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers (halves) the middle-C frequency by one octave.
|-
| Increment Finetune || <kbd>Shift</kbd>+<kbd>Up</kbd> || Raises the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Decrement Finetune || <kbd>Shift</kbd>+<kbd>Down</kbd> || Lowers the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Toggle Follow Sample Play Cursor|| <kbd>Shift</kbd>+<kbd>F</kbd> || Cycles through all three [[Manual: Setup/Samples#Automatic Scrolling when_Zoomed-In|sample playback cursor follow modes]]. The new follow mode is announced in the status bar.
|-
| Preview / Set Sample Cue [1 - 9] || <kbd>Shift</kbd>+<kbd>1</kbd>-<kbd>9</kbd> || Previews the sample at middle-C, starting from the chosen cue point. If the cue point is unset and the sample is currently being previewed, the cue point is set to the current play position.
|-
| Slice at Cue Points || || Creates new samples from the current sample by splitting the sample at its cue points.
|-
| Slice at Grid || || Creates new samples from the current sample by splitting the sample at the currently configured sample grid.
|-
|}

== Instrument Editor ==

These shortcuts are applied when the [[Manual: Instruments#Sample Map|Sample Map]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Duplicate Instrument || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Creates a new instrument slot using ''all'' the same instrument attributes as the currently displayed instrument.
|-
| Edit Sample Map || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Sample Map|Sample Map]] dialog.
|-
| Edit Current Sample || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the Samples page of the currently selected sample slot.
|-
| Map All Notes to Selected Note || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected note to all notes.
|-
| Map All Notes to Selected Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected sample slot to all notes.
|-
| Reset Note Mapping || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Resets the note assignments, so that each note maps to itself (C-5 → C-5, D-5 → D-5, and so on).
|-
| Remove All Samples || || Removes any sample associations from the instrument.
|-
| Transpose +1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one semitone.
|-
| Transpose -1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one semitone.
|-
| Transpose +1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one octave.
|-
| Transpose -1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one octave.
|-
|}

=== Envelope Editor ===

These shortcuts are applied when the [[Manual: Instruments#Envelope Editor|envelope editor]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Load Envelope || || Replaces the currently active envelope with an envelope from disk.
|-
| Save Envelope || || Stores the currently active envelope to disk.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the detail of the Envelope Window, showing a smaller excerpt of the envelope.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the detail of the Envelope Window, showing a bigger excerpt of the envelope.
|-
| Scale Envelope Points || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Scale Envelope Points|Scale Envelope Points]] dialog.
|-
| Switch to Volume Envelope || <kbd>Shift</kbd>+<kbd>M</kbd> || Selects the Volume Envelope for editing.
|-
| Switch to Panning Envelope || <kbd>Shift</kbd>+<kbd>P</kbd> || Selects the Panning Envelope for editing.
|-
| Switch to Pitch / Filter Envelope || <kbd>Shift</kbd>+<kbd>I</kbd> || Selects the Pitch / Filter Envelope for editing.
|-
| Toggle Volume Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd> || Enables or disables the Volume Envelope.
|-
| Toggle Panning Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> || Enables or disables the Panning Envelope.
|-
| Toggle Pitch Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> || Enables or disables the Pitch Envelope.
|-
| Toggle Filter Envelope || <kbd>Shift</kbd>+<kbd>F</kbd> || Enables or disables the Filter Envelope.
|-
| Toggle Envelope Loop || <kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Loop.
|-
| Select Envelope Loop Start || <kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope loop start.
|-
| Select Envelope Loop End || <kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope loop end.
|-
| Toggle Envelope Sustain Loop || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Sustain Loop.
|-
| Select Envelope Sustain Start || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope sustain start.
|-
| Select Envelope Sustain End || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope sustain end.
|-
| Toggle Envelope Carry || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Enables or disables the Envelope Carry.
|-
| Select Previous Envelope Point || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the selection to the previous envelope point.
|-
| Select Next Envelope Point || <kbd>Tab</kbd> || Moves the selection to the following envelope point.
|-
| Move Envelope Point Left || <kbd>Left</kbd> || Moves the selected envelope point left one tick.
|-
| Move Envelope Point Left (Coarse) || <kbd>Shift</kbd>+<kbd>Left</kbd> || Moves the selected envelope point left one beat.
|-
| Move Envelope Point Right || <kbd>Right</kbd> || Moves the selected envelope point right one tick.
|-
| Move Envelope Point Right (Coarse) || <kbd>Shift</kbd>+<kbd>Right</kbd> || Moves the selected envelope point right one beat.
|-
| Move Envelope Point Up || <kbd>Up</kbd> || Moves the selected envelope point up one unit.
|-
| Move Envelope Point Up (Coarse) || <kbd>PageUp</kbd> || Moves the selected envelope point up 8 units.
|-
| Move Envelope Point Down || <kbd>Down</kbd> || Moves the selected envelope point down one unit.
|-
| Move Envelope Point Down (Coarse) || <kbd>PageDown</kbd> || Moves the selected envelope point down 8 units.
|-
| Insert Envelope Point || <kbd>Insert</kbd> || Inserts an envelope point after the selected point.
|-
| Remove Envelope Point || <kbd>Delete</kbd>, <kbd>Backspace</kbd> || Deletes the selected envelope point.
|-
| Set Loop Start || <kbd>Home</kbd> || Sets the selected envelope point as the Envelope Loop start point.
|-
| Set Loop End || <kbd>End</kbd> || Sets the selected envelope point as the Envelope Loop end point.
|-
| Set Sustain Loop Start || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Sets the selected envelope point as the Sustain Loop start point.
|-
| Set Sustain Loop End || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Sets the selected envelope point as the Sustain Loop end point.
|-
| Toggle Release Node || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the selected envelope point as the start point for the Release Envelope.
|-
|}

== Comments [Bottom] ==

These shortcuts are applied when the lower half of the [[Manual: Comments|Comments tab]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Toggle Between Lists || <kbd>Tab</kbd> || Toggles between the sample and instrument list.
|-
| Open Item in Editor || <kbd>Enter</kbd> || Switches to the sample or instrument editor to edit the currently selected item.
|-
| Rename Item || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Brings up an edit box for renaming the selected sample or instrument.
|-
|}

== Plugin Editor ==

These shortcuts are applied when a [[Manual: Plugin Window|plugin window]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Plugin Preset || <kbd>Numpad-</kbd> || Selects the previous plugin preset / patch.
|-
| Next Plugin Preset || <kbd>Numpad+</kbd> || Selects the following plugin preset / patch.
|-
| Plugin Preset Backward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad-</kbd> || Jumps back 10 entries in the preset list.
|-
| Plugin Preset Forward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad+</kbd> || Jumps forward 10 entries in the preset list.
|-
| Randomize Plugin Parameters || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>D</kbd> || Give random values to all parameters of the current plugin.
|-
| Toggle Parameter Recording || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the parameter recording function, which allows you to record parameter changes from plugin window into the pattern.
|-
| Record MIDI Out to Pattern Editor || || Toggles the MIDI Out recording function, which allows you to route the plugin’s MIDI output to the pattern, sample or instrument editor.
|-
| Pass Key Presses to Plugin || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Toggles the Pass Keys function, which sends all keyboard input to the currently open plugin window (e.g. for entering a serial number in the plugin GUI).
|-
| Bypass Plugin || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Toggles plugin’s bypass property to control whether audio is routed through the plugin or not.
|}

== Tree View ==

These shortcuts are applied when the [[Manual:_Tree_View|Tree View]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Switch between Upper / Lower Tree View || <kbd>Tab</kbd> || Switches focus between the upper and lower panel of the Tree View.
|-
| Open / View Item || <kbd>Enter</kbd> || Opens / views / previews the selected item (same action as double-click).
|-
| Play Item || <kbd>Space</kbd> || Previews the selected item if it is a sample, instrument or file.
|-
| Insert Item || <kbd>Insert</kbd> || Inserts an empty item (e.g. sample or instrument slot) after the currently selected item.
|-
| Duplicate Item || <kbd>Shift</kbd>+<kbd>Insert</kbd> || Duplicates the currently selected item (e.g. sample or instrument slot).
|-
| Delete Item || <kbd>Delete</kbd> || Deletes the currently selected item.
|-
| Delete Item Permanently || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Delete Item”, but if the selected item is a file, it will not be moved to the recycling bin.
|-
| Rename Item / Send To Editor || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items belonging to an open module (e.g. patterns, samples, instruments, ...): The selected item is renamed. For items in the instrument library: The item is sent to the last active sample or instrument editor and replaces the currently selected sample or instrument.
|-
| Send To Editor (Insert New) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items in the instrument library: The item is sent to the last active sample or instrument editor and is loaded into a new sample or instrument slot.
|-
| Go to Parent Folder || <kbd>Backspace</kbd> || Changes the instrument library folder to the current location′s parent folder.
|-
| Find in Instrument Library || <kbd>Ctrl</kbd>+<kbd>F</kbd>|| Opens the search filter to quickly locate files and folders in the instrument library.
|-
| Sort Instrument Library By Name || || Items in the instrument library are sorted by their file name.
|-
| Sort Instrument Library By Date || || Items in the instrument library are sorted by their last file modification date.
|-
| Sort Instrument Library By Size || || Items in the instrument library are sorted by their file size.
|}

[[Category:Manual|Keyboard Actions]]

Development: 228 Extensions

2025-09-05T17:46:14Z

Saga Musix: Pattern colors

This document is for OpenMPT 1.17.02.48 r192 and newer (<code>cwtv</code> ≥ 0x088D). For older versions, check [[Development:_OpenMPT_Format_Extensions#Custom_Tunings_(old)|OpenMPT Format Extensions § Custom Tunings (old)]].

The MPTM format is nearly identical to the IT format. The only difference is that OpenMPT stores additional data (besides the ModPlug/OpenMPT song extensions) in MPTM files to store the settings for MPTM features like custom tunings, and to specify that a file is in the MPTM format in the first place (otherwise it would be detected as IT).

This additional data is stored in a chunk at the end of MPTM files (after the OpenMPT song extensions).

The chunk contains settings for these features:
* Custom tunings.
* Pattern time signature overrides, and Parameter Control notes in patterns.
* All sequences and their order lists.

Other MPTM features (e.g. fractional tempos) use [[Development:_OpenMPT_Format_Extensions|regular OpenMPT extensions]].

== Introduction ==

These are the datatypes used in this document ('''all numbers''' are stored in little-endian format, '''even floating-point numbers'''):
* <code>uint8</code>, <code>uint16</code>, <code>uint32</code>, <code>uint40</code>: an unsigned integer with the given bit width.
* <code>int8</code>, <code>int16</code>, <code>int32</code>: a signed integer with the given bit width.
* <code>float32</code>: a 32-bit (single-precision) IEEE-754 floating-point number.
* <code>char</code>: a text character (text encoding may vary, so a single character is not necessarily one byte).
* Brackets (<code>[]</code>) after a datatype specify an array of that datatype.
** If there is a number between the brackets, it is the number of items in the array.

There are also custom datatypes that are explained below:

=== Adaptive Integers ===

Adaptive integers are unsigned little-endian integer datatypes that can take less bytes to be stored (compared to regular integers), by storing their own length in themselves. In this document, the datatype of adaptive integers is written as <code>auint</code> followed by its bit width (e.g., <code>auint64</code>).
* In a 16-bit adaptive integer, the least significant bit of the first byte (<code>0</code> or <code>1</code>) specifies whether the integer is stored in 1 or 2 bytes respectively. The remaining 7 or 15 bits store the integer.
* In a 32-bit adaptive integer, the least significant two bits of the first byte (<code>00</code>, <code>01</code>, <code>10</code>, or <code>11</code>) specify whether the integer is stored in 1, 2, 3, or 4 bytes respectively. The remaining 6, 14, 22, or 30 bits store the integer.
* In a 64-bit adaptive integer, the least significant two bits of the first byte (<code>00</code>, <code>01</code>, <code>10</code>, or <code>11</code>) specify whether the integer is stored in 1, 2, 4, or 8 bytes respectively. The remaining 6, 14, 30, or 62 bits store the integer.

=== Strings ===

Most text strings are stored as follows: the string's length ('''in bytes, not characters''') stored as a 64-bit adaptive integer, followed by the string itself. OpenMPT will stop reading a string if a <code>0x00</code> byte (null character) is present anywhere in the string, or the string is longer than 255 characters. In this document, the datatype of this type of strings is written as <code>string</code>. If a string is stored in a different format, it will be specified.

=== Additional Notes ===

* In this document, "Windows codepage" refers to the user's selected ACP codepage in Windows (<code>HKLM\SYSTEM\CurrentControlSet\Control\Nls\CodePage\ACP</code>), which is '''usually''' set to [[Wikipedia:Windows-1252|1252]], but may be different depending on the system locale.

== 228 Chunk Structure ==

Each 228 chunk contains a header, a set of entries, and a map.

The header contains information about the chunk, such as its number of entries, or the starting position of its map.

The main data section of the chunk can have any number of entries in it. Each entry is a set of bytes that can represent anything, such as an integer, a floating-point number, a string, or even a 228 chunk (a chunk can be an entry of another chunk).

The map contains information about the entries of the chunk, such as the ID, position, and size of each entry.

In the list and table below, features that are never written to files by the current version of OpenMPT are shown in green text (see [[#Default_Chunk_Settings|Default Chunk Settings]] for more information).

This is the general structure of a 228 chunk:

* Header
** Signature bytes (<code>228</code>)
** Chunk ID
** "Header byte"
** Additional header data, including the "flag byte"
** Numeric form of version number
** String form of version number
** Custom ID length for entries
** Fixed entry size
** Chunk description
** Timestamp
** Number of entries in the chunk
** Starting position of the map in this chunk
* Entries
** (Entry 1)
** (Entry 2)
** (Entry 3)
** (etc.)
* Map
** ID of Entry 1
** Start position of Entry 1
** Size of Entry 1
** Description of Entry 1
** ID of Entry 2
** Start position of Entry 2
** Size of Entry 2
** Description of Entry 2
** ID of Entry 3
** Start position of Entry 3
** Size of Entry 3
** Description of Entry 3
** (etc.)

=== Header Structure ===

This is the structure of the header of a chunk:

{| class="wikitable"
|-
! Datatype
! Content
|-
| <code>char[3]</code>
| 3-byte signature: <code>228</code>. Identifies the start of a 228 chunk.
|-
| <code>uint8</code>
| Length of the chunk's ID (in bytes).
|-
| <code>uint8[]</code>
| The chunk's ID. Usually readable as a string, but can be any set of bytes.
|-
| <code>uint8</code>
| "Header byte". The bits of this byte specify what is and isn't stored in the chunk.
* Bits 0 and 1 specify the length of the IDs of this chunk's entries, unless the chunk has a "flag byte" (explained later) and its bit 0 is set.
** <code>00</code>: all entries in this chunk have IDs with length 0 (i.e., they do not have IDs).
** <code>01</code>, <code>10</code>, <code>11</code>: all entries in this chunk have IDs with length 1, 2, or 4 respectively.
* Bit 2: whether this chunk's map stores the starting position of each entry.
* Bit 3: whether this chunk's map stores the size of each entry.
* Bit 4: whether this chunk's header stores a numeric form of its version number.
* Bit 5: whether this chunk's header stores a string (text) form of its version number.
* Bit 6: whether this chunk's descriptions (explained later) use a fixed 16-bit encoding (e.g. [[Wikipedia:Universal_Coded_Character_Set|UCS-2]]) instead of a fixed 8-bit encoding (e.g. [[Wikipedia:ISO/IEC_8859-1|ISO-8859-1]] / [[Wikipedia:Windows-1252|Windows-1252]]).
* Bit 7: whether this chunk's map contains descriptions for each entry.
|-
| <code>auint32</code>
| Size of additional header data.
|-
| <code>uint8[]</code>
| Additional header data. 
If the additional header data is at least 2 bytes long, '''and''' the first byte is <code>0x00</code>, the second byte is read as the "flag byte". 
The bits of the flag byte contain additional information about the chunk:
* Bit 0: whether the chunk uses custom ID lengths for its entries.
* Bit 1: whether all entries in this chunk have a fixed size.
* Bit 2: whether the chunk contains a description about itself.
* Bit 3: whether the chunk contains a timestamp.
The flag byte does not need to exist if none of its bits are supposed to be set.
|-
| <code>auint64</code>
| Numeric form of the version number. Usually contains the same integer stored in the <code>VWSL</code> value in the OpenMPT song extensions, but there are exceptions. 
This adaptive integer only exists if bit 4 of the header byte is set.
|-
| <code>uint8</code>
| Length of the string form of the version number, in bytes. 
This byte only exists if bit 5 of the header byte is set.
|-
| <code>char[]</code>
| String form of the version number. It was never used in any version of OpenMPT. 
This string only exists if bit 5 of the header byte is set.
|-
| <code>uint8</code>
| Custom ID length for entries.
* If bit 0 is set, the length of the IDs of this chunk's entries are not constant, and are stored next to the IDs in the map. In this case, the remaining 7 bits of this byte are ignored.
* If bit 0 is not set, the length of the IDs of this chunk's entries are stored in the remaining 7 bits of this byte.
This byte only exists if the chunk has a flag byte and its bit 0 is set.
|-
| <code>auint32</code>
| Fixed entry size. Determines the size of all entries in this chunk. 
This adaptive integer only exists if the chunk has a flag byte and its bit 1 is set.
|-
| <code>auint16</code>
| Length of this chunk's description (in characters). 
This adaptive integer only exists if the chunk has a flag byte and its bit 2 is set.
|-
| <code>char[]</code>
| Chunk description. If bit 6 of the header byte is set, the string uses use a fixed 16-bit encoding (e.g. [[Wikipedia:Universal_Coded_Character_Set|UCS-2]]) instead of a fixed 8-bit encoding (e.g. [[Wikipedia:ISO/IEC_8859-1|ISO-8859-1]] / [[Wikipedia:Windows-1252|Windows-1252]]). 
This string only exists if the chunk has a flag byte and its bit 2 is set.
|-
| <code>uint40</code>
| Timestamp, stored as a little-endian unsigned integer in 5 bytes (40 bits). 
This was originally intended to store the Unix time (number of seconds past 1970-01-01 00:00:00 UTC) at the time of saving the file. 
This integer only exists if the chunk has a flag byte and its bit 3 is set.
|-
| <code>auint64</code>
| Number of entries in this chunk. 
The current version of OpenMPT always writes this adaptive integer in two bytes, even if it only needs one. 
Additionally, this causes OpenMPT to be unable to write chunks with more than 16383 entries.
|-
| <code>auint64</code>
| Start position of this chunk's map, relative to the start of this chunk (where the <code>228</code> bytes start). 
This adaptive integer does not exist if this chunk does not have a map (see [[#Map_Structure|the section on maps]] for an explanation on whether a map exists or not). 
The current version of OpenMPT always writes this adaptive integer in eight bytes, even if it needs fewer bytes.
|}

=== Entry Structure ===

The entries in a chunk start right where the header ends. Entries are just sets of bytes, and they are stored right after each other.

Entries of a chunk can be chunks themselves, allowing a chunk to be "nested" in another chunk by being one of the outer chunk's entries. Note that a nested chunk is a chunk on its own, and its header, entries, and map have nothing to do with those of the outer chunk that contains it.

Additionally, each entry can have an ID, and if said entry is a chunk, its entry ID when referred to as an entry of the outer chunk is '''not necessarily related''' to its chunk ID (which is stored in the inner chunk's header). '''It can be the same ID or a different one'''.
That is very important to know, because OpenMPT stores a lot of inner chunks as entries of other chunks, so having to deal with their IDs can be quite confusing.

Note: Entries do '''not''' need to be stored in a specific order, '''as long as the chunk that contains them specifies entry IDs in its map'''. Otherwise, they have to be stored in the same order that OpenMPT reads them.

=== Map Structure ===

Chunks usually have maps. A chunk will not have a map if bits 2, 3, and 7, of the header byte, are not set, and the ID length for entries is fixed to 0. However, chunks written by the current version of OpenMPT do not meet this requirement, so they always have maps. If a chunk does not have a map, its header will also not store the start position of the map.

This is the structure of a section of a map corresponding to a '''single entry''':
{| class="wikitable
|-
! Datatype
! Content
|-
| <code>auint16</code>
| Length of the entry's ID. 
This adaptive integer only exists if the ID length for entries is not fixed (i.e., bit 0 of the flag byte and bit 0 of the custom ID length byte are both set).
|-
| <code>uint8[]</code>
| The entry's ID. Usually readable as a string, but can be any set of bytes.
|-
| <code>auint64</code>
| Start position of this entry in the chunk, relative to the start of the chunk itself. 
This adaptive integer only exists if bit 2 of the header byte is set.
|-
| <code>auint64</code>
| Size of this entry in the chunk (in bytes). 
This adaptive integer only exists if bit 3 of the header byte is set, and bit 1 of the flag byte is '''not''' set (or if there is no flag byte).
|-
| <code>auint16</code>
| Length of this entry's description (in characters). 
This adaptive integer only exists if bit 7 of the header byte is set.
|-
| <code>char[]</code>
| Description of the entry. If bit 6 of the header byte is set, the string uses a fixed 16-bit encoding (e.g. [[Wikipedia:Universal_Coded_Character_Set|UCS-2]]) instead of a fixed 8-bit encoding (e.g. [[Wikipedia:ISO/IEC_8859-1|ISO-8859-1]] / [[Wikipedia:Windows-1252|Windows-1252]]). 
This string only exists if bit 7 of the header byte is set.
|}

An entire map of a chunk is made of several copies of the structure shown in the table above, each copy corresponding to one of the entries of the chunk.

Note: The sections of a chunk's map which each correspond to an entry, do '''not''' need to be in the same order as the way the entries themselves are stored in the chunk, '''as long as the chunk specifies starting positions and sizes of entries in the map'''.

== 228 Chunks in MPTM Files ==

Reading the previous sections of this document is absolutely necessary to understand the rest of this document!

The last four bytes of a valid MPTM file should contain an unsigned 32-bit integer that points to a 228 chunk with an ID of <code>mptm</code>, which contains all the settings for MPTM features (like custom tunings) in its entries. OpenMPT writes this chunk after the OpenMPT song extensions, and before the last four bytes of the file that specify its position.

=== Default Chunk Settings ===

'''ALL chunks''' (and their "sub-chunks", a.k.a. the entries that are chunks themselves) that are '''written by the current version of OpenMPT''' have a header byte of <code>00011111</code> (<code>0x1F</code>), an additional header data size of 2 (byte <code>00001000</code> (<code>0x08</code>)), a flag byte of <code>00000001</code> (<code>0x01</code>) and a "custom entry ID length" byte of <code>00000001</code> (<code>0x01</code>).

This means that all chunks written by the current version of OpenMPT:
* Have a map.
* Have variable ID lengths for their entries, so they have to be stored in the map.
* Store the starting position of their entries in their maps.
* Store the size of their entries in their maps.
* Store the numeric form of their version number in their headers.
* Do '''not''' store a string form of their version number in their headers.
* Do '''not''' store a timestamp in their headers.
* Do '''not''' store descriptions about themselves in their headers.
* Do '''not''' store descriptions about their entries in their maps.
* Do '''not''' have fixed sizes for their entries.

However, OpenMPT '''does''' know how to properly read any chunks that were written by older versions of OpenMPT or by modifying a file using some external program, even if the chunks do '''not''' have the properties described above, '''as long as the structure of the chunks are written "correctly"'''.

Files made with really old versions of OpenMPT, especially earlier versions of 1.17, may have differences in their header bytes and flag bytes compared to recent versions, but the chunk structure is always correct.

Additionally, new chunks and entries have been added to many versions, such as the Custom Tuning UTF-8 entry, which specifies that the names of custom tunings are encoded in UTF-8. Files with custom tunings that have been made with OpenMPT 1.29.00.40 or older will not have that entry, causing newer versions of OpenMPT to correctly read the names in the 8-bit Windows codepage.

=== Main Chunk ===

As of OpenMPT 1.17.03.01 r323, the <code>mptm</code> chunk's version number is the same integer stored in the <code>VWSL</code> value in the OpenMPT song extensions (e.g., 1.29.14.01 would be 0x01291401). Before r323, the chunk's version number was 1.

=== Custom Tunings ===

This section documents how custom tunings are stored in MPTM files made with OpenMPT 1.17.02.48 r192 and newer (<code>cwtv</code> ≥ 0x088D). In older versions, custom tunings are the only MPTM feature, and they do not use 228 chunks. The old format is documented in [[Development:_OpenMPT_Format_Extensions#Custom_Tunings_(old)|OpenMPT Format Extensions § Custom Tunings (old)]].

Entries containing custom tunings are stored in the <code>mptm</code> chunk, and only if the song has (or uses) any custom tunings (the default IT tuning does not count).

==== UTF-8 Text Encoding Indicator ====

This entry is a single byte with an entry ID of <code>UTF8Tuning</code>, stored as one of the entries of the base <code>mptm</code> chunk. It determines the global text encoding of the names of the tunings (and their note names). However, the tuning collection and each tuning can have their own text encoding indicator that overrides this one.

* If this entry exists and its byte value is not 0: UTF-8.
* If this entry does not exist or its byte value is 0: Windows codepage.

Currently, OpenMPT always writes this entry with a value of 1 (UTF-8). It will be written if there are any custom tunings, even if no instruments use them.

==== Tuning Collection ====

Tuning collections are chunks that contain custom tunings. They can exist separately in .TC files and can be imported into MPTM files using the [[Manual:_Tuning_Properties|Tuning Properties]] dialog.

In MPTM files, there is only one tuning collection called the "Tune-specific" tuning collection. For MPTM files made with OpenMPT versions older than 1.27.00.55, although there are "local tunings" and "built-in tunings" (which are now discontinued) besides the "tune-specific" ones, they are '''not''' stored in the MPTM files themselves.

In MPTM files, the "tune-specific tunings" collection is stored as an entry of the base <code>mptm</code> chunk.

* The entry ID of the "tune-specific tunings" collection chunk in MPTM files, which is stored in the map of the <code>mptm</code> chunk, is <code>0</code>.
* The chunk ID of any tuning collection chunk (regardless of the collection type, or whether it is stored in an MPTM or TC file), which is stored in its own header, is <code>TC</code>.

The chunk's version number is 3.

These are the entries stored in a tuning collection (<code>TC</code>) chunk:
{| class="wikitable"
|-
! Entry ID
! Datatype
! Content
|-
| <code>UTF8</code>
| <code>uint8</code>
| The text encoding of this collection's name, and the name of its tunings.
* If this entry exists and its byte value is not 0: UTF-8 (override global encoding).
* If this entry does not exist or its byte value is 0: Inherit encoding from global encoding.
The current version of OpenMPT always writes this entry with a value of 1 (UTF-8).
|-
| <code>0</code>
| <code>string</code>
| The collection's name. 
In TC files, the name would be the same as what it was when the TC file was exported in OpenMPT. 
In MPTM files, the only stored tuning collection is the Tune-specific tunings, and its name is <code>Tune specific tunings</code>.
|-
| <code>1</code>
| <code>uint16</code>
| The collection's edit mask. This value was used to specify which settings of the collection can be changed, but it is no longer used. 
Currently, OpenMPT always writes this entry with a value of 0xFFFF (allow editing everything).
|}

In addition to the three entries listed above, the rest of the entries are all chunks, where each one is a custom tuning. They all have an entry ID of <code>2</code>.

==== Tuning ====

For each custom tuning:
* Its entry ID, which is stored in the map of the <code>TC</code> chunk, is <code>2</code>.
* Its chunk ID, which is stored in its own header, is <code>CTB244RTI</code>.

The chunk's version number is 67108868 (<code>0x04000004</code>).

These custom tuning chunks can also exist separately in .TUN files, and can be exported from / imported to MPTM files using the [[Manual:_Tuning_Properties|Tuning Properties]] dialog.

These are the entries stored in a custom tuning (<code>CTB244RTI</code>) chunk:

{| class="wikitable"
|-
! Entry ID
! Datatype
! Content
|-
| <code>UTF8</code>
| <code>uint8</code>
| The text encoding of the tuning's name.
* If this entry exists and its value is not 0: UTF-8 (override collection's encoding).
* If this entry does not exist or its value is 0: Inherit encoding from collection's encoding.
|-
| <code>0</code>
| <code>string</code>
| The custom tuning's name.
|-
| <code>1</code>
| <code>uint16</code>
| The tuning's edit mask. This value was used to specify which settings of the tuning can be changed, but it is no longer used. 
Currently, OpenMPT always writes this entry with a value of 0xFFFF (allow editing everything).
|-
| <code>2</code>
| <code>uint16</code>
| Tuning type.
* 0 = General
* 1 = Group-geometric
* 3 = Geometric
Any other value will result in OpenMPT failing to load the custom tuning data.
|-
| <code>3</code>
| (custom structure)
| Note names (see [[#Tuning_Note_Name_Structure|the Tuning Note Name Structure]]). 
If this entry does not exist, OpenMPT will use the "default" note names (the predefined note names when creating a new tuning in OpenMPT).
|-
| <code>4</code>
| <code>uint32</code>
| Finetune steps.
|-
| <code>RTI0</code>
| (custom structure)
| Ratio table (see [[#Tuning_Ratio_Table_Structure|the Ratio Table Structure]]).
* For General tunings, the ratio table stores the ratios for all notes.
* For Group-geometric tunings, the ratio table stores the ratios for only the first (lowest pitch) group.
OpenMPT only writes this entry if the tuning type is General or Group-geometric.
|-
| <code>RTI1</code>
| <code>int16</code>
| First note index. 
OpenMPT writes this entry for all types of tunings, and usually with a value of -64.
|-
| <code>RTI2</code>
| <code>uint16</code>
| Group size. 
OpenMPT only writes this entry if the tuning type is Geometric. 
(For group-geometric tunings, the group size is equal to the size of the ratio table.)
|-
| <code>RTI3</code>
| <code>float32</code>
| Group ratio. 
OpenMPT only writes this entry if the group ratio is greater than 0 and if the tuning type is Geometric or Group-geometric.
|-
| <code>RTI4</code>
| <code>uint16</code>
| Number of ratios in the ratio table. 
OpenMPT only writes this entry if the tuning type is Geometric or Group-geomtric, with a value of 128 for Geometric tunings, and the group size for Group-geometric tunings.
|}

===== Tuning Note Name Structure =====

{| class="wikitable"
|-
! Datatype
! Content
|-
| <code>auint64</code>
| Number of note names. 
OpenMPT uses the same number as the group size for Geometric and Group-geometric tunings, and 128 for General tunings.
|}

After the adaptive integer above, there are multiple note names that specify the names of notes in the entire table of notes (in Generic tunings) or only the notes of a single group (in Geometric and Group-geometric tunings).

This is the structure of a single note name:

{| class="wikitable"
|-
! Datatype
! Content
|-
| <code>int16</code>
| Note index. A zero-based index specifying which note this name corresponds to (0=first note, 1=second note, etc.)
|-
| <code>uint8</code>
| Length of the note name ('''in bytes, not characters''').
|-
| <code>char[]</code>
| Note name. The text encoding is inherited from the custom tuning's text encoding entry. 
OpenMPT will stop reading the name if a <code>0x00</code> byte (null character) is present anywhere in the name.
|}

The structure above is repeated for every note (or every note '''in the group''' if the tuning is Geometric or Group-geometric) that has a custom name.

Note: In Geometric and Group-geometric tunings, the group numbers / octave numbers are '''not''' a part of the note names.

===== Tuning Ratio Table Structure =====

{| class="wikitable"
|-
! Datatype
! Content
|-
| <code>auint64</code>
| Number of ratios in the ratio table.
OpenMPT writes the same number as the group size for Group-geometric tunings, and 128 for General tunings.
|-
| <code>float32[]</code>
| Ratios. 
For Group-geometric tunings, only the ratios of the first (lowest pitch) group are stored.
|}

==== Tuning Map ====

(Not to be confused with "maps" of chunks!)

The tuning map is one of the entries of the base <code>mptm</code> chunk. It is a structure that stores what tuning each instrument should use. Its entry ID, stored in the map of the <code>mptm</code> chunk, is <code>1</code>.

In a file made using OpenMPT 1.27.00.55 or older, local and built-in tunings are also specified in the tuning map, even though they are not written to the tuning collection chunk. If the file is loaded in newer versions, they will be converted to tune-specific ones and will then be stored in the MPTM file's tune-specific tuning collection chunk.

The first item in the structure is a <code>uint16</code>, containing the number of tunings that are used by instruments, including the default IT tuning and non-tune-specific tunings:
{| class="wikitable"
|-
! Datatype
! Content
|-
| <code>uint16</code>
| Number of tunings that are used by instruments, including non-tune-specific tunings.
|}

Following the number of tunings, there are mappings that map each tuning to an index number. This is the structure of a single tuning-to-index mapping:

{| class="wikitable"
|-
! Datatype
! Content
|-
| <code>uint8</code>
| Length of the tuning's name ('''in bytes, not characters''').
|-
| <code>char[]</code>
| The tuning's name.
* The name of the default IT tuning (called <code>OpenMPT IT behaviour</code> in OpenMPT), is written as <code>->MPT_ORIGINAL_IT<-</code>.
* In files made with OpenMPT 1.27.00.55 or older, the names of the built-in tunings are written as <code>12TET</code> and <code>12TET <nowiki>[[fs15 1.17.02.49]]</nowiki></code>.
OpenMPT will stop reading the name if a <code>0x00</code> byte (null character) is present anywhere in the name.
|-
| <code>uint16</code>
| The index that this tuning is mapped to.
|}

The structure shown in the table above is repeated for every tuning.

Finally, there is an array of <code>uint16</code>s, each one corresponding to an instrument of the song, where the value of each one is the index that is mapped to the tuning that the corresponding instrument should use.

Note: Due to the way the tunings are located when a file is loaded, if there are multiple tunings with the same name, some instruments might be loaded with the wrong tunings.

=== Extended Pattern Data ===

Extended pattern data is used to store data for patterns that use features exclusive to the MPTM format: Pattern-specific time signature overrides and Parameter Control notes.

All extended pattern data is stored in a "pattern collection" chunk.

==== Extended Pattern Collection ====

The pattern collection (or "pattern container" according to the source code) is a chunk, stored as one of the entries of the base <code>mptm</code> chunk. It contains extended pattern data.
* Its entry ID, which is stored in the map of the <code>mptm</code> chunk, is <code>mptPc</code>.
* Its chunk ID, which is stored in its own header, is also <code>mptPc</code>.

The chunk's version number is the same integer stored in the <code>VWSL</code> value in the OpenMPT song extensions (e.g., 1.29.14.01 would be 0x01291401).

The entries stored in the <code>mptPc</code> chunk consist of "extended pattern" chunks, and a <code>uint16</code> with an entry ID of <code>num</code> which specifies how many patterns will have their extended data read when loading the file. Its recommended value is the number of patterns in the song, but the song will still be loaded correctly if the number is at least bigger than the last pattern number that uses extended data.

If any pattern has extended data, OpenMPT writes the extended data for all patterns (not just the required ones), followed by the <code>num</code> entry containing the number of patterns in the song.

==== Extended Pattern ====

For each pattern:
* Its entry ID, which is stored in the map of the <code>mptPc</code> chunk, is not readable as a string, but instead, is a little-endian 16-bit unsigned integer, specifying its pattern number (pattern 0 = 0x0000, pattern 1 = 0x0001, and so on).
* Its chunk ID, which is stored in its own header, is <code>mptP</code>.

The chunk's version number is the same integer stored in the <code>VWSL</code> value in the OpenMPT song extensions (e.g., 1.29.14.01 would be 0x01291401).

These are the entries stored in an <code>mptP</code> chunk:

{| class="wikitable"
|-
! Entry ID
! Datatype
! Content
|-
| <code>data</code>
| (custom structure)
| The extended pattern data, which will be merged onto the IT pattern data when the file is read. 
Technically, it can be used for storing any pattern data, but OpenMPT uses it for storing only the Parameter Control notes of each pattern.
The data is stored in the same format as the [https://github.com/schismtracker/schismtracker/wiki/ITTECH.TXT#impulse-pattern-format IT pattern format], but without the first 8 bytes, and with a different format for mask bytes: 
* Bit 0: Include note (PC: <code>0xFC</code>, PCs: <code>0xFB</code>)
* Bit 1: Include plugin number
* Bit 2: Include high byte of controller ID
* Bit 3: Include low byte of controller ID
* Bit 4: Include high byte of parameter
* Bit 5: Include low byte of parameter
* Bit 6: Include extra data
The bytes after the mask byte (specifically the ones that need to be written) are written in the same order shown in the list above. 
The extra data (enabled via bit 6 of the mask byte) consists of an 8-bit unsigned integer specifying the size, followed by a set of bytes of that size. It is ignored by OpenMPT. 
Any data that is specified by the mask byte to '''not''' be included will have the same data as the previous PC/PCs note in the channel. 
OpenMPT writes this entry for all patterns, even if they do not contain PC/PCs notes.
|-
| <code>COL</code>
| <code>uint32</code>
| The color assigned to the pattern. Format is [R, G, B, 0], or [x, x, x, non-zero] for a pattern with no color OpeMPT only writes this entry for patterns that have a color assigned.
|-
| <code>RPB.</code>
| <code>uint32</code>
| Custom "rows per beat" value for this pattern. 
OpenMPT only writes this entry for patterns that use a custom time signature.
|-
| <code>RPM.</code>
| <code>uint32</code>
| Custom "rows per measure" value for this pattern. 
OpenMPT only writes this entry for patterns that use a custom time signature.
|-
| <code>SWNG</code>
| (custom structure)
| Custom tempo swing for this pattern. 
Stored in the same format as the <code>SWNG</code> value in the OpenMPT song extensions. 
OpenMPT only writes this entry for patterns that use a custom tempo swing.
|}

=== Sequences ===

Currently, the main way sequences are stored is a "sequence collection" chunk, but there is also an older format that was used when an MPTM file could only have one sequence, which is still used by OpenMPT to make the file somewhat compatible with those old versions.
Here is a history of how order lists were stored throughout different versions:
* 2006-08-20: OpenMPT 1.17.02.45, r166 (MPTM format introduced)
** Only one sequence, order list stored at 0x00C0 (exactly like Impulse Tracker).
* 2006-10-02: OpenMPT 1.17.02.45, r168
** <code>cwtv</code> changed from 0x088A to 0x088B.
** The order list stored at 0x00C0 now uses a custom structure (documented in [[Development:_OpenMPT_Format_Extensions#Order_list_(old)|OpenMPT Format Extensions § Order list (old)]]), and uses 32-bit pattern indices instead of 8-bit, allowing patterns over 253.
* 2008-01-12: OpenMPT 1.17.02.49, r195
** <code>cwtv</code> changed from 0x088D to 0x088E.
** The order list stored at 0x00C0 now stores orders like Impulse Tracker again, which is limited up to pattern 253. However, there is now an entry in the <code>mptm</code> chunk that is used to store the order list if there are patterns over 253. If a file has this entry, OpenMPT will read the order list from it, and not from 0x00C0.
* 2009-09-16: OpenMPT 1.17.03.01, r366
** MPTM files can now have multiple sequences, where one of them can be the "default sequence". All sequences are now stored in a 228 chunk called the "sequence collection" chunk. A copy of the default sequence will also be stored at 0x00C0, and the old sequence entry if there are patterns over 253. However, in these new files, OpenMPT will ignore the order list at 0x00C0 entirely. This means that if there is no sequence collection or old sequence entry, even if there is an order list at 0x00C0, OpenMPT will load the file without an order list.


In the rest of this document, the new multi-sequence format introduced in r366 is documented first, and after that is the "old" sequence format introduced in r195 (which is still written to files if the default sequence contains patterns beyond 253).

==== Sequence Collection (r366 and newer) ====

The sequence collection is a chunk, stored as one of the entries of the base <code>mptm</code> chunk. It contains the sequences of the MPTM file.

* Its entry ID, which is stored in the map of the <code>mptm</code> chunk, is <code>mptSeqC</code>.
* Its chunk ID, which is stored in its own header, is also <code>mptSeqC</code>.

The chunk's version number is the same integer stored in the <code>VWSL</code> value in the OpenMPT song extensions (e.g., 1.29.14.01 would be 0x01291401).

These are the entries stored in the <code>mptSeqC</code> chunk:

{| class="wikitable"
|-
! Entry ID
! Datatype
! Content
|-
| <code>n</code>
| <code>uint8</code>
| Number of sequences in the file.
|-
| <code>c</code>
| <code>uint8</code>
| The "default sequence" of the file. 
Uses zero-based numbering. (0=first sequence, 1=second sequence, etc.) 
The "default sequence" is the one that is selected (the one shown in the order list) when the file is loaded, or the last time the file was saved. 
It is also the one that is stored in the IT order list at 0x00C0 (and the old sequence entry if it contains patterns over 253).
|}

In addition to the two entries listed above, the rest of the entries are all chunks, each one representing a sequence. Each one has an entry ID of the corresponding sequence's number, as a byte, with 0-based numbering.

For example, the ID of the entry corresponding to the first sequence is a 0x00 byte. If a second sequence existed, its entry ID would be 0x01, the next would be 0x02, and so on.

Currently, OpenMPT only allows creating up to 50 (0x32 in hex) sequences, so the limit (0xFF) is never reached (at least without editing the file externally).

==== Sequence (r366 and newer) ====

For each sequence:

* Its entry ID, which is stored in the map of the <code>mptSeqC</code> chunk, is a single byte that determines which sequence it is (sequence 1 = 0x00, sequence 2 = 0x01, and so on).
* Its chunk ID, which is stored in its own header, is <code>mptSeq</code>.

The chunk's version number is the same integer stored in the <code>VWSL</code> value in the OpenMPT song extensions (e.g., 1.29.14.01 would be 0x01291401).

These are the entries stored in an <code>mptSeq</code> chunk:

{| class="wikitable"
|-
! Entry ID
! Datatype
! Content
|-
| <code>u</code>
| <code>uint8</code>
| The text encoding of the sequence's name. 
* If this entry exists and its value is not 0: UTF-8.
* If this entry does not exist or its value is 0: Windows codepage.
The current version of OpenMPT always writes this entry with a value of 1 (UTF-8).
|-
| <code>n</code>
| (custom structure)
| Sequence name. 
Contains the length of the name ('''in bytes, not characters'''), followed by the name. 
The length is stored similarly to a 32-bit adaptive integer, except that the two bits that specify the size of the adaptive integer are bits 2 and 3 instead of 0 and 1, and bits 0 and 1 are unused.
Depending on bits 2 and 3, the remaining 4, 12, 20, or 28 bits store the integer, which in this case, is the length of the name (in bytes).
|-
| <code>l</code>
| <code>uint16</code>
| Length of the sequence (in orders).
|-
| <code>a</code>
| <code>uint16[]</code>
| The sequence's order list. Each order has the pattern number associated with it stored as a <code>uint16</code>. 
For special ("non-pattern") orders:
* <code>+++</code> (separator) orders are stored as 0xFFFE.
* <code>---</code> (end of song) orders are stored as 0xFFFF.
|-
| <code>r</code>
| <code>uint16</code>
| Restart position. OpenMPT only writes this entry if the sequence's restart position is not 0.
|-
| <code>t</code>
| <code>uint32</code>
| Default tempo. This is a fixed-point number with 4 digits of fractional precision, i.e. divide the value by 10.000 to get the real tempo.
|-
| <code>s</code>
| <code>uint32</code>
| Default speed (ticks per row).
|}

==== "Old" Sequence (r195 and newer) ====

The old r195 sequence, which is used to store the default sequence if it has orders corresponding to patterns over 253, is a simple structure stored as one of the entries of the base <code>mptm</code> chunk. Its entry ID, which is stored in the map of the <code>mptm</code> chunk, is <code>2</code>.

The structure of this entry is as follows:

{| class="wikitable"
|-
! Datatype
! Content
|-
| <code>uint16</code>
| Length of the sequence (in orders).
|-
| <code>uint16[]</code>
| The order list. Each order has the pattern number associated with it stored as a <code>uint16</code>. 
For special ("non-pattern") orders:
* <code>+++</code> (separator) orders are stored as 0xFFFE.
* <code>---</code> (end of song) orders are stored as 0xFFFF.
|}

[[Category:Development|228 Extensions]]

Development: Test Cases/IT

2025-08-31T15:16:36Z

Saga Musix: S7B_StillAppliesFilter.it

{{Testsuite Introduction|format=IT|tracker=Impulse Tracker}}

{{Testcase|format=it|name=Autovibrato-Reset.it|pass=???}}
The autovibrato sweep is not reset when using portamento.

{{Testcase|format=it|name=Bidi-Loops.it|pass=793}}
In Impulse Tracker’s software mixer, ping-pong loops are shortened by one sample. This does not happen with the GUS hardware driver, but I assume that the software drivers were more popular due to the limitations of the GUS, so OpenMPT emulates this behaviour.

{{Testcase|format=it|name=BidiPrecision.it|pass=15871}}
An extension to [[#Bidi-Loops.it|Bidi-Loops.it]], this test verifies that the loop length of ping-pong loops is precise. The test is not required to stay absolutely silent, but the two channels may not phase, i.e. the sound should be a static buzz.

{{Testcase|format=it|name=CarryNNA.it|pass=1503 + 22849}}
This is a very interesting test case, because it actually sounds different when using Impulse Tracker’s WAV writer and Sound Blaster (and probably other drivers) output (the Sound Blaster 16 MMX driver also follows the behaviour of the WAV writer, to make things even more confusing).
The main difference is that the Sound Blaster driver will only consider the envelope carry flag if the New Note Action is not “Note Cut”. The WAV writer does not check for the NNA and will always apply the carry flag if it’s set. OpenMPT goes after the WAV writer, while e.g. XMPlay used the Sound Blaster behaviour for the volume and panning envelope, but the WAV writer’s behaviour for the filter envelope (because of a bug report some years ago) up until 2016. Obviously it is hard to consider which of the two behaviours is correct, so I would just say that both are. :) However, the WAV writer behaviour definitely is more useful (not being able to use Envelope Carry despite it being enabled is quite misleading), I strongly encourage everyone to implement this behaviour.

The reason for the difference is most likely that the non-MMX Sound Blaster driver does not volume-ramp cut notes, while the MMX driver and WAV writer do. The volume ramping requires a NNA channel to be set up, which is a precondition for the envelope carry code to work.

{{Testcase|format=it|name=cut-carry.it|pass=1165}}
Envelopes that have the carry flag set cannot be “picked up” / continued after the note has been cut.

{{Testcase|format=it|name=dct_smp_note_test.it|pass=12819}}
Instrument Duplicate Check Type “Sample” should only be carried out if the old and new instrument match (like all other check types). 
Instrument Duplicate Check Type “Note” should compare the old and new pattern note, not translated notes according to the instrument’s mapping. 

{{Testcase|format=it|name=DNA-NoInstr.it|pass=6311}}
OpenMPT previously did not properly check for the correct sample slot or sample map entry in DNA and NNA checks if no instrument number was provided. This testcase should remain silent when played correctly, i.e. both the first and second note on channel 1 should sound until the end of the pattern.

{{Testcase|format=it|name=DoubleSlide.it|pass=21807}}
Impulse Tracker generally initializes effect parameters, effect working memory and similar stuff once per row, before the effects actually run. When using (tone) portamento commands simulatenously in the effect column and volume column, this can lead to surprising results, and in order to emulate them correctly, it is crucial to implement the effect memory initialization in the exact same order as Impulse Tracker does:

# Evaluate effect column Gxx parameter
# Evaluate volume column gx parameter
# Evaluate volume column ex / fx parameter
# Evaluate effect column Exx / Fxx parameter

If played correctly, The left and right channel of this module should sound identical. The last few rows should stay silent.

{{Testcase|format=it|name=DoubleSlideCompatGxx.it|pass=21807}}
A variation of of [[#DoubleSlide.it|DoubleSlide.it]] with the Compatible Gxx flag turned on. The same rules as above apply, but since portamento up / down and tone portamento memory is not linked, there are some natural differences in handling.

{{Testcase|format=it|name=empty_sample_offset.it|pass=6343}}
In instrument mode, if an offset effect is found next to a note that maps to an invalid sample slot, the offset and illegal note should be ignored completely. Note that this behaviour is different from sample mode, where a previously playing sample will be stopped.

{{Testcase|format=it|name=emptyslot.it|pass=1671}}
I think, Impulse Tracker treats instruments like an additional layer of abstraction and first replaces the note and instrument in the pattern by the sample and note assignments from the sample map table before further evaluating the pattern. That would explain why for example the empty sample map slots do nothing in this module.

{{Testcase|format=it|name=env-flt-max.it|pass=1090 (?)}}
If resonance is not applied, the filter envelope’s maximum value does not ''enable'' any filtering. However, it also does not ''disable'' any filtering when returning from a non-maximum point. This pretty much works like Zxx commands.

{{Testcase|format=it|name=EnvLoopEscape.it|pass=4009}}
I created [[#EnvOffLength.it|EnvOffLength.it]] without realizing that it is essentially the same bug as this one.

{{Testcase|format=it|name=EnvLoops.it|pass=1213}}
In this test, all possible combinations of the envelope sustain point and envelope loops are tested, and you can see their behaviour on note-off.
If the sustain point is at the loop end and the sustain loop has been released, don't loop anymore.
Probably the most important thing for this test is that in Impulse Tracker (and Fasttracker 2), envelope position is incremented before the point is evaluated, not afterwards, so when no ticks have been processed yet, the envelope position should be invalid.

{{Testcase|format=it|name=EnvOffLength.it|pass=4009}}
If an envelope sustain loop happens to end on exactly the same tick as a note-off event occurs, the envelope is not yet released. It will be released whenever the loop end is being hit again.

{{Testcase|format=it|name=EnvReset.it|pass=1481}}
Impulse Tracker resets envelopes under some more or less weird conditions. This tests some of them.

{{Testcase|format=it|name=extreme-filter-test-1.it|pass=1090}}
If resonant filters are rendered with integer arithmetic, they may produce scratching noises in some edge cases. You should not hear any scratches or other weird noises when playing this example.

{{Testcase|format=it|name=extreme-filter-test-2.it|pass=1090}}
Same as the above test case. xmp breaks this module’s output even more than older versions of OpenMPT.

{{Testcase|format=it|name=Fade-Porta.it|pass=1144}}
After a note has been stopped in some way (for example through fade-out or note cut), tone portamento effects on the following note are ignored, i.e. there is no portamento from the stopped note to the new note.

{{Testcase|format=it|name=filter-7F.it|pass=1090 (?)}}
A small test case that demonstrates that full cutoff should not enable the filter if no resonance is applied. Resonance is only ever applied if the cutoff is not full or the resonance is not zero.

{{Testcase|format=it|name=FilterEnvReset.it|pass=1132}}
A cutoff value of 0 should not be reset to full cutoff when triggering a note just because the filter envelope is enabled. This bug is probably very specific to OpenMPT, because it gets rid of some unneccessary code.

{{Testcase|format=it|name=FilterPortaSmpChange.it|pass=18417}}
Normally Impulse Tracker does not disable the filter on portamento if cutoff was previously at 127 and resonance at 0, but in sample mode that is not the case when the new note plays a different sample.

{{Testcase|format=it|name=FilterPortaSmpChange-InsMode.it|pass=?}}
Complementary test for [[#FilterPortaSmpChange.it|FilterPortaSmpChange.it]] in instrument mode. Here the cutoff should never be reset on portamento.

{{Testcase|format=it|name=filter-nna.it|pass=1169}}
This test is just there to be sure that the filter-reset.it and filter-reset-carry.it test cases do not break NNA background channels.

{{Testcase|format=it|name=filter-reset.it|pass=1165}}
As mentioned already, filtering is only ever done in IT if either cutoff is not full or if resonance is set. When a Z7F command is found next to a note and no portamento is applied, it ''disables'' the filter, however in other cases this should not happen.

{{Testcase|format=it|name=filter-reset-carry.it|pass=1165}}
I think this is also just an extenion to the previous test case, to make sure that it does not break anything else.

{{Testcase|format=it|name=filter-reset-envelope.it|pass=16016}}
This test checks that the filter is reset correctly for delayed filtered notes, and also acts as a regression test for [[#filter-reset.it|filter-reset.it]], because the first implementation for this test broke the other test. The output should stay silent (small pops are okay).

{{Testcase|format=it|name=FilterResetPatDelay.it|pass=16137}}
An extension of [[#filter-reset-envelope.it|filter-reset-envelope.it]], this verifies the filter reset behaviour on rows with a Pattern Delay. The filter reset logic should only be applied on rows that are actually retriggering the note: If there is no note delay, the note is retriggered only on the first tick. If there is a note delay, the note is retriggered on every repetition of that row (see [[#PatternDelay-NoteDelay.it|PatternDelay-NoteDelay.it]]).

{{Testcase|format=it|name=FineVolColSlide.it|pass=2400}}
Unlike fine volume slides in the effect column, fine volume slides in the volume column are only ever executed on the first tick — not on multiples of the first tick if there is a pattern delay. Thus, the left and right channel of this example should always have the same volume.

{{Testcase|format=it|name=flt-env-carry.it|pass=693 (?)}}
Envelope carry on the filter envelope. I think this is just a general test on how envelope carry is applied. It is possible that Impulse Tracker’s MMX drivers will play this in a different way from the WAV writer.

{{Testcase|format=it|name=fltmacro.it|pass=???}}
This test uses a custom macro configuration that uses the instrument volume to control the filter cutoff. A correctly implemented MIDI Macro system should pass this test.

{{Testcase|format=it|name=freqreset-noins.it|pass=325}}
When using multisample instruments, even notes with no instrument number next to them can change the sample (based on the active instrument’s sample map). When switching between samples, you must not forget to update the C-5 frequency of the playing sample as well.

{{Testcase|format=it|name=GlobalVolFirstTick.it|pass=6362}}
Set Global Volume (Vxx) should be applied on the first tick (and multiples in case of pattern delays). If played correctly, the first and second row of this module should sound more or less identical, i.e. each row should play 16 fading notes.

{{Testcase|format=it|name=globalvol-invalid.it|pass=290}}
Out-of-range global volume commands (V81...VFF) should not change the current global volume. This test module should remain completely silent.

{{Testcase|format=it|name=GlobalVolume-Macro.it}}
Global volume, channel volume and various other parameters are taken into account when interpreting the 'u' and 'v' letters in MIDI macros. However, this feature seems to be quirky, and I have decided not to support these quirks in OpenMPT, as I do not think that anyone used this feature in Impulse Tracker very much and I would want it to work in a sane way when using it to control instrument plugins in OpenMPT. The quirks are:
* Channel and global volume seem to be applied one row after they have been set. This does not seem to be the whole truth, though, as looking at pattern 0, row 9, you should hear that IT applies the M40 channel volume change on row 10.
* Instrument / sample volume also seems to be applied one row late when using the 'u' macro, but not the 'v' macro (compare first and second pattern, row 15 - 22 each).
There are also some problems with volume swing which might be fixed later.

{{Testcase|format=it|name=gxsmp.it|pass=1671}}
Another test case with an empty sample map slot which is simply ignored by Impulse Tracker.

{{Testcase|format=it|name=gxsmp2.it|pass=1671}}
Going one step further by also changing the sample next to that portamento.

{{Testcase|format=it|name=gxxtest.it|pass=4330}}
And another similar test.

{{Testcase|format=it|name=InitialNoteMemory.it|pass=18838}}
The initial "last note" memory of each channel in Impulse Tracker is initialized to C-0. So the first lone instrument number without any note next to it will play a C-0 of that instrument.

{{Testcase|format=it|name=InitialNoteMemoryInstrMode.it|pass=18838}}
A variation of [[#InitialNoteMemory.it|InitialNoteMemory.it]], but in instrument mode. The lowest note of instrument 1 has no sample association, which will also cause subsequent notes without instrument number to not play.

{{Testcase|format=it|name=ins-flt-porta-reset.it|pass=???}}
Instrument filter settings should not be applied if there is a portamento effect.

{{Testcase|format=it|name=ins-oc.it|pass=11293 + 22849}}
Instrument number resets envelope behaviour test with Old Effects enabled, Compatible Gxx enabled: Always reset envelopes.

Note: Some output drivers play the instruments with Envelope Carry enabled differently in Impulse Tracker (see [[#CarryNNA.it|CarryNNA.it]] for an explanation why this happens). A previous version of this test reflected the behaviour of those drivers, but technically for the wrong reason (they relied on a bug / misunderstanding of the Carry feature in OpenMPT). As this OpenMPT bug was fixed, the test case was adjusted to follow the WAV writer / SB16 MMX driver behaviour.

{{Testcase|format=it|name=ins-ox.it|pass=11293 + 22849}}
Instrument number resets envelope behaviour test with Old Effects enabled, Compatible Gxx disabled: Reset envelopes if there is no tone portamento.

Note: Some output drivers play the instruments with Envelope Carry enabled differently in Impulse Tracker (see [[#CarryNNA.it|CarryNNA.it]] for an explanation why this happens). A previous version of this test reflected the behaviour of those drivers, but technically for the wrong reason (they relied on a bug / misunderstanding of the Carry feature in OpenMPT). As this OpenMPT bug was fixed, the test case was adjusted to follow the WAV writer / SB16 MMX driver behaviour.

{{Testcase|format=it|name=ins-xc.it|pass=11293 + 22849}}
Instrument number resets envelope behaviour test with Old Effects disabled, Compatible Gxx enabled: Reset envelopes if there is a tone portamento.

Note: Some output drivers play the instruments with Envelope Carry enabled differently in Impulse Tracker (see [[#CarryNNA.it|CarryNNA.it]] for an explanation why this happens). A previous version of this test reflected the behaviour of those drivers, but technically for the wrong reason (they relied on a bug / misunderstanding of the Carry feature in OpenMPT). As this OpenMPT bug was fixed, the test case was adjusted to follow the WAV writer / SB16 MMX driver behaviour.

{{Testcase|format=it|name=ins-xx.it|pass=0}}
Instrument number resets envelope behaviour test with Old Effects disabled, Compatible Gxx disabled: Never reset envelopes.

{{Testcase|format=it|name=InstrAfterMultisamplePorta.it|pass=7465}}
A lone instrument number should only reset sample properties to those of the corresponding sample in instrument mode. Example:
C#5 01 ... <-- sample 1
C-5 .. g02 <-- sample 2
... 01 ... <-- still sample 1, but with properties of sample 2
In the above example, no sample change happens on the second row. In the third row, sample 1 keeps playing but with the volume and panning properties of sample 2.

{{Testcase|format=it|name=InstrumentNumberChange.it|pass=1902}}
While Impulse Tracker cuts playing samples if it encounters an invalid sample number in sample mode, the same does not happen if we are in instrument mode.

{{Testcase|format=it|name=JxxTicks.it|pass=1537}}
Impulse Tracker’s arpeggio logic is pretty sane compared to some other trackers, but one detail should be kept in mind: Pattern Delays reset the tick counter, but it keeps incrementing with Fine Pattern Delays. The arpeggio sequence thus resets every (ticks per row + fine pattern delay) ticks.

{{Testcase|format=it|name=LinearSlides.it|pass=4330}}
Impulse Tracker internally uses actual frequency values, while Fasttracker 2 still uses exponentially scaled fine Amiga periods. When doing fine slides, errors from using periods instead of frequency can add up very quickly, and thus the two channel's frequency in this test will converge noticeably.

{{Testcase|format=it|name=LoopBreak.it|pass=5413}}
A pattern break (Cxx) on the same row as the end of a pattern loop (SBx) repeats the pattern loop x times and then jumps to the desired row. However, a position jump (Bxx) on the same row as the end of a pattern loop prevents the loop from being executed if it is right of the SBx effect. In this test, the left and right channel of the module should produce the same click patterns.

{{Testcase|format=it|name=LoopStartAfterPatternEnd.it|pass=7791}}
Since the start row of a pattern loop is not reset on pattern transitions, it is possible to use a loop start past the end of the current pattern when using a pattern loop without explicit start command (SB0). In this case, playback should continue in the next pattern. In the example, this happens because the loop start is set to one row after the loop end after properly terminating the loop in pattern 0.

{{Testcase|format=it|name=LxxWith0Portamento-Amiga.it|pass=r22552}}
A strange edge case when using Lxx (Volume Slide + Tone Portamento) while the tone portamento effect memory is 0: The tone portamento comamnd is not initialized properly in this case, causing it always to assume that it's trying to execute a portamento down. If the current note is below the note to which the tone portamento would lead, this causes the note to immediately jump to the target note. If the current note is above the target note, nothing happens.

{{Testcase|format=it|name=LxxWith0Portamento-Linear.it|pass=r22552}}
Same as [[#LxxWith0Portamento-Amiga.it|LxxWith0Portamento-Amiga.it]], but with linear slides. The difference is that when the current note is above the target note, the frequency is decremented by 1 Hz on every tick (linear slides always slide by at least 1 Hz).

{{Testcase|format=it|name=macro-lastnote.it|pass=947 (?)}}
A test of the MIDI macro letter “n”. This letter will always send the MIDI note value of the last triggered note, note cuts and similar “notes” are not considered. This module should remain silent as both channels should receive exactly the same cutoff values.

{{Testcase|format=it|name=MacroExtendedParam.it|pass=16715}}
Even fixed macros (Z80-ZFF) can contain the letter “z”, which inserts the raw command parameter into the macro (i.e. a value in [80, FF[). In this file, macro ZF0 is used to insert byte F0 into the string. This way, two MIDI messages to set both the filter cutoff and resonance to 60h are created, which are the same filter settings as used in instrument 2, so the module should stay silent.

{{Testcase|format=it|name=MultiZxx.it|pass=947 (?)}}
A MIDI macro can contain more than one MIDI message. In this case, the Z90 macro sets both the filter cutoff frequency and resonance, so if only the first MIDI message is considered in this macro, the module will no longer stay silent at row 8.

{{Testcase|format=it|name=NoMap.it|pass=1671}}
Yet another sample map test case. Why are there so many of them? They are all fixed by the same code...

{{Testcase|format=it|name=NoMapEffects.it|pass=20790 + 20820}}
Empty instrument note map slots are truly one of the most mysterious parts of Impulse Tracker’s reply routines. This particular test started out to verify that a currently playing instrument’s envelopes are not reset by sample-less note map slots, but it quickly evolved into a complete nightmare. In this test you see many global effects, and not a single one of them does anything. They do not jump around in the pattern, they do not modify the tempo. Anything in a cell where a sample-less note map slot is hit is ignored completely. This also affects the first row of the module due to [[#InitialNoteMemory.it|InitialNoteMemory.it]] - this mechanism also takes previously triggered notes into account. Only on row 3 it does not apply, because Note Off / Note Cut / Note Fade invalidate the previously triggered note.

All in all, this absolutely crazy test case should play identically on the left and right channel.

{{Testcase|format=it|name=NoSlide.it|pass=???}}
This seems to be just a fancy test of portamento from a stopped note, but in this case an empty sample slot assigned to the same instrument was played before.

{{Testcase|format=it|name=NoteFade-SmpMode.it|pass=317}}
A “note fade” note (any invalid note) should not do anything in sample mode. The sample should not be stopped.

{{Testcase|format=it|name=NoteFade-InsMode.it|pass=317}}
A “note fade” note (any invalid note) should fade out the instrument using its fadeout value.

{{Testcase|format=it|name=noteoff2.it|pass=??? + 5829}}
The sample changes on rows 4 and 20, but not on rows 8 and 24. However, the new sample′s default volume is loaded.

{{Testcase|format=it|name=noteoff3.it|pass=12284}}
This is the same as noteoff2.it, but with old effects enabled. In this case, the sample should never fade out.

{{Testcase|format=it|name=NoteOffInstr.it|pass=5829}}
Any kind of Note Cut (SCx or ^^^) should stop the sample and not set its volume to 0. A subsequent volume command cannot continue the sample, but a note, even without an instrument number can do so. When played back correctly, the module should stay silent.

{{Testcase|format=it|name=Off-Porta.it|pass=1344}}
When "Compatible Gxx" is disabled, the key-off flag should only be removed when triggering new notes, but not when continuing a note using a portamento command.

{{Testcase|format=it|name=Off-Porta-CompatGxx.it|pass=0 (temporarily broken in rev. 1344)}}
When "Compatible Gxx" is enabled, the key-off flag should also be removed when continuing a note using a portamento command (row 2, 4, 6). This test case was written to discover a code regression when fixing [[#Off-Porta.it|Off-Porta.it]]).

{{Testcase|format=it|name=OffsetWithInstr.it|pass=20863}}
An offset effect can be triggered if only an instrument number and no note is next to it, if the last triggered note was not a note cut, note off or note fade.

{{Testcase|format=it|name=PanbrelloHold.it|pass=4712}}
The panbrello offset should not only be added on the same row as the panbrello effect appears on, but also on all follow-up rows, until a panning command or a new note is encountered. This test case should remain mostly silent.

{{Testcase|format=it|name=PanReset.it|pass=4713}}
Contrary to XM, the default instrument and sample panning should only be reset when a '''note''' is encountered, not when an '''instrument number''' (without note) is encountered. The two channels of this module should be panned identically.

{{Testcase|format=it|name=PanResetInstr.it|pass=11856}}
Instruments and samples with a defined panning should not override the channel panning for following notes. That is, if a different instrument with no panning set follows an instrument that has panning set, the first instrument’s panning should not be applied to the second instrument, but rather the channel panning as it was set before playing the first instrument (or if the channel panning was changed while that instrument was playing, the new channel panning applies as well).
If played correctly, this test case should remain silent.

{{Testcase|format=it|name=PatternDelay-NoteDelay.it|pass=1240}}
Delayed notes (using SDx) that are on the same row as a Row Delay effect are retriggered on every repetition. Notes ''without'' a note delay are ''not'' retriggered.

{{Testcase|format=it|name=PatternDelays.it|pass=1224}}
Tick delays (S6x) are added up, but when there are multiple row delays (SEx), only the first one is considered. The tricky part here is that Impulse Tracker even ignores all row delays next to a SE0 row delay. I suggest to do the following:
* Initialize a <tt>row delay</tt> variable with <tt>0</tt>.
* Go through all channels. If there is a row delay on the current row and <tt>row delay</tt> is 0, set <tt>row delay = parameter + 1</tt>.
* Calculate the complete row length: <tt>row length = (speed + tick delay) * max(1, row delay)</tt>

{{Testcase|format=it|name=PatternDelaysRetrig.it|pass=1221}}
Rows on which a row delay (SEx) effect is placed have multiple “first ticks”, i.e. you should set your “first tick flag” on every tick that is a multiple of <tt>speed + tick delay</tt>. In this test module, the note pitch is changed multiple times per row, depending on the row and tick delay values.
 Note: This test case broke in r3520 and was fixed again in r4895.

{{Testcase|format=it|name=PitchPanReset.it|pass=15870}}
Pitch/Pan Separation can be overriden by panning commands, and should not be affected by Note Off or Note Fade notes.

{{Testcase|format=it|name=PortaCutCompat.it|pass=9139}}
A follow-up test to [[#PortaSampleCompat.it|PortaSampleCompat.it]] and [[#PortaInsNumCompat.it|PortaInsNumCompat.it]] to verify that the behaviour described in these tests is not used when currently no note is playing. Both channels should sound identical.

{{Testcase|format=it|name=PortaInsNum.it|pass=1671}}
Portamento with funny sample maps. Without compatible Gxx, portamento between different samples should play the new sample.

{{Testcase|format=it|name=PortaInsNumCompat.it|pass=2842}}
Portamento with funny sample maps, in compatible Gxx mode. With compatible Gxx, portamento between different samples should keep playing the old sample.

{{Testcase|format=it|name=PortaJustStoppedNote.it|pass=6193}}
[[#Fade-Porta.it|Fade-Porta.it]] already tests the general case of portamento picking up a stopped note (portamento should just be ignored in this case), but there is an edge case when the note just stopped on the previous tick. In this case, OpenMPT did previously behave differently and still execute the portamento effect.

{{Testcase|format=it|name=porta-offset.it|pass=0}}
Unlike Fasttracker 2, Impulse Tracker does not ignore offset commands next to portamentos and executes them both. Even ModPlug Tracker 1.16 gets this test right.

{{Testcase|format=it|name=PortaReset.it|pass=4181}}
Impulse Tracker completely resets the tone portamento target on every new non-portamento note, i.e. a follow-up Gxx effect should not slide back to the previously triggered note.

{{Testcase|format=it|name=PortaResetAfterRetrigger.it|pass=7465}}
After a note has stopped playing, a lone instrument number can restart the note. In this case, portamento and other properties should be reset.

{{Testcase|format=it|name=PortaSample.it|pass=1671}}
Impulse Tracker executes the portamento when switching to instrument two on the second row when compatible Gxx is disabled.

{{Testcase|format=it|name=PortaSampleCompat.it|pass=2842}}
Impulse Tracker executes the portamento and doesn't switch to the new sample on the second row when compatible Gxx is enabled.

{{Testcase|format=it|name=RandomPan.it|pass=2545}}
Pan swing should not be overridden by effects such as instrument panning or panning envelopes. Previously, pan swing was overridden in OpenMPT if the instrument also had a panning envelope. In this file, pan swing should be applied to every note.

{{Testcase|format=it|name=RandomWaveform.it|pass=3670}}
When selecting the random waveform for panbrello, the “speed” nibble indicates for how many ticks the random value will be held. This behaviour is ''not'' used for vibrato / tremolo.

{{Testcase|format=it|name=ResetEnvNoteOffOldFx.it|pass=11276 - 11283}}
In Old Effects mode, an instrument number next to a note-off does not just recall the default volume and panning, but also resets the envelopes.

If the instrument is different from the currently playing instrument, the new instrument's envelope and default sample settings (default volume, panning, but not global volume) are loaded, but the old sample waveform keeps playing.

When played correctly, the left and right audio channel should sound identical. On the last note, the tracker channels swap their stereo position.

{{Testcase|format=it|name=ResetEnvNoteOffOldFx2.it|pass=11284}}
An extension of ResetEnvNoteOffOldFx.it which also tests instrument note-off and sample sustain loop behaviour: While the sample sustain loop should be released, the instrument should not be faded out.

{{Testcase|format=it|name=retrig.it|pass=364}}
A combination of the retrigger effect and instrument envelopes. Not sure how this works.

{{Testcase|format=it|name=retrig-short.it|pass=1140}}
Impulse Tracker does not retrigger notes that are shorter than the duration of a tick. One might argue that this is a bug in Impulse Tracker, but OpenMPT emulates it anyway.

{{Testcase|format=it|name=s7xinsnum.it|pass=1062}}
Changing the NNA action through the S7x command only affects the current note - The NNA action is reset on every ''note change'', and not on every ''instrument change''.

{{Testcase|format=it|name=s77.it|pass=561 (preliminary), 1112}}
The S77 / S79 / S7B commands pause the instrument envelopes, they do not turn them off. S78 / S7A / S7C should resume the envelope at exactly the position where it was paused. In this test, it is again very important that the envelope position is incremented ''before'' the point is evaluated, not ''afterwards'' (see [[#EnvLoops.it|EnvLoops.it]]).

{{Testcase|format=it|name=S7B_StillAppliesFilter.it|pass=24090}}
Even when the filter envelope is turned off before its first tick is even processed through command S7B, the filter should still be applied. In this case, a filter cutoff equivalent to the midway envelope value is applied.

{{Testcase|format=it|name=SampleNumberChange.it|pass=0}}
Contrary to [[#InstrumentNumberChange.it|InstrumentNumberChange.it]], even ModPlug Tracker 1.16 passes it.

{{Testcase|format=it|name=SampleSustainAfterPorta.it|pass=20760}}
When a sample’s sustain loop was released, and a new note from a different sample is played with tone portamento applied, the second sample’s sustain loop also stays released.

{{Testcase|format=it|name=SampleSustainAfterPortaCompatGxx.it|pass=20760}}
Same as [[#SampleSustainAfterPorta.it|SampleSustainAfterPorta.it]], but with Compatible Gxx turned on.

{{Testcase|format=it|name=SampleSustainAfterPortaInstrMode.it|pass=20760}}
Same as [[#SampleSustainAfterPorta.it|SampleSustainAfterPorta.it]], but in instrument mode. Here a difference in the behaviour can be observed when doing a second switch after the initial note-off: The first time, the sustain loop remains disabled, but for the subsequent note, the sustain loop is used again. This does not happen in sample mode.

{{Testcase|format=it|name=sbx-priority.it|pass=12171}}
This is an extension of [[#LoopBreak.it|LoopBreak.it]]. A position jump (Bxx) on the same row as the end of a pattern loop prevents the loop from being executed if it is right of the SBx effect, but if the position jump is left of the SBx effect, the loop should be prioritized. In this test, the left and right channel of the module should produce the same beep patterns.

{{Testcase|format=it|name=scx.it|pass=1109}}
The SCx command cuts notes just like a normal note cut (^^^), it does not simply mute them. However, there is a difference when placing a lone instrument number after a note that was cut with SCx and one cut with ^^^, as it can be seen in this test case.

{{Testcase|format=it|name=SCx-Reset.it|pass=23476}}
When a lone instrument number after a SCx command picks up the previous note, it resets its pitch to the original note, undoing any portamento effects - the same as if there was a note next to the instrument number.

If there is a note and a tone portamento next to an SCx command, the Note Cut is not executed - unless there is also a row delay effect and we are on the second repetition of the row.

When played correctly, this test should remain silent.

{{Testcase|format=it|name=SlideDelay.it|pass=3520}}
If there's a note delay, slide and vibrato commands in the volume column next to it should not start before the delay has finished.
So if there's a fine volume slide next to a SD5 effect should start on the 6th (one-based) tick. If this was a normal volume or pitch slide and the speed was 6 ticks per row, it would never execute, as the first non-zero tick would be the seventh tick.

{{Testcase|format=it|name=SmpInsPanSurround.it|pass=1259}}
Sample and instrument panning override the channel surround status, i.e. surround is turned off by samples or instruments with panning enabled.

{{Testcase|format=it|name=surround-pan.it|pass=1134}}
Pan swing, panbrello, panning envelopes, etc. should have no effect on surround channels.

{{Testcase|format=it|name=StoppedInstrSwap.it|pass=5829}}
An instrument number with no note or next to a ^^^ should always be remembered for the next instrument-less note, even if sample playback is stopped.

{{Testcase|format=it|name=SusAfterLoop.it|pass=1085}}
When a sample sustain loop, which is placed partly or completely behind a “normal” sample loop is exited (through a note-off event), and the current sample playback position is past the normal loop’s end, it is adjusted to <tt>loop start + ((current position - loop start) % loop length)</tt>.

{{Testcase|format=it|name=SwapNNA.it|pass=10239}}
Related to [[#s7xinsnum.it|s7xinsnum.it]], the NNA action should be reset when doing an instrument swap with portamento.

{{Testcase|format=it|name=swaptest.it|pass=???}}
A test focussing on finding the correct sample playback position when switching samples “on the fly” (using instrument numbers without notes next to them). The module should remain silent when being played.

{{Testcase|format=it|name=swing1.it|pass=1046 (?)}}
Probably a very MPT-specific bug, as OpenMPT was adding the volume swing to the current volume, so even after setting the volume to 0, it was possible that you could hear the sample playing.

{{Testcase|format=it|name=swing2.it|pass=1046 (?)}}
This module should remain completely silent, as the random variation is multiplied with the sample volume.

{{Testcase|format=it|name=swing3.it|pass=1046 (?)}}
Of course you are not supposed to produce the same sequence of random number to fulfil this test case. I think this was just a test to explore which volume variables are actually affected by volume swing, and how it is applied.

{{Testcase|format=it|name=swing4.it|pass=1046 (?)}}
Same as above.

{{Testcase|format=it|name=swing5.it|pass=1046 (?)}}
Same as above.

{{Testcase|format=it|name=tickdelay.it|pass=4948}}
This test detects whether out-of-range note delays are handled properly. If the SDx parameter is greater than the row length (''including'' tick delay, but ''excluding'' row delay), any note and volume effects next to it are supposed to ignored (interestingly, the instrument number is saved, but not instantly used). The first two rows test tick delay behaviour (OpenMPT passes this test since revision 1306), the third row tests row delay behaviour.

{{Testcase|format=it|name=tremolo.it|pass=345 (?)}}
A test for checking if tremolo tables are implemented correctly.

{{Testcase|format=it|name=vibrato.it|pass=1189}}
A test for checking if vibrato tables are implemented correctly when old FX are disabled.

{{Testcase|format=it|name=VibratoDouble.it|pass=7804}}
Vibrato in the volume column should be applied separately from vibrato in the effect column. The two commands will add up when occuring at the same time. However, since there is only one vibrato effect memory for both commands, the volume column’s vibrato parameter has precedence if it is not 0.

{{Testcase|format=it|name=vibrato-oldfx.it|pass=1189}}
A test for checking if vibrato tables are implemented correctly when old FX are enabled. Vibrato is played backwards in this mode!

{{Testcase|format=it|name=VibratoSweep0.it|pass=7134}}
Auto-vibrato should not be processed at all if the rate (speed) is 0. This is relevant for vibrato waveforms that do not start at zero, i.e. all except sine.

{{Testcase|format=it|name=VolColMemory.it|pass=1545}}
Volume column commands a, b, c and d (volume slide) share one effect memory, but it should not be shared with Dxy in the effect column. Furthermore, there is '''no''' unified effect memory across different kinds of volume column effects (that's how OpenMPT used to handle it up to revision 1544).

{{Testcase|format=it|name=VolColNoSlideMemoryPropagation.it|pass=23742}}
An extension of [[#VolColMemory.it|VolColMemory.it]]. While that test case verifies that regular Dxy volume slides do not propagate their effect memory to the volume column, it fails to verify the other way around. This test case rectifies that, also checking that volume column commands a, b, c and d do not update the Dxy effect memory.

{{Testcase|format=it|name=vol-env-carry.it|pass=1781}}
Similar to [[#flt-env-carry.it|flt-env-carry.it]]. This test case temporarily broke in revision 1481 and was fixed in revision 1781.

{{Testcase|format=it|name=Volume-Macro-Letters.it|pass=1465}}
This test demonstrates how Zxx macros are parsed in Impulse Tracker:
* Macros are evaluated only on the first tick.
* They appear to be parsed after note / instrument information has been read from the pattern, but before any other effects (excluding "Set Volume").
* 'u' and 'v' macros seem to emit at least a value of 1, not 0 - v00 corresponds to Z01.
I am not quite sure why the first row with notes on it emits a filter value of 1, and I am not even completely sure why OpenMPT gets this right.
If interpreted correctly, the module should stay silent (minus slight filter artefacts, of course - but they should be nearly inaudible).

{{Testcase|format=it|name=weirdloop.it|pass=0}}
A nice broken pattern loop. The voice should say “1 4 2 1 4 2” and then repeat forever “3 4 2”. Theoretically, this would even work in ModPlug Tracker 1.16, if it did not reset the Cxx target on song loop.

{{Testcase|format=it|name=ZxxSecrets.it|pass=9855}}
Impulse Tracker supports three MIDI macro characters which are not documented in MIDI.TXT:
* <tt>h</tt>: Host channel, i.e. the pattern channel in which the Zxx command is encountered (0-based).
* <tt>o</tt>: The last used sample offset value. The high offset (SAx) is not taken into account. Note that offsets above 80h are not clamped, i.e. they generate MIDI command bytes (e.g. O90 would cause a note-on command to be emitted).
* <tt>m</tt>: This command sends the current MIDI note if the channel is a MIDI channel, but on sample channels the current loop direction (forward = 0, backward = 1) of the sample is stored in the same memory location, so the macro evaluates to that instead of a note number.

In addition, the MIDI messages FA (start song), FC (stop song) and FF (reset) reset the resonant filter parameters (cutoff = 127, resonance = 0) for all channels, but do not immediately update the filter coefficients.

{{Testcase Summary}}

[[Category:Development|Test Cases/IT]]
[[Category:IT Format|Test Cases]]

Development: Foreign Bugs

2025-08-23T16:06:37Z

Saga Musix:

== Foreign Bugs ==

This page intends to track bugs in other projects that affect OpenMPT and libopenmpt in some way or another.

{| class="wikitable sortable"
|+ List of bug reports
|-
! Project !! Status !! affects !! Description !! Link
|-
| Wine || open || OpenMPT || winepath changes behaviour and strips ending path separator now || https://bugs.winehq.org/show_bug.cgi?id=58615
|-
| GCC || open || libopenmpt || x86: Inefficient code generation with -m3dnow -msse since GCC 12 || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=121230
|-
| cross-platform-actions || open / work-around 2025-07-05 || libopenmpt || wrong file permissions on Haiku || https://github.com/cross-platform-actions/action/issues/108
|-
| GCC || open || libopenmpt || false-positive Wmaybe-uninitialized in std::optional::reset() || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=121173
|-
| GCC || open || libopenmpt || false positive Warray-bounds while building openmpt with -O3 -fsanitize=undefined / missed optimization with ubsan at -O3 due to phiprop not working with UBSAN_NULL || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=121165 / https://gcc.gnu.org/bugzilla/show_bug.cgi?id=121168
|-
| GCC || open || libopenmpt || analyzer support for C++ new expression || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94355
|-
| cross-platform-actions || open / work-around 2025-07-05 || libopenmpt || Runner to VM file sync doesn't work for Haiku || https://github.com/cross-platform-actions/action/issues/104
|-
| cross-platform-actions || open / work-around 2025-07-05 || libopenmpt || Installing (some) packages on Haiku requires reboot || https://github.com/cross-platform-actions/action/issues/103
|-
| FLAC || open || OpenMPT/openmpt123 || max thread count is not directly settable or queryable || https://github.com/xiph/flac/issues/823
|-
| MSVC || open || OpenMPT/libopenmpt || Iterator Debugging breaks C++20 constexpr containers || https://developercommunity.visualstudio.com/t/Iterator-Debugging-breaks-C20-constexp/10861623 / https://github.com/microsoft/STL/issues/4427
|-
| stb_vorbis || open || libopenmpt || stb_vorbis: 1404:75: warning: pointer comparison always evaluates to false [-Wtautological-compare] || https://github.com/nothings/stb/issues/1745
|-
| GCC || open || libopenmpt || std::filesystem::remove_all() hangs on Windows on directories containing a deep tree with long paths || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=118003
|-
| minimp3 || open || libopenmpt || Change extern "C" block to include all API declarations, including structure definitions, instead of just function declarations. || https://github.com/lieff/minimp3/pull/127
|-
| minimp3 || open || libopenmpt || Fix function signature of have_simd. || https://github.com/lieff/minimp3/pull/126
|-
| minimp3 || open || libopenmpt || Support for MP3 files < MAX_FRAME_SYNC_MATCHES || https://github.com/lieff/minimp3/pull/125
|-
| minimp3 || open || libopenmpt || Reduce stack usage to help usage on embedded systems || https://github.com/lieff/minimp3/pull/117
|-
| minimp3 || open || libopenmpt || Don't enable ARMv6 features for ARMv6-m || https://github.com/lieff/minimp3/pull/97
|-
| minimp3 || open || libopenmpt || Eliminated warnings in Visual Studio 2019. || https://github.com/lieff/minimp3/pull/96
|-
| afl++ || open || OpenMPT/libopenmpt || Fuzzing process freezes completely || https://github.com/AFLplusplus/AFLplusplus/issues/2127
|-
| GitHub || open || libopenmpt || git config safe.directory inside docker containers || https://github.com/actions/runner/issues/2033
|-
| emscripten || open || libopenmpt || Closure has warnings with wasm2js || https://github.com/emscripten-core/emscripten/issues/17080
|-
| vorbis || open || OpenMPT/libopenmpt || misleading-indentation warning in lib/block.c || https://gitlab.xiph.org/xiph/vorbis/-/issues/2349
|-
| vorbis || open || OpenMPT/libopenmpt || strict-prototypes warning in lib/vorbisfile.c || https://gitlab.xiph.org/xiph/vorbis/-/issues/2350
|-
| C++ || open || OpenMPT/libopenmpt || lexically_relative on UNC drive paths (\\?\C:\...) results in a default-constructed value || https://cplusplus.github.io/LWG/issue3699
|-
| GitHub || open || libopenmpt || Can we suppress 'Run cancelled' notifications? || https://github.com/orgs/community/discussions/13015
|-
| GCC (Debian) || open || libopenmpt || i686-w64-mingw32-gcc reports wrong version in __GNUC__ __GNUC_MINOR__ __GNUC_PATCHLEVEL__ || https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1028580
|-
| LLVM || open || libopenmpt || -march=i386 should not generate bswap instruction || https://github.com/llvm/llvm-project/issues/58470
|-
| glibc || open || libopenmpt || stdio wide character output conversion appears to enter confused state after setlocale || https://sourceware.org/bugzilla/show_bug.cgi?id=29510
|-
| GCC || open || libopenmpt || [12/13 Regression] bogus "may overlap" memcpy warning with std::string and operator+ at -O3 / [12/13 Regression] Bogus restrict warning when assigning 1-char string literal to std::string since r12-3347-g8af8abfbbace49e6 / std::string::replace uses memcpy incorrectly and warns about it / [12/13/14/15 regression] -Wrestrict false positive creating std::string from iterators || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105651 https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105329 https://gcc.gnu.org/bugzilla/show_bug.cgi?id=116494 https://gcc.gnu.org/bugzilla/show_bug.cgi?id=114385
|-
| Wine || open || OpenMPT || Wine should provide icu.dll || https://bugs.winehq.org/show_bug.cgi?id=53354
|-
| Wine || open || OpenMPT || Missing functions SystemTimeToTzSpecificLocalTimeEx and TzSpecificLocalTimeToSystemTimeEx || https://bugs.winehq.org/show_bug.cgi?id=53355
|-
| QEMU (Debian) || open || libopenmpt || qemu-user-static: lli-13/arm64 causes segfault on amd64 host || https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=999421
|-
| MSVC || open || OpenMPT/libopenmpt || <filesystem>: weakly_canonical fails for UNC path with \\?\UNC prefix || https://github.com/microsoft/STL/issues/2823
|-
| emscripten || open || libopenmpt || emscripten with AudioWorklets: performance.now and crypto || https://github.com/emscripten-core/emscripten/issues/13224
|-
| mingw-std-threads || open || libopenmpt || Trouble compiling with gcc 11.1 || https://github.com/meganz/mingw-std-threads/issues/79
|-
| GCC || open || libopenmpt || `extern "C" int t = 1;` warns about being declared as extern and initialized "warning: 'i' initialized and declared 'extern'" could use a separate warning flag controlling it https://gcc.gnu.org/bugzilla/show_bug.cgi?id=108013 || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=45977 https://gcc.gnu.org/bugzilla/show_bug.cgi?id=108013
|-
| MSVC || open || OpenMPT/libopenmpt || std::chrono::get_tzdb_list() memory leak || https://github.com/microsoft/STL/issues/2504 https://developercommunity.visualstudio.com/t/stdchronoget-tzdb-list-memory-leak/1644641
|-
| MSVC || open || OpenMPT/libopenmpt || <chrono>: Implement fallback mechanism for chrono's [time.zone] || https://github.com/microsoft/STL/issues/1911
|-
| MSVC || open || OpenMPT/libopenmpt || <chrono>: Cannot parse "23:59:59" as system_clock::time_point on older Windows versions || https://github.com/microsoft/STL/issues/2163
|-
| zlib/minizip || open || OpenMPT || Add a null check in case ALLOC fails. || https://github.com/madler/zlib/pull/566
|-
| emscripten || open || libopenmpt || function signature mismatch with thinLTO and iostreams since 3.0.0 || https://github.com/emscripten-core/emscripten/issues/15638
|-
| GCC || open || libopenmpt || Bogus shift-negative-value warning in C++20 mode || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=103826
|-
| --- || --- || --- || --- || ---
|-
| FLAC || pending 2025-06-13 (1.5.1) || OpenMPT/openmpt123 || Add C11 threads.h implementation in addition to pthread implementation for multithreaded encoding. || https://github.com/xiph/flac/pull/822
|-
| nlohmann-json || pending || OpenMPT || Build issue with std::optional || https://github.com/nlohmann/json/issues/4740 https://github.com/nlohmann/json/pull/4742
|-
| Autoconf || pending 2024-05-28 (2.73) || libopenmpt || revert forcing/setting -std=gnu++11 by default (introduced in Autoconf 2.70) || https://savannah.gnu.org/support/index.php?110879 https://savannah.gnu.org/support/index.php?110286 https://git.savannah.gnu.org/cgit/autoconf.git/commit/?id=056518b94ecd487bcbefdb69046b3f52c4168222 https://bugs.openmpt.org/view.php?id=1701
|-
| --- || --- || --- || --- || ---
|-
| MSVC || ignored 2023-02-21 || OpenMPT || no Release Notes for Windows 11 SDK 10.0.22621.0 || https://developercommunity.visualstudio.com/t/no-Release-Notes-for-Windows-11-SDK-100/10061520
|-
| MSVC || wontfix 2023-07-07 || OpenMPT/libopenmpt || <filesystem> long path support || https://github.com/MicrosoftDocs/cpp-docs/issues/3138
|-
| MSVC (VS2019-VS2022) || wontfix 2023-04-04 || OpenMPT/libopenmpt || XP toolset uses non-XP compatible libraries || https://developercommunity.visualstudio.com/t/xp-toolset-uses-non-xp-compatible-libraries/1620439
|-
| MSVC || ignored 2021-12-20 || OpenMPT/libopenmpt || BSOD when single-stepping over `popfd` instruction on *some* Windows 10 installs || https://developercommunity.visualstudio.com/t/BSOD-when-single-stepping-over-popfd-i/1617674 https://github.com/x64dbg/x64dbg/issues/2603
|-
| MSVC || wontfix 2021-05-18 || OpenMPT/libopenmpt || <filesystem>: Does it naturally support all functions with a long path (>260) on Windows? || https://github.com/microsoft/STL/issues/1921
|-
| MSVC (VS2019-VS2022) || wontfix || OpenMPT/libopenmpt || XP toolset doesn't target XP properly || https://developercommunity2.visualstudio.com/t/XP-toolset-doesnt-target-XP-properly/1586002
|-
| MSVC (VS2017) || wontfix || OpenMPT || Static inline variable gets destroyed multiple times in Debug mode || https://developercommunity.visualstudio.com/t/Static-inline-variable-gets-destroyed-mu/297876
|-
| emscripten || wontfix || libopenmpt || Single precision floating point issues || https://github.com/emscripten-core/emscripten/issues/4251
|-
| GCC || wontfix || OpenMPT/libopenmpt || std::fstream ctr and open member functions fail to compile with argument of custom type convertible to std::filesystem::path || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=95642 https://gcc.gnu.org/bugzilla/show_bug.cgi?id=90704
|-
| --- || --- || --- || --- || ---
|-
| MSYS2 || fixed 2025-08-20 || libopenmpt || help2man fails to load gettext.dll || https://github.com/msys2/MSYS2-packages/issues/5579
|-
| GCC || fixed 2025-04-25 (15.1), fixed 2024-08-01 (14.2), fixed 2025-06-05 (13.4), fixed 2025-07-11 (GCC 12.5) || OpenMPT/libopenmpt || Silent severe miscompilation around inline functions || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=115049
|-
| DJGPP || fixed 2025-04-01 || libopenmpt || dxegen: unresolved symbol `___libemu_ident_string' || https://github.com/jwt27/build-gcc/issues/46
|-
| cross-platform-actions || fixed 2025-03-17 || libopenmpt || FreeBSD 13.5 || https://github.com/cross-platform-actions/action/issues/99
|-
| NetBSD pkgsrc || fixed 2024-12-10 || libopenmpt || pkg subversion missing for NetBSD 9.4 amd64 || https://gnats.netbsd.org/cgi-bin/query-pr-single.pl?number=58432
|-
| mpg123 || fixed 2024-10-28 (mpg123 1.32.9) || OpenMPT/libopenmpt || weird warning when building against ARM64EC UCRT || https://sourceforge.net/p/mpg123/bugs/373/
|-
| autoconf-archive || fixed 2024-10-16 || libopenmpt || Revert broken part of commit 5b0d43b767bf3f800f97892905b6d1ba50150f1a || https://github.com/autoconf-archive/autoconf-archive/pull/307
|-
| autoconf-archive || fixed 2024-10-16 || libopenmpt || AX_CXX_COMPILE_STDCXX C++23 changes || https://github.com/autoconf-archive/autoconf-archive/pull/300
|-
| AppVeyor || fixed 2024-09-04 || OpenMPT || Windows 11 SDK 10.0.26100.0 in VS2022 image || https://github.com/appveyor/ci/issues/3929
|-
| build-gcc || fixed 2024-08-17 || libopenmpt || building GDB 8.2.1 fails with GCC 14 || https://github.com/jwt27/build-gcc/issues/43
|-
| mpg123 || fixed 2024-08-07 (1.32.7) || OpenMPT/libopenmpt || warning in readers.c with debugging enabled || https://sourceforge.net/p/mpg123/bugs/371/
|-
| ancient || fixed 2024-07-23 || OpenMPT || Possible speed improvement for PMC files || https://github.com/temisu/ancient/issues/78
|-
| GCC || fixed 2024-07-19 (GCC 11.5) || libopenmpt || (Wfree-nonheap-object) - invalid/missing -Wfree-nonheap-object warnings || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=99098
|-
| ancient || fixed 2024-07-15 || OpenMPT || Fix dereferencing of end iterator in PPMQ decompressor || https://github.com/temisu/ancient/pull/77
|-
| cross-platform-actions || fixed 2024-07-11 (0.25.0) || libopempt || FreeBSD 14.1 || https://github.com/cross-platform-actions/action/issues/87
|-
| Linux || fixed 2024-06-31 (6.9.6) || libopenmpt || Crash during early boot || https://lore.kernel.org/linux-kernel/ebb0791c-60a5-4fe3-bc85-4921ad026605@heusipp.de/T/#u https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1071378
|-
| ancient || fixed 2024-06-29 || OpenMPT || Pack-Ice support || https://github.com/temisu/ancient/issues/72
|-
| ancient || fixed 2024-06-07 (ancient 2.2.0) || OpenMPT || Some more slow PX20 cases || https://github.com/temisu/ancient/pull/70
|-
| ancient || fixed 2024-06-05 (ancient 2.2.0) || OpenMPT || Don't rely on implementation-defined behaviour of std::realloc(0) || https://github.com/temisu/ancient/pull/69
|-
| MSVC || fixed 2024-05-21 (VS2022 17.10.0 / LLVM 14) || OpenMPT/libopenmpt || lots of lld-link warnings about PDB with VS2022 17.1.0 and Clang-cl 13 || https://developercommunity.visualstudio.com/t/lots-of-lld-link-warnings-about-PDB-with/1667797 https://github.com/llvm/llvm-project/issues/54487
|-
| DJGPP || fixed 2024-04-12 || libopenmpt || "Improve documentation of '__djgpp_map_physical_memory'." breaks build || https://www.delorie.com/djgpp/mail-archives/browse.cgi?p=djgpp/2024/04/11/03:39:41
|-
| Cirrus-CI || fixed 2024-03-04 || libopenmpt || FreeBSD 13.2 VM fails to start || https://github.com/cirruslabs/cirrus-ci-docs/issues/1265
|-
| cross-platform-actions || work-around 2024-02-18 (0.23.0) || libopenmpt || OpenBSD is flaky with QEMU on macOS || https://github.com/cross-platform-actions/action/issues/80
|-
| cross-platform-actions || work-around 2024-02-18 (0.23.0) || libopenmpt || spurious failures with OpenBSD 7.4 on xhyve || https://github.com/cross-platform-actions/action/issues/77
|-
| cross-platform-actions || fixed 2024-02-18 (0.23.0) || libopenmpt || OpenBSD VM fails during "Initializing VM" with QEMU on macOS || https://github.com/cross-platform-actions/action/issues/73
|-
| MSVC || fixed 2024-02-13 (VS2022 17.9) || OpenMPT/libopenmpt || v143 14.37 istringstream incorrectly converts numbers with exponents with leading zeroes due to change in xlocnum header || https://developercommunity.visualstudio.com/t/v143-1437-istringstream-incorrectly-con/10450662
|-
| cross-platform-actions || fixed 2023-12-27 (0.22.0) / work-around || libopenmpt || Very frequent freezing of FreeBSD VM during teardown || https://github.com/cross-platform-actions/action/issues/61
|-
| emscripten || fixed 2023-12-13 (3.1.51) || libopenmpt || RangeError: Maximum call stack size exceeded when building libopenmpt test suite with -s WASM=2 || https://github.com/emscripten-core/emscripten/issues/17897
|-
| emscripten || fixed 2023-12-13 (3.1.51) / work-around || libopenmpt || -s WASM=0 -s LEGACY_VM_SUPPORT=1 results in JSC_CONSTANT_REASSIGNED_VALUE_ERROR warning during linking || https://github.com/emscripten-core/emscripten/issues/20810
|-
| emscripten || fixed 2023-12-01 (3.1.51) || libopenmpt || bogus warning 'Output contains some very large functions' || https://github.com/emscripten-core/emscripten/issues/20811
|-
| MSVC || fixed 2023-11-14 (VS2022 17.8) || OpenMPT/libopenmpt || ICE when compiling for ARM64 due to alignment confusion ("operand 2: Memory offset must be aligned") || https://developercommunity.visualstudio.com/t/ICE-when-compiling-for-ARM64-due-to-alig/10367205
|-
| Homebrew || fixed 2023-10-10 || libopenmpt || mpg123 1.32.3 || https://github.com/Homebrew/homebrew-core/pull/146321
|-
| cross-platform-actions || fixed 2023-10-07 || libopenmpt || NetBSD - VM doesn't start after a 120s timeout || https://github.com/cross-platform-actions/action/issues/62
|-
| Crypto++ || fixed 2023-10-02 || OpenMPT || CRYPTOPP_DISABLE_ASM is broken in 8.9.0 for MSVC x64 builds || https://github.com/weidai11/cryptopp/issues/1240
|-
| LLVM || fixed 2023-09-19 (LLVM 17.0.1) || OpenMPT/libopenmpt || clang-format 14 is extremely slow || https://github.com/llvm/llvm-project/issues/57117
|-
| zlib || fixed 2023-08-18 (zlib 1.3) || OpenMPT/libopenmpt || warning C4244: '=': conversion from 'ush' to 'uchf', possible loss of data || https://github.com/madler/zlib/issues/606
|-
| MSVC || fixed 2023-08-08 (VS2022 17.7) || OpenMPT/libopenmpt || INTERNAL COMPILER ERROR when compiling std:chrono code || https://developercommunity.visualstudio.com/t/INTERNAL-COMPILER-ERROR-when-compiling-s/10366948 https://developercommunity.visualstudio.com/t/Internal-compiler-error-when-using-chron/10308841
|-
| FLAC || fixed 2023-07-27 (1.5.0) || OpenMPT/libopenmpt || incompatible pointer types in bitmath.h || https://github.com/xiph/flac/issues/637
|-
| ancient || fixed 2023-07-19 || OpenMPT || trivial warnings with clang-cl || https://github.com/temisu/ancient/issues/50
|-
| ancient || fixed 2023-07-12 (2.1.1) || OpenMPT || new VS2022 warnings in 2.1.0 || https://github.com/temisu/ancient/issues/43
|-
| cross-platform-actions || fixed 2023-05-28|| libopenmpt || NetBSD 9.3 || https://github.com/cross-platform-actions/action/issues/53
|-
| GCC || fixed 2023-05-08 (GCC 12.3) || libopenmpt || false-positive -Wstringop-overflow warning when using std::vector with UBsan / [12 Regression] spurious warning - std::vector::clear followed by std::vector::insert(vec.end(), ...) with -O2 || https://gcc.gnu.org/bugzilla/show_bug.cgi?id=109455 / https://gcc.gnu.org/bugzilla/show_bug.cgi?id=100366
|-
| mpg123 || fixed 2022-10-28 (1.31.0) || libopenmpt || checking for _FILE_OFFSET_BITS is wrong on platforms where it does nothing || https://sourceforge.net/p/mpg123/bugs/330/
|-
| ffmpeg || fixed 2022-11-05 || OpenMPT / libopenmpt || 8-Bit FLAC Playback Skips Silent Portions || https://trac.ffmpeg.org/ticket/9270
|-
| FLAC || fixed 2022-10-20 || libopenmpt || configure must not pass -msse2 by default on x86 || https://github.com/xiph/flac/issues/486
|-
| MSVC || fixed 2022-09-27 (VS2022 17.3.5) || OpenMPT || warning C4311 in MFC header afxrecovery.h with VS2022 17.2.0 / Compiler warnings after upgrading to 17.2.0 (C4311) / Compiler warnings after upgrading to 17.2.0 (C4311) (now 17.3.x too) || https://developercommunity.visualstudio.com/t/warning-C4311-in-MFC-header-afxrecovery/10041328 https://developercommunity.visualstudio.com/t/Compiler-warnings-after-upgrading-to-17/10036311 https://developercommunity.visualstudio.com/t/Compiler-warnings-after-upgrading-to-17/10119333
|-
| QEMU (Debian) || fixed 2022-09-13 (QEMU 7.1) || libopenmpt || QEMU aarch64 user mode emulation always segfaults || https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1014177
|-
| MSVC / LLVM || fixed 2022-09-06 (LLVM 15.0.0) || OpenMPT / libopenmpt || Visual Studio 2022 lld-link: warning/error: ignoring unknown debug$S subsection kind 0xFF in file libucrt.lib || https://github.com/llvm/llvm-project/issues/56285
|-
| FLAC || fixed 2022-09-14 || OpenMPT/libopenmpt || Wrong printf format specifier in stream_decoder.c || https://github.com/xiph/flac/issues/433
|-
| sndfile || fixed 2022-09-12 || libopenmpt || public API header sndfile.h unneccessarily depends on Autoconf/CMake variables || https://github.com/libsndfile/libsndfile/issues/868
|-
| GCC || fixed 2022-08-19 (12.2) || libopenmpt || g++-mingw-w64-posix fails to set __STDCPP_THREADS__=1 even though it supports std::thread || https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1003382
|-
| MSVC || fixed 2022-07-16 || OpenMPT/libopenmpt || <filesystem>: lexically_relative() can not handle long path with prefix \\?\ || https://github.com/microsoft/STL/issues/2256
|-
| MSVC || fixed 2022-07-06 (Windows 11 SDK 10.0.22621.0) || OpenMPT || 64-bit EXEs built with VS2019 crash under Wine on macOS because of direct TEB access || https://developercommunity.visualstudio.com/t/64-bit-EXEs-built-with-VS2019-crash-unde/1248753
|-
| clang || fixed 2022-06-14 (Clang 15) || libopenmpt || Inconsistent shift-overflow warnings in C++20 || https://github.com/llvm/llvm-project/issues/52873
|-
| AppVeyor || fixed 2022-06-06 || OpenMPT || Windows 11 SDK 10.0.22621.0 in VS2022 image || https://github.com/appveyor/ci/issues/3822
|-
| MSVC || fixed 2022-05-11 (VS2022 17.2) || OpenMPT/libopenmpt || VS 2022 RC inappropriately assigns /MP[N] when invoking cl.exe which makes compilation extremely slow || https://developercommunity.visualstudio.com/t/msbuild-slow-c-solution-build-times-when-upgrading/1666033 https://developercommunity.visualstudio.com/t/VS-2022-RC-inappropriately-assigns-MPN/1560595
|-
| MSVC || fixed 2022-05-11 (VS2022 17.2) / work-around || OpenMPT || link errors when building MFC application with clang-cl || https://developercommunity.visualstudio.com/t/link-errors-when-building-MFC-applicatio/1617786
|-
| MSVC || fixed 2022-02-15 (VS2022 17.1) || OpenMPT/libopenmpt || VS2022 cl 19.30.30705 generates non-universally-available tzcnt instruction for std::countr_one || https://developercommunity.visualstudio.com/t/VS2022-cl-193030705-generates-non-univ/1578571
|-
| autoconf || fixed 2022-02-11 || libopenmpt || AX_CXX_COMPILE_STDCXX: add C++20 support || https://github.com/autoconf-archive/autoconf-archive/pull/244
|-
| emscripten || fixed 2022-01-10 (3.1.1) || libopenmpt || missing C++20 safe integers comparisons (cmp_equal) in <utility> in C++20 mode || https://github.com/emscripten-core/emscripten/issues/15851 https://github.com/emscripten-core/emscripten/issues/15396
|-
| ancient || fixed 2022-01-08 (1.1) || OpenMPT/libopenmpt || warnings with VS2019 /W3 || https://github.com/temisu/ancient/issues/25
|-
| miniz || fixed 2021-11-28 || libopenmpt || unnecessary hastle to contribute || https://github.com/richgel999/miniz/issues/211
|-
| miniz || fixed 2021-11-28 || libopenmpt || various fixes || https://github.com/richgel999/miniz/issues/212
|-
| miniz || fixed 2021-11-28 || libopenmpt || unconditional #define MINIZ_EXPORT in miniz.h in 2.2.0 || https://github.com/richgel999/miniz/issues/213
|-
| MSVC || fixed 2021-11-09 || OpenMPT/libopenmpt || ICE with consteval in VS2019 16.10 || https://developercommunity.visualstudio.com/t/ICE-with-consteval-in-VS2019-1610/1436186
|-
| mpg123 || fixed 2021-10-23 || OpenMPT/libopenmpt || MSVC logic warning in 1.29.1 || https://sourceforge.net/p/mpg123/bugs/324/
|-
| mpg123 || fixed 2021-07-12 || OpenMPT/libopenmpt || Removal of #ifndef MPG123_NO_CONFIGURE breaks build || https://sourceforge.net/p/mpg123/bugs/313/
|-
| MSVC || fixed 2021-06-17 || OpenMPT/libopenmpt || Tons of bogus C28251 and C28301 warnings when running /analyze on C code || https://developercommunity.visualstudio.com/t/Tons-of-bogus-C28251-and-C28301-warnings/1436757
|-
| MSVC || fixed 2021-05-26 || OpenMPT|| GdiplusTypes.h does not compile with NOMINMAX || https://developercommunity.visualstudio.com/t/GdiplusTypesh-does-not-compile-with-NOM/727770
|-
| ancient || fixed 2021-05-26 || OpenMPT || Registry does not work when built as a static library || https://github.com/temisu/ancient/issues/31
|-
| ancient || fixed 2021-05-25 || OpenMPT/libopenmpt || Incorrect checksum calculation for older MMCMP files || https://github.com/temisu/ancient/issues/32
|-
| ancient || fixed 2021-05-23 || OpenMPT/libopenmpt || fails to decompress some MMCMP files || https://github.com/temisu/ancient/issues/20
|-
| ancient || fixed 2021-05-23 || libopenmpt || warning in main.cpp with GCC 9 (Ubuntu 20.04) || https://github.com/temisu/ancient/issues/27
|-
| ancient || fixed 2021-05-23 || libopenmpt || warning in LH3Decompressor with GCC 9 (autotools build) || https://github.com/temisu/ancient/issues/28
|-
| ancient || fixed 2021-05-22 || libopenmpt || A cleaner public API || https://github.com/temisu/ancient/issues/18
|-
| ancient || fixed 2021-05-21 || libopenmpt || Allow for better packaging and system integration || https://github.com/temisu/ancient/issues/13
|-
| MacPorts || fixed 2021-05-12 || libopenmpt || libsndfile 1.0.28 has multiple security issues || https://trac.macports.org/ticket/60820
|-
| mpg123 || fixed 2021-05-08 || OpenMPT/libopenmpt || #define warning clashes with MSVC pragmas, runtime headers, and Windows SDK headers || https://sourceforge.net/p/mpg123/bugs/308/
|-
| mpg123 || fixed 2021-05-08 || libopenmpt || warnings in debug printf format strings on obscure platforms || https://sourceforge.net/p/mpg123/bugs/309/
|-
| clang || fixed 2020-09-09 (11.0) || libopenmpt || LLVM generates illegal instruction with -O3 on powerpc (32bit) || https://bugs.llvm.org/show_bug.cgi?id=46683
|-
| Homebrew || fixed 2020-07-11 || libopenmpt || libsndfile 1.0.28 contains multiple security bugs || https://github.com/Homebrew/homebrew-core/issues/57833
|-
| MSVC || fixed 2019-08-02 || OpenMPT/libopenmpt || MFC headers conflict with C++17 charconv header in MBCS mode || https://developercommunity.visualstudio.com/t/MFC-headers-conflict-with-C17-charconv/629849 https://developercommunity.visualstudio.com/t/charconv-vs-mbctype-in-VS2019/425926
|-
| glibc || fixed 2018-11-12 (2.28) || libopenmpt || Crash in glibc's mktime in low-memory situations || https://sourceware.org/bugzilla/show_bug.cgi?id=21716 https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=867283
|-
| MSVC || fixed 2017-12-18 || OpenMPT/libopenmpt || Random engines crashing VS 15.5 optimizer || https://developercommunity.visualstudio.com/t/Random-engines-crashing-VS-155-optimize/162089
|-
| MSVC || fixed 2017-12-06 || OpenMPT/libopenmpt || C1063 and C1001 while compiling trivial code in VS2017.3 || https://developercommunity.visualstudio.com/t/C1063-and-C1001-while-compiling-trivial/96687
|-
| MSVC || fixed 2017-08-02 || OpenMPT/libopenmpt || Compiler out of heap space when compiling constexpr struct with bitfields || https://developercommunity.visualstudio.com/t/Compiler-out-of-heap-space-when-compilin/28057
|-
| sndfile || fixed 2017-06-15 (1.0.29) || libopenmpt || Heap buffer overflows in psf_binheader_writef in 1.0.28 and later || https://github.com/libsndfile/libsndfile/issues/292
|-
| mpg123 || fixed 2017-05-30 || libopenmpt || Missing libgcc DLL in the 1.24 Win32 binary package || https://sourceforge.net/p/mpg123/bugs/246/
|-
| mpg123 || fixed 2017-05-30 || OpenMPT/libopenmpt || Unclear and/or confusing licensing of src/libmpg123/synth_sse3d.h || https://sourceforge.net/p/mpg123/bugs/249/
|-
| mpg123 || fixed 2017-03-08 || OpenMPT/libopenmpt || Build failure with VS2015 64bit due to conflicting ssize_t typedef || https://sourceforge.net/p/mpg123/bugs/243/
|-
| C++ (11..14) || fixed 2016-07 || OpenMPT/libopenmpt || std::abs(short), std::abs(signed char) and others should return int instead of double in order to be compatible with C++98 and C || https://cplusplus.github.io/LWG/issue2735
|-
| TODO-product || TODO-status || TODO-affects || TODO-description || TODO-link
|}

[[Category:Development|Foreign Bugs]]

Manual: Setup/MIDI

2025-08-04T19:20:31Z

Saga Musix: /* Pass MIDI to Active Plugin */

[[Image:Settings MIDI.png|thumb|350px|MIDI tab of the settings dialog]]

OpenMPT’s MIDI recording is limited, but there are some settings that are worth looking into.

== MIDI Recording ==

=== MIDI Input Device ===
Shows the device from which MIDI data will be received. Clicking on the field opens a popup menu where you can choose from all available MIDI input devices.
If the list is empty, Windows did not recognize any MIDI device — check if you have installed your MIDI interface drivers properly.

You can use the '''Rename''' button to assign more easily recognizable (“friendly”) names for MIDI devices to be shown in this list, the MIDI device dropdown menu in the main toolbar and in the MIDI Input / Output plugin. The plugin also uses these friendly names to open the correct MIDI ports for a device even if it was plugged into a different port. For example, if a synthesizer was plugged into “Port A” when a module file was created but is now plugged into “Port B”, OpenMPT will open “Port B” if its friendly name has been updated to the friendly name that was previously used for “Port A”.

For help with setting up MIDI devices for input and output, be sure to also consult the [[Manual: MIDI Reference#OpenMPT Setup|MIDI Reference]].

=== Apply Octave Transpose ===
Checking this box applies the pattern editor′s base octave setting to incoming MIDI notes. Effectively, this means that if the base octave differs from Octave 4, this difference is also applied to MIDI notes that are being received.

=== Respond to Song Messages ===
Checking this box allows OpenMPT to receive MIDI messages that cause the currently active song to play, stop, or continue.

=== Continue Song ===
Checking this box allows for playback to resume (after being paused) when any note key on the MIDI device is pressed.
You can choose from the dropdown list whether you want to resume playback from the current cursor position or rather restart the pattern from the beginning.

=== Pass MIDI to Active Plugin ===
By default, OpenMPT passes all MIDI messages received from external MIDI devices that it did not process by itself to the active instrument plugin. Unchecking this box will avoid passing those MIDI messages on, which avoids potentially modifying the plugin state through MIDI CCs and the like. Messages that OpenMPT intercepts (such as note-on and note-off messages) are still processed as normal.

=== Enable MIDI recording when OpenMPT starts ===
If this box is checked, MIDI In Record is enabled automatically when starting OpenMPT.

== MIDI Recording - Volume and Controllers ==

=== Record Note Off ===
Checking this box records Note Off commands (<code>==</code> in instrument mode, <code>^^</code> in sample mode) when recording from the MIDI device.

=== Record Note Velocity ===
Checking this box records the note′s key velocity into the pattern as a volume effect. Some MIDI controllers may not support note velocity and will always send the same velocity value. You may also change the velocity amplification factor depending on your play style. If you have a hard playing style and use an amplification greater than 100%, this setting may decrease the dynamic range of the recorded note velocity, unless your MIDI hardware compensates for your play style, for example by applying a velocity curve.

=== Combine MIDI volume to Note Velocity ===
Checking this box takes transmitted MIDI volume changes (MIDI CC 7) into account and multiplies them with the note velocity when notes are entered from a MIDI device, given that “Record Note Velocity” is enabled.

=== Record Controllers to Macros ===
Checking this box makes OpenMPT record incoming MIDI CCs as MIDI macro commands. Note that only macro values are entered; you will need to set up macro assignments in order for the proper controllers to be manipulated. For an easier and more versatile method of recording MIDI events, have a look at the [[Manual: MIDI Mapping|MIDI Mapping]].

If you want certain MIDI CCs to be ignored (e.g. because they are triggered automatically by your MIDI device), you can add their decimal number in the exception list.

=== Record Aftertouch ===
If you are using a MIDI device that supports aftertouch (both channel pressure and polyphonic aftertouch are supported), you can enable this option to record pressure changes to the pattern as either volume commands or MIDI Macro commands.

=== Record Pitch Bend messages ===
MIDI pitch bend messages can be record in one of four ways:
* '''Do not record Pitch Bends''': Pitch bend messages are never recorded to patterns.
* '''Record only as MIDI Macros''': In formats that support MIDI macros, pitch bend messages are recorded as MIDI macro commands. Note that only macro values are entered; you will need to [[Manual: Macro Configuration#Parametered Macros|set up a macro assignment]] in order to send these macros as MIDI Pitch Bend messages to plugins.
* '''Record as Finetune or MIDI Macros''': In the MPTM format, pitch bend messages are recorded as finetune commands; in other formats, MIDI macros are used if supported by the format.
* '''Record only as Finetune''': In the MPTM format, pitch bend messages are recorded as finetune commands; in other formats, nothing is recorded.

== MIDI File Import ==

The following options are used when [[Manual: Module formats#The MIDI format .28.mid.29|importing MIDI files]].

=== Quantize ===
Since MIDI files are not pattern-based, you need to decide how many time units you want to put within a single pattern row. This setting lets you choose the note length of a single pattern row. For typical MIDI files, 16th or 32nd notes should be sufficient. The correct value of this setting depends on the smallest note unit used in the imported MIDI files, and there is no “one correct setting”.

=== Ticks / Row ===
For further pattern detail, you can choose the amount of ticks per row in the range of 2 to 16. Higher values allow for very precise placement of note delays and note cuts — sometimes maybe ''too'' precise depending on how you want to further mangle the pattern data. On the other hand, higher values make it more difficult to import small pitch slides accurately, but with too low values pitch slides may sound too coarse. Hence, it is recommended to use an medium value (like 6) by default and only change it for importing particular files if it is required.

=== Pattern Length ===
Since MIDI files are not pattern-based, you have to select the pattern length on your own.

[[Category:Manual|Setup/MIDI]]
[[Category:MIDI|MIDI Setup]]
[[de:Handbuch: Setup/Midi]]

Manual: Keyboard Actions

2025-07-25T23:28:00Z

Saga Musix: /* Sample Editor */

This is a list of all customisable keyboard actions in OpenMPT. They can be configured in the [[Manual: Setup/Keyboard|Keyboard Setup dialog]].

Default key combinations listed in the tables below assume a US keyboard layout. Generally, alphanumeric keys in shortcuts will stay the same in other keyboard layouts (so <kbd>Ctrl</kbd>+<kbd>Z</kbd> does not turn into <kbd>Ctrl</kbd>+<kbd>Y</kbd> on a German layout), with the exception of note entry keys, which are set up based on their position on the keyboard instead (so on a French keyboard, <kbd>A</kbd>, <kbd>Q</kbd> and <kbd>W</kbd> are used for playing a C across three octaves even though the table below says <kbd>Q</kbd>, <kbd>A</kbd> and <kbd>Z</kbd>). Non-alphanumeric keys generally vary a lot between keyboard layouts, so there might not be a direct mapping to your keyboard layout — the key might have a completely different label or not exist at all. You can always review the ''actual'' key combinations used by OpenMPT on your setup by reviewing them in the Keyboard setup dialog.

'''Note''': Keyboard shortcuts that clash with the default text editing shortcuts of the operating system (e.g. <kbd>Ctrl</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>+<kbd>Z</kbd>, etc.) are ignored when the input focus is within a text field.

== Global Keys ==

Global keyboard shortcuts work on most parts of OpenMPT as long as one of the program’s windows is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| File/New || <kbd>Ctrl</kbd>+<kbd>N</kbd> || Creates a new song. The currently edited song is not closed, as OpenMPT can have multiple documents open at the same time.
|-
| File/Open || <kbd>Ctrl</kbd>+<kbd>O</kbd> || Opens one or more existing songs.
|-
| File/Append Module || || [[Manual: Module Merging|Appends]] (merges) the song data (samples, instruments, plugins, patterns and sequences) of one or more existing songs to the currently active song.
|-
| File/Close || <kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes the current song. You are prompted to save the song if it has been modified.
|-
| File/Close All || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes all open songs. You are prompted to save modified songs.
|-
| File/Save || <kbd>Ctrl</kbd>+<kbd>S</kbd> || Saves the song to disk.
|-
| File/Save As || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>S</kbd> || Allows you to save the file with a new name or in another folder.
|-
| File/Save Copy || || Allows you to save a copy of the file. The next Save action will update the file at its original location again.
|-
| File/Save As Template || || Creates a template from the current song.
|-
| File/Open Template || || Opens a file picker in the template module folder.
|-
| File/Stream Export || || Exports the current track into a lossless or lossy [[Manual: Saving and exporting#Stream Export|streaming file]].
|-
| File/Export as MIDI || || Exports the current track into the .mid format. See the section on [[Manual: Saving and exporting#MIDI Export|MIDI export]] for a detailed explanation of how this file is exported.
|-
| File/Export OPL Register Dump || || Exports the current track into one of several OPL register dump formats. See the section on [[Manual: Saving and exporting#OPL Export|OPL export]] for a detailed explanation of how this file is exported.
|-
| File/Compatibility Export || || Exports the current track without any [[Manual: Saving and exporting#Compatibility Export|file format hacks]] to its original format.
|-
| File/Import MIDI Library || || Imports the MIDI Instrument Library of your choosing. The MIDI Library can be accessed from the [[Manual: Tree View#MIDI Library|Tree View]].
|-
| File/Add Sound Bank || || Imports a sound bank of your choosing. Sound banks can be accessed from the [[Manual: Tree View#Sound Banks|Tree View]].
|-
| Previous Document || || Goes to the previous module file that is open (these are visible in the Windows Menu).
|-
| Next Document || || Goes to the next module file that is open (these are visible in the Windows Menu).
|-
| Play Song / Pause Song || <kbd>F5</kbd> || Toggles the playback of the current track. The playback cursor is not reset when using this toggle; that is, it plays from where the cursor left off when it was last pressed.
|-
| Play Song / Stop Song || || Toggles the playback of the current track. The playback cursor is reset to the start of the song.
|-
| Pause Song || <kbd>F8</kbd> || Only stops the playback of the current track but does not reset the playback pointer.
|-
| Stop Song || <kbd>Escape</kbd> || Stops the playback of the current track and resets the playback cursor to the start of the song.
|-
| Play Song from Start || <kbd>F6</kbd> || Resets the playback cursor to the very first row and begins playback from there.
|-
| Play Song from Cursor / Pause || || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there if playback is currently stopped, otherwise it pauses playback. Playback will continue until the end of the track.
|-
| Play Song from Cursor || <kbd>Ctrl</kbd>+<kbd>F6</kbd> || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there. Playback will continue until the end of the track.
|-
| Play Song from Pattern Start / Pause || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there if playback is currently stopped, otherwise it pauses playback.
|-
| Play Song from Pattern Start || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there.
|-
| Play Pattern from Start || <kbd>F7</kbd> || Loops the current pattern, starting at the first row of the pattern.
|-
| Play Pattern from Cursor || <kbd>Ctrl</kbd>+<kbd>F7</kbd> || Loops the current pattern, starting at the row where the editing cursor is currently placed.
|-
| Toggle Loop Song || || Enables or disables the song loop status.
|-
| Panic || || Stops all sample, OPL and plugin instrument voices.
|-
| Estimate Song Length || || Estimates the playback length of the entire track.
|-
| Show Approx. Real BPM || || Estimates the beats per minute of the song, based on the current tempo and the number of ticks per row, plus the Tempo Mode in the Song Properties dialog.
|-
| Toggle MIDI Record || <kbd>F9</kbd> || Toggles the MIDI Record option.
|-
| Increase Tempo || || Increases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo || || Decreases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Tempo (Fine) || || Increases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo (Fine) || || Decreases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Ticks per Row || || Increases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Decrease Ticks per Row || || Decreases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Undo || <kbd>Ctrl</kbd>+<kbd>Z</kbd> || Rescinds the last edit in the pattern or sample editor.
|-
| Redo || <kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd> || Reapplies the last undone action.
|-
| Cut || <kbd>Ctrl</kbd>+<kbd>X</kbd> || Copies the selected pattern, sample or instrument data into the clipboard, then removes it from the selection it occupies.
|-
| Copy || <kbd>Ctrl</kbd>+<kbd>C</kbd> || Copies the selected pattern, sample or instrument data into the clipboard.
|-
| Paste || <kbd>Ctrl</kbd>+<kbd>V</kbd>, <kbd>Shift</kbd>+<kbd>Insert</kbd> || Pastes data from the clipboard. In the pattern editor, it is pasted at the location of the cursor, overwriting any pattern data that falls within the paste area. With sample data, clipboard contents replace the '''whole''' sample.
|-
| Mix Paste || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>V</kbd> || Mixes clipboard contents with existing data. In the pattern editor, clipboard contents are pasted in the same row at the same column of the current (visible) pattern where the cursor is located, except where there is already any data in any corresponding field of the paste area. In the sample editor, the source and clipboard sample waveforms are mixed together.
|-
| Mix Paste (IT Style) || || For detailed differences between Mix Paste and Mix Paste (IT Style), consult the [[Manual: Patterns#Paste Modes|Pattern Editor help]]. The two commands are identical when used in the sample editor.
|-
| Paste Flood || <kbd>Shift</kbd>+<kbd>V</kbd> || Clipboard contents are pasted from the cursor, repeating the data paste until every row in the pattern has been filled and pasting over any data in its path.
|-
| Push Forward Paste (Insert) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>V</kbd> || Patterns: Clipboard contents are inserted at the row of the cursor, and pushing all data below that row further down the pattern. Any data of the affected channels pushed beyond the pattern’s last row is deleted. Samples: The sample data from the clipboard replaces the current selection. If there is no selection, the sample is inserted at the last selected position.
|-
| Select All || <kbd>Ctrl</kbd>+<kbd>5</kbd> || Selects all pattern or sample data.
|-
| Find / Replace || <kbd>Ctrl</kbd>+<kbd>F</kbd> || Opens the Find/Replace dialog, which allows you to search for and/or replace given pattern data. Find starts from the cursor location.
|-
| Find Next || <kbd>F3</kbd> || Applies the current Find settings and searches for the next data that matches it, starting from the current cursor location.
|-
| View General || <kbd>Alt</kbd>+<kbd>G</kbd> || Opens the [[Manual: General|General Tab]] of the currently focussed module.
|-
| View Pattern || <kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Patterns|Pattern Tab]].
|-
| View Samples || <kbd>Alt</kbd>+<kbd>S</kbd> || Opens the [[Manual: Samples|Sample Tab]].
|-
| View Instruments || <kbd>Alt</kbd>+<kbd>N</kbd> || Opens the [[Manual: Instruments|Instrument Tab]].
|-
| View Comments || <kbd>Alt</kbd>+<kbd>C</kbd>, <kbd>Shift</kbd>+<kbd>F9</kbd> || Opens the [[Manual: Comments|Comments Tab]].
|-
| Toggle Main Toolbar || || Shows / hides the [[Manual: Main Toolbar|Main Toolbar]].
|-
| Toggle Tree View || <kbd>Ctrl</kbd>+<kbd>F2</kbd> || Shows / hides the [[Manual: Tree View|Tree View]].
|-
| View Options || <kbd>Ctrl</kbd>+<kbd>F1</kbd> || Opens the [[Manual: Setup|Setup dialog]].
|-
| View Channel Manager || || Opens the [[Manual: Channel Manager|Channel Manager]].
|-
| View Plugin Manager || || Opens the [[Manual: Plugin Manager|Plugin Manager dialog]].
|-
| View Song Properties || || Opens the [[Manual: Song Properties|Song Properties dialog]].
|-
| View Global Tempo Swing Settings || || Opens the [[Manual: Tempo Swing Settings|Tempo Swing Settings dialog]] for the song’s global time signature. If modern tempo mode is not enabled yet, the [[Manual: Song Properties|Song Properties dialog]] is opened instead so that it can be enabled.
|-
| View Zxx Macro Configuration || || Opens the [[Manual: Macro Configuration|MIDI Macro Configuration]] dialog.
|-
| View MIDI Mapping || <kbd>Ctrl</kbd>+<kbd>F3</kbd> || Opens the [[Manual: MIDI Mapping|MIDI Mapping dialog]].
|-
| View Edit History || || Opens the [[Manual: Edit History|Edit History]].
|-
| Toggle Between Upper / Lower View || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd> || Switches keyboard focus between the upper and lower half of the currently focussed song view.
|-
| Switch to Instrument Library || <kbd>Alt</kbd>+<kbd>I</kbd> || Sets keyboard focus to the [[Manual: Tree View|Instrument Library]], or switches back to the last used editor window if the tree view already has focus.
|-
| Help || <kbd>F1</kbd> || Opens the manual.
|-
| Open Context Menu || <kbd>▤ Application</kbd>, <kbd>Shift</kbd>+<kbd>F10</kbd> || Opens the context menu for the currently selected item.
|-
| Previous Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad/</kbd>, <kbd>Ctrl</kbd>+<kbd>Up</kbd> || Changes the current instrument to the previous one. In the sample editor, the previous sample is chosen.
|-
| Next Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad*</kbd>, <kbd>Ctrl</kbd>+<kbd>Down</kbd> || Changes the current instrument to the next one. In the sample editor, the next sample is chosen.
|-
| Previous Octave || <kbd>Numpad/</kbd> || Changes the current octave to the next lower octave.
|-
| Next Octave || <kbd>Numpad*</kbd> || Changes the current octave to the next higher octave.
|-
| Previous Order || <kbd>Ctrl</kbd>+<kbd>Left</kbd> || Changes the current pattern to the previous one in the pattern order.
|-
| Next Order || <kbd>Ctrl</kbd>+<kbd>Right</kbd> || Changes the current pattern to the next one in the pattern order.
|-
| Previous Order (Transition at end of current measure) || || Changes the current pattern to the previous one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current measure) || || Changes the current pattern to the next one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current beat) || || Changes the current pattern to the previous one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current beat) || || Changes the current pattern to the next one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current row) || || Changes the current pattern to the previous one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current row) || || Changes the current pattern to the next one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Dummy Shortcut || || Some keyboard shortcuts are created automatically by OpenMPT (e.g. the combinations of pressing the selection key together with navigation keys). If you need to prevent OpenMPT from automatically assigning a specific key combination, you can assign it to this dummy shortcut instead, so it will not be usable by automatically generated shortcuts. This will also prevent the key combination from being used by new default key combinations added by future OpenMPT updates.
|-
|}

== Pattern ==

=== Order List ===

These keyboard shortcuts operate while the cursor focus is in the Order List.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Delete Order || <kbd>Delete</kbd> || Erases the currently selected pattern(s) in the Order List (the pattern itself is not removed, only the reference).
|-
| Insert Order || <kbd>Insert</kbd> || Duplicates the currently selected pattern ''reference''(s) in the Order List.
|-
| Insert Separator || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Inserts a separator item (+++) at the next position.
|-
| Copy Orders || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Copies the currently selected pattern ''references'' in the Order List to the clipboard.
|-
| Edit Pattern || <kbd>Enter</kbd> || Resets the Pattern Editor to show the highlighted pattern.
|-
| Switch to Pattern Editor || <kbd>Tab</kbd> || Moves the cursor focus to the Pattern Editor. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Previous Order || <kbd>Left</kbd>, <kbd>Up</kbd> || Selects the previous pattern in the Order List.
|-
| Next Order || <kbd>Right</kbd>, <kbd>Down</kbd> || Selects the following pattern in the Order List.
|-
| First Order || <kbd>Home</kbd> || Selects the first pattern in the Order List.
|-
| Last Order || <kbd>End</kbd> || Selects the final pattern in the Order List.
|-
| Pattern Index Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the respective numeral into the pattern ID box.
|-
| Increase Pattern Index || <kbd>=</kbd>, <kbd>Numpad+</kbd> || Adds one to the pattern number, up to the highest indexed pattern.
|-
| Decrease Pattern Index || <kbd>-</kbd>, <kbd>Numpad-</kbd> || Subtracts one from the pattern number, to a minimum of index 0.
|-
| Separator Index || <kbd>I</kbd> || Adds a separator pattern item (+++) at the current position.
|-
| Stop Index || <kbd>Space</kbd> || Adds a stop pattern item (---) at the current position.
|-
| Lock Playback to Selection || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Song playback is locked to the patterns in the current order selection.
|-
| Unlock Playback || <kbd>Ctrl</kbd>+<kbd>U</kbd> || If playback has been limited to an order selection before, the playback lock can be removed here.
|-
| Queue Pattern (Transition at end of current pattern) || <kbd>Q</kbd> || The selected order list item is queued to be played next, after the current pattern has finished playing.
|-
| Queue Pattern (Transition at end of current measure) || <kbd>Shift</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current measure has finished playing.
|-
| Queue Pattern (Transition at end of current beat) || <kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current beat has finished playing.
|-
| Queue Pattern (Transition at end of current row) || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current row has finished playing.
|-
| Stream Export || || Opens the [[Manual: Saving and exporting#Stream Export|Wave Export dialog]] for the selected patterns.
|-
|}

=== Quick Channel Settings ===

These keyboard shortcuts operate while the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] is open.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Channel || <kbd>Alt</kbd>+<kbd>Left</kbd>, <kbd>Shift</kbd>+<kbd>Backspace</kbd> || Shows the channel settings for the previous channel.
|-
| Next Channel || <kbd>Alt</kbd>+<kbd>Right</kbd>, <kbd>Shift</kbd>+<kbd>Enter</kbd> || Shows the channel settings for the next channel.
|-
| Pick Color from Previous Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Left</kbd> || Assigns the color of the previous channel to the current channel.
|-
| Pick Color from Next Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Right</kbd> || Assigns the color of the next channel to the current channel.
|-
| Switch to Pattern Editor || <kbd>Enter</kbd> || Closes the dialog and returns to the Pattern Editor.
|-
|}

=== General Context ===

These keyboard shortcuts will work if the cursor focus is within any of the columns of the Pattern Editor, except where noted. When navigating (moving the cursor) to before the first row or after the last row in the pattern, the cursor “wraps” to the other side of the same pattern, if the “Cursor Wrap” option is enabled (in the Options section of the [[Manual: Setup/General|General tab]] of the Setup dialog). If navigating beyond the first or last row when the “Continuous Scroll” option is enabled, the cursor will instead move to the previous/next pattern in the order list.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Navigate Down by 1 Row || <kbd>Down</kbd> || Moves the cursor to the next row in the same column.
|-
| Navigate Up by 1 Row || <kbd>Up</kbd> || Moves the cursor to the previous row in the same column.
|-
| Navigate Down by Spacing || <kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor down by the value in the Row Spacing field.
|-
| Navigate Up by Spacing || <kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor up by the value in the Row Spacing field.
|-
| Navigate Left || <kbd>Left</kbd> || Moves the cursor to the previous column in the same row, going to the previous channel′s last column if moving from the first column of the current channel.
|-
| Navigate Right || <kbd>Right</kbd> || Moves the cursor to the next column in the same row, going to the next channel’s first column if moving from the last column of the current channel.
|-
| Navigate to Next Channel || <kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the next channel.
|-
| Navigate to Previous Channel || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the previous channel.
|-
| Jump Down by Measure || <kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Up by Measure || <kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Down by Beat || <kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump Up by Beat || <kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Measure || || Moves the cursor down to the first row of the next measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Up to Measure || || Moves the cursor up to the first row of the previous measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down to the first row of the next beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Snap Up to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up to the first row of the previous beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump to Previous Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column above the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the previous patterns.
|-
| Jump to Next Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column below the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the next patterns.
|-
| Go to First Channel || <kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the same row.
|-
| Go to First Row || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Moves the cursor to the first row of the same channel in the same column.
|-
| Go to First Row of First Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the first row.
|-
| Go to Last Channel || <kbd>End</kbd> || Moves the cursor to the last column of the last channel in the same row.
|-
| Go to Last Row || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Moves the cursor to the last row of the same channel in the same column.
|-
| Go to Last Row of Last Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>End</kbd> || Moves the cursor to the last column of the last channel in the last row.
|-
| Go to note column || || Moves the cursor to the note column of the current pattern cell.
|-
| Go to instrument column || || Moves the cursor to the instrument column of the current pattern cell.
|-
| Go to volume effect column || || Moves the cursor to the volume effect column of the current pattern cell.
|-
| Go to effect comamnd column || || Moves the cursor to the effect command column of the current pattern cell.
|-
| Go to effect parameter column || || Moves the cursor to the effect parameter column of the current pattern cell.
|-
| Previous Pattern || <kbd>Numpad-</kbd> || Displays the previous pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Next Pattern || <kbd>Numpad+</kbd> || Displays the next pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Previous Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>-</kbd> || Cycles to the previous sequence. If the current sequence is the first, the last sequence is selected.
|-
| Next Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>+</kbd> || Cycles to the next sequence. If the current sequence is the last, the first sequence is selected.
|-
| Scroll Left || || Scrolls the pattern editor to the left without changing the cursor position.
|-
| Scroll Right || || Scrolls the pattern editor to the right without changing the cursor position.
|-
| Scroll Up || || Scrolls the pattern editor up without changing the cursor position.
|-
| Scroll Down || || Scrolls the pattern editor down without changing the cursor position.
|-
| Selection Key || <kbd>Shift</kbd> || The modifier key to be used to extend the selection when navigating with keyboard shortcuts.
|-
| Copy Select Key || <kbd>Ctrl</kbd> || The modifier key to be used to copy the selection when dragging with the mouse.
|-
| Select Channel / Select All || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Selects all events of the channel where the cursor is located in the current pattern, or all events in the pattern if the entire channel is already selected.
|-
| Select Column || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Selects the column in which the cursor is located in all rows of the current pattern.
|-
| Select Row || || Completely selects all rows covered by the current selection.
|-
| Select Event || || Completely selects all events covered by the current selection.
|-
| Select Beat || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a beat and ends on the last row of a beat.
|-
| Select Measure || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a measure and ends on the last row of a measure.
|-
| Lose Selection || || Resets the selection rectangle to contain only the cursor position.
|-
| Copy and Lose Selection || || Copies the selected events to the clipboard and unselects them.
|-
| Quick Copy || <kbd>Enter</kbd> || Copies only one event of data (where the cursor is located) to OpenMPT′s “Quick” clipboard; the standard clipboard is not erased. Each column pair has its own Quick clipboard.
|-
| Quick Paste || <kbd>Space</kbd> || Pastes the data in OpenMPT′s “Quick” clipboard to the location of the cursor. The data last saved in that column’s clipboard will be pasted in the cursor′s corresponding column.
|-
| Cut to Pattern Channel Clipboard || || Copies and clears the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Cut to Pattern Clipboard || || Copies and clears the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Copy to Pattern Channel Clipboard || || Copies the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Copy to Pattern Clipboard || || Copies the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Paste from Pattern Channel Clipboard || || Replaces the contents of the channel the cursor is located in with the contents of the pattern channel clipboard.
|-
| Paste from Pattern Clipboard || || Replaces the contents of the current pattern with the contents of the pattern clipboard.
|-
| Toggle Clipboard Manager || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Toggles the visibility of the pattern clipboard manager.
|-
| Cycle to Previous Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Left</kbd> || Makes the previous internal clipboard the current clipboard.
|-
| Cycle to Next Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Right</kbd> || Makes the next internal clipboard the current clipboard.
|-
| Clear Row || || Deletes all event data in the same row in the current channel.
|-
| Clear Field || <kbd>Delete</kbd> || Deletes the selected pattern data, or just the data under the current cursor position if no selection has been made.
|-
| Clear Field (IT Style) || <kbd>Shift</kbd>+<kbd>.</kbd> || Same as “Clear field”, but also clears the instrument number if a note event is selected.
|-
| Clear Row and Step || <kbd>Ctrl</kbd>+<kbd>Delete</kbd> || Same as “Clear row”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step || || Same as “Clear field”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step (IT Style) || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Clear field (IT Style)”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Delete Row(s) || <kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; the data is moved up to replace the cleared data, and empty rows are added at the end of the affected channels.
|-
| Delete Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; the data is moved up to replace the cleared data, and empty rows are added at the end of the pattern.
|-
| Delete Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; this also affect all following patterns as no empty rows are inserted.
|-
| Delete Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; this also affect all following patterns as no empty rows are inserted.
|-
| Insert Row(s) || <kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last row of those channels is deleted.
|-
| Insert Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last row of all channels is deleted.
|-
| Insert Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Insert Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Mute Current Channel || <kbd>F10</kbd> || Toggles the sound output (mute) for the channel(s) covered by the current selection.
|-
| Solo Current Channel || <kbd>Ctrl</kbd>+<kbd>F10</kbd> || Toggles the sound output (mute) for all channels except the channel(s) covered by the current selection.
|-
| Unmute All Channels || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F10</kbd> || Unmutes the sound output for all channels.
|-
| (Un)mute Channel on Pattern Transition || || Toggles the sound output (mute) for the channel(s) covered by the current selection, but the change takes place when the current pattern is finished playing.
|-
| Unmute All Channels on Pattern Transition || || Unmutes the sound output for all channels when the current pattern is finished playing.
|-
| Solo Channel on Pattern Transition || || Toggles the sound output (mute) for all channels except the one where the cursor is located, but the change takes place when the current pattern is finished playing.
|-
| Channel Record Select || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Toggles the channel(s) covered by the current selection to belong to the primary record group.
|-
| Channel Split Record Select || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Toggles the channel(s) covered by the current selection to belong to the [[Manual: Keyboard Split|split record]] group.
|-
| Reset Channel || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Stops all note processing, and resets all channel variables to their defaults (volume, panning, etc.) on the selected channel(s).
|-
| Transpose Channel || || Changes the pitch of all notes on the selected channel in all patterns by a selectable amount of semitones.
|-
| Duplicate Channel || || Adds a new channel to the module and carries over all note data from the channel containing the edit cursor to this new channel.
|-
| Add Channel Before Current || || Adds a new empty channel before the channel containing the edit cursor.
|-
| Add Channel After Current || || Adds a new empty channel after the channel containing the edit cursor.
|-
| Remove Current || || Removes the channel containing the edit cursor. If the channel contains any data on any pattern, a confirmation prompt is shown.
|-
| Move Channels to Left || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the left by one channel.
|-
| Move Channels to Right || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the right by one channel.
|-
| Quick Channel Settings || || Opens the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] for the channel where the cursor is located.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the note number of the currently selected notes.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the note number of the currently selected notes.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the octave number of the currently selected notes.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the octave number of the currently selected notes.
|-
| Transpose Custom || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Lowers or raises the selected notes by an arbitrary amount of semitones.
|-
| Transpose Custom (Quick) || || Applies a previously chosen custom transpose amount. If no amount has been chosen before, the behaviour of this shortcut is identical to Transpose Custom.
|-
| Data Entry +1 || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry -1 || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry Up (Coarse) || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Data Entry Down (Coarse) || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Insert New Pattern || || Inserts a new blank pattern after the current pattern, displays it, and moves the cursor to the same position in it. Also functions when cursor focus is in the Order list.
|-
| Duplicate Pattern || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Inserts a new pattern with the current pattern′s contents.
|-
| Split Pattern || || Splits the current pattern at the cursor location.
|-
| Amplify Selection || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens a dialog to change the note volume commands of the selected volume data.
|-
| Interpolate Note || || Transitions smoothly (using all available notes) between notes in the selection, filling in (and replacing if necessary) all rows with new note data.
|-
| Interpolate Instrument || || Transitions smoothly (using all available instrument numbers) between instrument numbers in the selection, filling in all rows with new instrument data.
|-
| Interpolate Volume || <kbd>Ctrl</kbd>+<kbd>J</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new volume effects. The first and last rows of the selection must contain the same volume effect, or one of the two rows might be empty.
|-
| Interpolate Effect || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new effect data. The first and last rows of the selection must contain the same effect, or one of the two rows might be empty. Different effects within the selection are not overwritten.
|-
| Apply Current Instrument || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Applies the current instrument to all cells in the selection that contain note data.
|-
| Apply Current Instrument to Existing Only || || Applies the current instrument to all cells in the selection that contain an instrument numbers. Notes without instrument numbers are not updated.
|-
| Grow Selection || <kbd>Alt</kbd>+<kbd>E</kbd> || “Expands” the selection by doubling the number of the selected rows, and evenly spacing out the event data within it. The expansion will replace event data below it in the same channels as the selection.
|-
| Shrink Selection || <kbd>Alt</kbd>+<kbd>D</kbd> || “Shrinks” the selection by deleting every other row of the selection. However, if only part of any row is selected, the data corresponding to the deleted selected data is also deleted.
|-
| Expand Pattern || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>E</kbd> || “Expands” the entire pattern by doubling the number of the rows, and evenly spacing out the event data within it.
|-
| Shrink Pattern || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>D</kbd> || “Shrinks” the entire pattern by removing every other row.
|-
| Toggle Follow Song || <kbd>F11</kbd> || Toggles the “Follow Song” function.
|-
| Toggle Loop Pattern || <kbd>Shift</kbd>+<kbd>F11</kbd> || Toggles the Loop Pattern feature.
|-
| Play Row || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Process and play only the events in the current row where the cursor is located.
|-
| Go to Row/Channel/… || <kbd>Ctrl</kbd>+<kbd>G</kbd> || Opens the [[Manual: Go To|Go To]] dialog to allow you to jump to a different position in the module.
|-
| Pick Up Nearest Instrument Number || || Seeks for the nearest instrument number in the pattern channel the cursor currently is in. If an instrument number is found, it is set as the currently active instrument.
|-
| Enable Recording || <kbd>Ctrl</kbd>+<kbd>Space</kbd> || Toggles the Event Record feature. When enabled, patterns may be edited.
|-
| Toggle Metronome || <kbd>Alt</kbd>+<kbd>M</kbd> || Toggles the [[Manual: Metronome Settings|Metronome]].
|-
| Set Edit Step on Note Entry || <kbd>Alt</kbd> || The modifier key(s) that, when pressed with digits 0-9, allows you to change the Edit Step amount without using the mouse or moving the cursor focus out of the editor.
|-
| Increase Edit Step || || Increases the Edit Step by one row.
|-
| Decrease Edit Step || || Decreases the Edit Step by one row.
|-
| Switch to Order List || <kbd>Ctrl</kbd>+<kbd>Tab</kbd> || Toggles the cursor focus between the pattern editor and the current pattern in the Pattern Order list. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Toggle PC Event/Instrument Plugin Editor || <kbd>Ctrl</kbd>+<kbd>/</kbd> || Opens the editor for the plugin of the selected Parameter Control Event or instrument number.
|-
| Toggle Channel’s Plugin Editor || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the editor for the current channel′s assigned plugin.
|-
| Show Note Properties || <kbd>▤ Application</kbd> || Opens the [[Manual: Note Properties|Note Properties]] dialog, where you can assign any event data to the current row of the current channel.
|-
| Show Pattern Properties || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Pattern Properties|Pattern Properties]] dialog.
|-
| Split Keyboard Settings Dialog || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Keyboard Split|Keyboard Split]] dialog.
|-
| Open Effect Visualizer || <kbd>Alt</kbd>+<kbd>B</kbd> || Opens the [[Manual: Parameter Editor|Parameter Editor]] dialog.
|-
| Show Chord Editor || || opens the [[Manual: Chord Editor|Chord Editor]] dialog.
|-
| Show Context (Right-Click) Menu || || Opens the edit context menu at the cursor location without using the mouse.
|-
| Show Channel Context (Right-Click) Menu || || Opens the channel context menu at the cursor location without using the mouse.
|-
| Show Channel Plugin Context (Right-Click) Menu || || Opens the plugin context menu of the channel at the cursor location without using the mouse.
|-
| Show Playback Time at Current Row || <kbd>Ctrl</kbd>+<kbd>P</kbd> || Shows the estimated time within the track at the start of the current row.
|-
| Lock Playback to Rows || || If a selection is made, playback is locked to the selected rows. Otherwise, a previous playback lock is removed.
|-
| Quantize Settings || <kbd>Alt</kbd>+<kbd>Q</kbd> || Opens the record quantization settings.
|-
| Toggle row playback when navigating || || Toggles the state of the "play whole row when navigating" feature. The new state of the feature is announced in the status bar.
|-
| Toggle Overflow Paste || || When enabled, pasting will continue to the next pattern if the data overflows the current pattern.
|-
| Toggle Note Off Record (PC Keyboard) || || Toggles the recording of Note Off events from the PC keyboard in the pattern editor (also configurable from the [[Manual: Setup/General#Record note off|General setup]] page).
|-
| Toggle Note Off Record (MIDI) || || Toggles the recording of Note Off events from MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Apply Octave Transpose to incoming MIDI Notes || || Toggles application of the base octave transposition to notes received via MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Continue Song when MIDI Note is received || || Toggles whether pattern playback continues when a note is received via MIDI (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Respond to Play / Continue / Stop Song MIDI messages || || Toggles whether pattern playback starts / stops / continues when the corresponding MIDI commands are received (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Velocity || || Toggles whether MIDI velocity is recorded (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Pitch Bend || || Toggles whether MIDI pitch bends are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI CCs || || Toggles whether MIDI CC events are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Instrument Column Visibility || || Shows or hides the instrument column.
|-
| Toggle Volume Column Visibility || || Shows or hides the volume column.
|-
| Toggle Effect Column Visibility || || Shows or hides the effect column.
|}

=== Note Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the note column (the first column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Base Octave [note] || <kbd>Q</kbd>, <kbd>W</kbd>, ... || Enters a note in the octave indicated in the Octave field.
|-
| Base Octave +1 [note] || <kbd>A</kbd>, <kbd>S</kbd>, ... || Enters a note in the next higher octave indicated in the Octave field.
|-
| Base Octave +2 [note] || <kbd>Z</kbd>, <kbd>X</kbd>, ... || Enters a note two octaves higher than the one indicated in the Octave field.
|-
| Base Octave +3 [note] || || Enters a note three octaves higher than the one indicated in the Octave field.
|-
| Base Octave +4 [note] || || Enters a note four octaves higher than the one indicated in the Octave field.
|-
| Set Octave [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Sets the selected note’s octave.
|-
| Chord Modifier || <kbd>Shift</kbd> || The modifier key(s) that calls a chord rather than a note. The chords are set and assigned in the [[Manual: Chord Editor|Chord Editor]].
|-
| Note Cut || <kbd>`</kbd> || Enters a Note Cut command (^^). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>1</kbd>.
|-
| Note Off || <kbd>=</kbd> || Enters a Note Off command (==). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>Backspace</kbd>.
|-
| Note Fade || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a Note Fade command (~~). Note: The default shortcut is position-independent and is bound to the key that is usually lef of <kbd>Backspace</kbd>.
|-
| Parameter Control || <kbd>Shift</kbd>+<kbd>-</kbd> || Enters an absolute [[Manual:_Parameter_Control_Events|Parameter Control event]] (PC). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
| Parameter Control (Smooth) || <kbd>-</kbd> || Enters a smooth sliding Parameter Control event (PCs). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
|}

=== Instrument Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the instrument column (the second column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Instrument Digit [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the instrument field, moving the existing digits to the left.
|-
|}

=== Volume Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the volume column (the third column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Volume Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left.
|-
| Set Volume Digit [A - F] || || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left. By default, volume column parameters are shown in decimal and these shortcuts are not assigned. You can use them after enabling the [[Manual: Hidden Settings#.5BPattern Editor.5D|Pattern Editor.VolumeColumnInHex]] hidden setting.
|-
| Volume Command - Volume || <kbd>V</kbd> || Enters a note volume (vxx) command into the pattern.
|-
| Volume Command - Panning || <kbd>P</kbd> || Enters a panning command (pxx) into the pattern.
|-
| Volume Command - Volume Slide Up || <kbd>C</kbd> || Enters volume slide up (cxx) into the pattern.
|-
| Volume Command - Volume Slide Down || <kbd>D</kbd> || Enters a volume slide down (dxx) into the pattern.
|-
| Volume Command - Fine Volume Slide Up || <kbd>A</kbd> || Enters a fine volume slide up (axx) into the pattern.
|-
| Volume Command - Fine Volume Slide Down || <kbd>B</kbd> || Enters a fine volume slide down (bxx) into the pattern.
|-
| Volume Command - Vibrato Speed || <kbd>U</kbd> || Enters a vibrato speed command (uxx) into the pattern.
|-
| Volume Command - Vibrato Depth || <kbd>H</kbd> || Enters a vibrato depth command (hxx) into the pattern.
|-
| Volume Command - XM Pan Slide Left || <kbd>L</kbd> || Enters a pan slide to the left (lxx) into the pattern.
|-
| Volume Command - XM Pan Slide Right || <kbd>R</kbd> || Enters a pan slide to the right (rxx) into the pattern.
|-
| Volume Command - Tone Portamento || <kbd>G</kbd> || Enters a tone portamento command (gxx) into the pattern.
|-
| Volume Command - Portamento Up || <kbd>F</kbd> || Enters a pitch bend up command (fxx) into the pattern.
|-
| Volume Command - Portamento Down || <kbd>E</kbd> || Enters a pitch bend down command (exx) into the pattern.
|-
| Volume Command - Offset || <kbd>O</kbd> || Enters a coarse sample offset command (oxx) into the pattern.
|-
|}

=== Effect Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect column (the fourth column). Alphanumeric effect letters (0-9, A-Z) are currently not editable — they are automatically assigned to the respective keys on your keyboard.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Smooth MIDI Macro Slide || <kbd>\</kbd> || Enters a Smooth MIDI Macro Slide (\xx) into the pattern.
|-
| Combined Note Delay and Note Cut || <kbd>;</kbd>, <kbd>Shift</kbd>+<kbd>;</kbd> || Enters a Delay-Cut (:xy) command into the pattern.
|-
| Parameter Extension Command || <kbd>/</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Parameter Extension Command]] (#xx) into the pattern.
|-
| Finetune || <kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Finetune Command]] (+xx) into the pattern.
|-
| Finetune (Smooth) || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Smooth Finetune Command]] (*xx) into the pattern.
|-
|}

=== Effect Parameter Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect parameter column (the fifth column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Effect Parameter Digit [0 – F] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd>, <kbd>A</kbd>-<kbd>F</kbd> || Enters the digit into the rightmost place in the effect parameter field, moving the existing digits to the left.
|-
|}

== Sample Editor ==

These shortcuts are applied when the [[Manual: Samples|Samples Tab]] is active.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Trim Sample around Loop Points || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Trims the sample to the selection, if there is one. Otherwise, if loop points are specified, all sample data outside of these start/end times are deleted.
|-
| Trim to Loop End || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>T</kbd> || If loop points are specified, all sample data past the loop end is deleted.
|-
| Silence Sample Selection || <kbd>Backspace</kbd> || All of the sample data within the selected area is set to zero, effectively placing silence in that span.
|-
| Normalize Sample || <kbd>Shift</kbd>+<kbd>N</kbd> || Applies Normalisation to the sample.
|-
| Amplify Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens the [[Manual: Amplify|Amplify]] dialog, allowing you to alter the volume of the sample and apply Fade In or Fade Out (from / to silence).
|-
| Reverse Sample || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>R</kbd> || Puts the selected sample data in reverse order, so it is being played backwards.
|-
| Delete Sample Selection || <kbd>Delete</kbd> || Deletes the sample data within the selection, moving the remaining data together.
|-
| Toggle Sample Drawing || || Turns sample drawing mode on or off.
|-
| Add Silence / Create Sample || || Opens the dialog for adding silence, resizing samples and initializing FM instruments.
|-
| Configure Sample Grid || || Opens the dialog for setting the sample grid properties.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the data-to-display ratio, effectively zooming in to show more graphic detail of the sample data.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the data-to-display ratio, effectively zooming out to show less graphic detail of the sample data.
|-
| Zoom into Selection || <kbd>Space</kbd> || Zooms so much into the sample data that the current selection covers as much of the sample display as possible. If no selection has been made, auto-zoom is enabled.
|-
| Zoom into Sample Start || <kbd>1</kbd> || Zooms into the sample and ensures that the sample start is visible in the view.
|-
| Zoom into Sample End || <kbd>2</kbd> || Zooms into the sample and ensures that the sample end is visible in the view.
|-
| Center Loop Start in View || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Ensures that the normal sample loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Loop End in View || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Ensures that the normal sample loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop Start in View || <kbd>Ctrl</kbd>+<kbd>3</kbd> || Ensures that the sample sustain loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop End in View || <kbd>Ctrl</kbd>+<kbd>4</kbd> || Ensures that the sample sustain loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Convert Ping-Pong Loop to Unidirectional || || Turns a bidi-looped sample loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Convert Ping-Pong Sustain Loop to Unidirectional || || Turns a bidi-looped sustain loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Toggle Loop || || Switches the sample loop to the next supported loop type (off, on, bidi).
|-
| Toggle Sustain Loop || || Switches the sustain loop to the next supported loop type (off, on, bidi).
|-
| Convert to 8-bit / 16-bit || <kbd>Ctrl</kbd>+<kbd>8</kbd> || Changes the sample’s bit depth between 8-bit and 16-bit.
|-
| Convert to Mono (Mix) || <kbd>Shift</kbd>+<kbd>M</kbd> || Mixes the left and right channels of a stereo sample equally together.
|-
| Convert to Mono (Left Channel) || <kbd>Shift</kbd>+<kbd>L</kbd> || Only keeps the left channel of a stereo sample.
|-
| Convert to Mono (Right Channel) || <kbd>Shift</kbd>+<kbd>R</kbd> || Only keeps the right channel of a stereo sample.
|-
| Convert to Mono (Split Sample) || <kbd>Shift</kbd>+<kbd>S</kbd> || Create two sample slots for this sample, one containing only the left channel and the other containing just the right channel. If the sample is referenced by an instrument, this instrument is duplicated as well for the right channel.
|-
| Change Stereo Separation || <kbd>Shift</kbd>+<kbd>P</kbd> || Adjusts the stereo separation of the sample by a given amount, either widening or narrowing the stereo width.
|-
| Upsample || <kbd>Shift</kbd>+<kbd>F</kbd>|| Doubles the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Downsample || <kbd>Shift</kbd>+<kbd>G</kbd>|| Halves the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Resample || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Changes the sample’s middle-C frequency to a new arbitrary frequency.
|-
| Invert Sample Phase || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Inverts the sample’s phase, i.e. it is mirrored along the time axis.
|-
| Signed / Unsigned Conversion || <kbd>Ctrl</kbd>+<kbd>U</kbd> || Re-interprets the sample data as a signed or unsigned sample.
|-
| Remove DC Offset || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Removes an unwanted static DC Offset from the waveform, i.e. it is centered around the time axis.
|-
| Quick Fade || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Applies a fade-in for the selected sample data if the selection includes the beginning of the sample, or applies a fade-out if the selection includes the end of the sample. If neither the beginning or end of the waveform is part of the selection, the Amplify dialog is shown.
|-
| Crossfade Sample Loop || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Opens the Crossfade Loop dialog to crossfade the sample loop’s end with the loop start, to create seamless loop transitions.
|-
| Tune Sample to Given Note || || Opens the [[Manual: Sample Tuner|Sample Tuner]] dialog, where the sample can be tuned to a given note.
|-
| Load Sample || <kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. This command also works in the Instrument Tab, importing an instrument to the current Instrument slot.
|-
| Load Raw Sample || <kbd>Shift</kbd>+<kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. The [[Manual: Raw Sample Import|Raw Sample Import]] is shown, ignoring the sample format even if it is known to OpenMPT.
|-
| Save Sample || || Opens the Save File dialog to allow you to save the sample as a Wave Audio or Raw file into a folder of your choice. This command also works in the Instrument Tab, saving the instrument and its accompanying samples as an .iti, .xi or .sfz file.
|-
| New Sample || || Creates a blank sample in the next unused slot. This command also works in the Instrument Tab.
|-
| Duplicate Sample || || Duplicates the current sample slot into the next unused slot.
|-
| Initialize OPL Instrument || || Configures the current sample slot to be a synthesized OPL instrument and recalls the default instrument parameters.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises the middle-C frequency by one semitone.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers the middle-C frequency by one semitone.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises (doubles) the middle-C frequency by one octave.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers (halves) the middle-C frequency by one octave.
|-
| Increment Finetune || <kbd>Shift</kbd>+<kbd>Up</kbd> || Raises the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Decrement Finetune || <kbd>Shift</kbd>+<kbd>Down</kbd> || Lowers the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Toggle Follow Sample Play Cursor|| <kbd>Shift</kbd>+<kbd>F</kbd> || Cycles through all three [[Manual: Setup/Samples#Automatic Scrolling when_Zoomed-In|sample playback cursor follow modes]]. The new follow mode is announced in the status bar.
|-
| Preview / Set Sample Cue [1 - 9] || <kbd>Shift</kbd>+<kbd>1</kbd>-<kbd>9</kbd> || Previews the sample at middle-C, starting from the chosen cue point. If the cue point is unset and the sample is currently being previewed, the cue point is set to the current play position.
|-
| Slice at Cue Points || || Creates new samples from the current sample by splitting the sample at its cue points.
|-
|}

== Instrument Editor ==

These shortcuts are applied when the [[Manual: Instruments#Sample Map|Sample Map]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Duplicate Instrument || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Creates a new instrument slot using ''all'' the same instrument attributes as the currently displayed instrument.
|-
| Edit Sample Map || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Sample Map|Sample Map]] dialog.
|-
| Edit Current Sample || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the Samples page of the currently selected sample slot.
|-
| Map All Notes to Selected Note || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected note to all notes.
|-
| Map All Notes to Selected Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected sample slot to all notes.
|-
| Reset Note Mapping || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Resets the note assignments, so that each note maps to itself (C-5 → C-5, D-5 → D-5, and so on).
|-
| Remove All Samples || || Removes any sample associations from the instrument.
|-
| Transpose +1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one semitone.
|-
| Transpose -1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one semitone.
|-
| Transpose +1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one octave.
|-
| Transpose -1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one octave.
|-
|}

=== Envelope Editor ===

These shortcuts are applied when the [[Manual: Instruments#Envelope Editor|envelope editor]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Load Envelope || || Replaces the currently active envelope with an envelope from disk.
|-
| Save Envelope || || Stores the currently active envelope to disk.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the detail of the Envelope Window, showing a smaller excerpt of the envelope.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the detail of the Envelope Window, showing a bigger excerpt of the envelope.
|-
| Scale Envelope Points || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Scale Envelope Points|Scale Envelope Points]] dialog.
|-
| Switch to Volume Envelope || <kbd>Shift</kbd>+<kbd>M</kbd> || Selects the Volume Envelope for editing.
|-
| Switch to Panning Envelope || <kbd>Shift</kbd>+<kbd>P</kbd> || Selects the Panning Envelope for editing.
|-
| Switch to Pitch / Filter Envelope || <kbd>Shift</kbd>+<kbd>I</kbd> || Selects the Pitch / Filter Envelope for editing.
|-
| Toggle Volume Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd> || Enables or disables the Volume Envelope.
|-
| Toggle Panning Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> || Enables or disables the Panning Envelope.
|-
| Toggle Pitch Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> || Enables or disables the Pitch Envelope.
|-
| Toggle Filter Envelope || <kbd>Shift</kbd>+<kbd>F</kbd> || Enables or disables the Filter Envelope.
|-
| Toggle Envelope Loop || <kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Loop.
|-
| Select Envelope Loop Start || <kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope loop start.
|-
| Select Envelope Loop End || <kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope loop end.
|-
| Toggle Envelope Sustain Loop || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Sustain Loop.
|-
| Select Envelope Sustain Start || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope sustain start.
|-
| Select Envelope Sustain End || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope sustain end.
|-
| Toggle Envelope Carry || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Enables or disables the Envelope Carry.
|-
| Select Previous Envelope Point || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the selection to the previous envelope point.
|-
| Select Next Envelope Point || <kbd>Tab</kbd> || Moves the selection to the following envelope point.
|-
| Move Envelope Point Left || <kbd>Left</kbd> || Moves the selected envelope point left one tick.
|-
| Move Envelope Point Left (Coarse) || <kbd>Shift</kbd>+<kbd>Left</kbd> || Moves the selected envelope point left one beat.
|-
| Move Envelope Point Right || <kbd>Right</kbd> || Moves the selected envelope point right one tick.
|-
| Move Envelope Point Right (Coarse) || <kbd>Shift</kbd>+<kbd>Right</kbd> || Moves the selected envelope point right one beat.
|-
| Move Envelope Point Up || <kbd>Up</kbd> || Moves the selected envelope point up one unit.
|-
| Move Envelope Point Up (Coarse) || <kbd>PageUp</kbd> || Moves the selected envelope point up 8 units.
|-
| Move Envelope Point Down || <kbd>Down</kbd> || Moves the selected envelope point down one unit.
|-
| Move Envelope Point Down (Coarse) || <kbd>PageDown</kbd> || Moves the selected envelope point down 8 units.
|-
| Insert Envelope Point || <kbd>Insert</kbd> || Inserts an envelope point after the selected point.
|-
| Remove Envelope Point || <kbd>Delete</kbd>, <kbd>Backspace</kbd> || Deletes the selected envelope point.
|-
| Set Loop Start || <kbd>Home</kbd> || Sets the selected envelope point as the Envelope Loop start point.
|-
| Set Loop End || <kbd>End</kbd> || Sets the selected envelope point as the Envelope Loop end point.
|-
| Set Sustain Loop Start || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Sets the selected envelope point as the Sustain Loop start point.
|-
| Set Sustain Loop End || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Sets the selected envelope point as the Sustain Loop end point.
|-
| Toggle Release Node || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the selected envelope point as the start point for the Release Envelope.
|-
|}

== Comments [Bottom] ==

These shortcuts are applied when the lower half of the [[Manual: Comments|Comments tab]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Toggle Between Lists || <kbd>Tab</kbd> || Toggles between the sample and instrument list.
|-
| Open Item in Editor || <kbd>Enter</kbd> || Switches to the sample or instrument editor to edit the currently selected item.
|-
| Rename Item || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Brings up an edit box for renaming the selected sample or instrument.
|-
|}

== Plugin Editor ==

These shortcuts are applied when a [[Manual: Plugin Window|plugin window]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Plugin Preset || <kbd>Numpad-</kbd> || Selects the previous plugin preset / patch.
|-
| Next Plugin Preset || <kbd>Numpad+</kbd> || Selects the following plugin preset / patch.
|-
| Plugin Preset Backward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad-</kbd> || Jumps back 10 entries in the preset list.
|-
| Plugin Preset Forward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad+</kbd> || Jumps forward 10 entries in the preset list.
|-
| Randomize Plugin Parameters || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>D</kbd> || Give random values to all parameters of the current plugin.
|-
| Toggle Parameter Recording || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the parameter recording function, which allows you to record parameter changes from plugin window into the pattern.
|-
| Record MIDI Out to Pattern Editor || || Toggles the MIDI Out recording function, which allows you to route the plugin’s MIDI output to the pattern, sample or instrument editor.
|-
| Pass Key Presses to Plugin || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Toggles the Pass Keys function, which sends all keyboard input to the currently open plugin window (e.g. for entering a serial number in the plugin GUI).
|-
| Bypass Plugin || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Toggles plugin’s bypass property to control whether audio is routed through the plugin or not.
|}

== Tree View ==

These shortcuts are applied when the [[Manual:_Tree_View|Tree View]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Switch between Upper / Lower Tree View || <kbd>Tab</kbd> || Switches focus between the upper and lower panel of the Tree View.
|-
| Open / View Item || <kbd>Enter</kbd> || Opens / views / previews the selected item (same action as double-click).
|-
| Play Item || <kbd>Space</kbd> || Previews the selected item if it is a sample, instrument or file.
|-
| Insert Item || <kbd>Insert</kbd> || Inserts an empty item (e.g. sample or instrument slot) after the currently selected item.
|-
| Duplicate Item || <kbd>Shift</kbd>+<kbd>Insert</kbd> || Duplicates the currently selected item (e.g. sample or instrument slot).
|-
| Delete Item || <kbd>Delete</kbd> || Deletes the currently selected item.
|-
| Delete Item Permanently || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Delete Item”, but if the selected item is a file, it will not be moved to the recycling bin.
|-
| Rename Item / Send To Editor || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items belonging to an open module (e.g. patterns, samples, instruments, ...): The selected item is renamed. For items in the instrument library: The item is sent to the last active sample or instrument editor and replaces the currently selected sample or instrument.
|-
| Send To Editor (Insert New) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items in the instrument library: The item is sent to the last active sample or instrument editor and is loaded into a new sample or instrument slot.
|-
| Go to Parent Folder || <kbd>Backspace</kbd> || Changes the instrument library folder to the current location′s parent folder.
|-
| Find in Instrument Library || <kbd>Ctrl</kbd>+<kbd>F</kbd>|| Opens the search filter to quickly locate files and folders in the instrument library.
|-
| Sort Instrument Library By Name || || Items in the instrument library are sorted by their file name.
|-
| Sort Instrument Library By Date || || Items in the instrument library are sorted by their last file modification date.
|-
| Sort Instrument Library By Size || || Items in the instrument library are sorted by their file size.
|}

[[Category:Manual|Keyboard Actions]]

Development: Test Cases/IT

2025-07-12T21:18:46Z

Saga Musix: VolColNoSlideMemoryPropagation.it

{{Testsuite Introduction|format=IT|tracker=Impulse Tracker}}

{{Testcase|format=it|name=Autovibrato-Reset.it|pass=???}}
The autovibrato sweep is not reset when using portamento.

{{Testcase|format=it|name=Bidi-Loops.it|pass=793}}
In Impulse Tracker’s software mixer, ping-pong loops are shortened by one sample. This does not happen with the GUS hardware driver, but I assume that the software drivers were more popular due to the limitations of the GUS, so OpenMPT emulates this behaviour.

{{Testcase|format=it|name=BidiPrecision.it|pass=15871}}
An extension to [[#Bidi-Loops.it|Bidi-Loops.it]], this test verifies that the loop length of ping-pong loops is precise. The test is not required to stay absolutely silent, but the two channels may not phase, i.e. the sound should be a static buzz.

{{Testcase|format=it|name=CarryNNA.it|pass=1503 + 22849}}
This is a very interesting test case, because it actually sounds different when using Impulse Tracker’s WAV writer and Sound Blaster (and probably other drivers) output (the Sound Blaster 16 MMX driver also follows the behaviour of the WAV writer, to make things even more confusing).
The main difference is that the Sound Blaster driver will only consider the envelope carry flag if the New Note Action is not “Note Cut”. The WAV writer does not check for the NNA and will always apply the carry flag if it’s set. OpenMPT goes after the WAV writer, while e.g. XMPlay used the Sound Blaster behaviour for the volume and panning envelope, but the WAV writer’s behaviour for the filter envelope (because of a bug report some years ago) up until 2016. Obviously it is hard to consider which of the two behaviours is correct, so I would just say that both are. :) However, the WAV writer behaviour definitely is more useful (not being able to use Envelope Carry despite it being enabled is quite misleading), I strongly encourage everyone to implement this behaviour.

The reason for the difference is most likely that the non-MMX Sound Blaster driver does not volume-ramp cut notes, while the MMX driver and WAV writer do. The volume ramping requires a NNA channel to be set up, which is a precondition for the envelope carry code to work.

{{Testcase|format=it|name=cut-carry.it|pass=1165}}
Envelopes that have the carry flag set cannot be “picked up” / continued after the note has been cut.

{{Testcase|format=it|name=dct_smp_note_test.it|pass=12819}}
Instrument Duplicate Check Type “Sample” should only be carried out if the old and new instrument match (like all other check types). 
Instrument Duplicate Check Type “Note” should compare the old and new pattern note, not translated notes according to the instrument’s mapping. 

{{Testcase|format=it|name=DNA-NoInstr.it|pass=6311}}
OpenMPT previously did not properly check for the correct sample slot or sample map entry in DNA and NNA checks if no instrument number was provided. This testcase should remain silent when played correctly, i.e. both the first and second note on channel 1 should sound until the end of the pattern.

{{Testcase|format=it|name=DoubleSlide.it|pass=21807}}
Impulse Tracker generally initializes effect parameters, effect working memory and similar stuff once per row, before the effects actually run. When using (tone) portamento commands simulatenously in the effect column and volume column, this can lead to surprising results, and in order to emulate them correctly, it is crucial to implement the effect memory initialization in the exact same order as Impulse Tracker does:

# Evaluate effect column Gxx parameter
# Evaluate volume column gx parameter
# Evaluate volume column ex / fx parameter
# Evaluate effect column Exx / Fxx parameter

If played correctly, The left and right channel of this module should sound identical. The last few rows should stay silent.

{{Testcase|format=it|name=DoubleSlideCompatGxx.it|pass=21807}}
A variation of of [[#DoubleSlide.it|DoubleSlide.it]] with the Compatible Gxx flag turned on. The same rules as above apply, but since portamento up / down and tone portamento memory is not linked, there are some natural differences in handling.

{{Testcase|format=it|name=empty_sample_offset.it|pass=6343}}
In instrument mode, if an offset effect is found next to a note that maps to an invalid sample slot, the offset and illegal note should be ignored completely. Note that this behaviour is different from sample mode, where a previously playing sample will be stopped.

{{Testcase|format=it|name=emptyslot.it|pass=1671}}
I think, Impulse Tracker treats instruments like an additional layer of abstraction and first replaces the note and instrument in the pattern by the sample and note assignments from the sample map table before further evaluating the pattern. That would explain why for example the empty sample map slots do nothing in this module.

{{Testcase|format=it|name=env-flt-max.it|pass=1090 (?)}}
If resonance is not applied, the filter envelope’s maximum value does not ''enable'' any filtering. However, it also does not ''disable'' any filtering when returning from a non-maximum point. This pretty much works like Zxx commands.

{{Testcase|format=it|name=EnvLoopEscape.it|pass=4009}}
I created [[#EnvOffLength.it|EnvOffLength.it]] without realizing that it is essentially the same bug as this one.

{{Testcase|format=it|name=EnvLoops.it|pass=1213}}
In this test, all possible combinations of the envelope sustain point and envelope loops are tested, and you can see their behaviour on note-off.
If the sustain point is at the loop end and the sustain loop has been released, don't loop anymore.
Probably the most important thing for this test is that in Impulse Tracker (and Fasttracker 2), envelope position is incremented before the point is evaluated, not afterwards, so when no ticks have been processed yet, the envelope position should be invalid.

{{Testcase|format=it|name=EnvOffLength.it|pass=4009}}
If an envelope sustain loop happens to end on exactly the same tick as a note-off event occurs, the envelope is not yet released. It will be released whenever the loop end is being hit again.

{{Testcase|format=it|name=EnvReset.it|pass=1481}}
Impulse Tracker resets envelopes under some more or less weird conditions. This tests some of them.

{{Testcase|format=it|name=extreme-filter-test-1.it|pass=1090}}
If resonant filters are rendered with integer arithmetic, they may produce scratching noises in some edge cases. You should not hear any scratches or other weird noises when playing this example.

{{Testcase|format=it|name=extreme-filter-test-2.it|pass=1090}}
Same as the above test case. xmp breaks this module’s output even more than older versions of OpenMPT.

{{Testcase|format=it|name=Fade-Porta.it|pass=1144}}
After a note has been stopped in some way (for example through fade-out or note cut), tone portamento effects on the following note are ignored, i.e. there is no portamento from the stopped note to the new note.

{{Testcase|format=it|name=filter-7F.it|pass=1090 (?)}}
A small test case that demonstrates that full cutoff should not enable the filter if no resonance is applied. Resonance is only ever applied if the cutoff is not full or the resonance is not zero.

{{Testcase|format=it|name=FilterEnvReset.it|pass=1132}}
A cutoff value of 0 should not be reset to full cutoff when triggering a note just because the filter envelope is enabled. This bug is probably very specific to OpenMPT, because it gets rid of some unneccessary code.

{{Testcase|format=it|name=FilterPortaSmpChange.it|pass=18417}}
Normally Impulse Tracker does not disable the filter on portamento if cutoff was previously at 127 and resonance at 0, but in sample mode that is not the case when the new note plays a different sample.

{{Testcase|format=it|name=FilterPortaSmpChange-InsMode.it|pass=?}}
Complementary test for [[#FilterPortaSmpChange.it|FilterPortaSmpChange.it]] in instrument mode. Here the cutoff should never be reset on portamento.

{{Testcase|format=it|name=filter-nna.it|pass=1169}}
This test is just there to be sure that the filter-reset.it and filter-reset-carry.it test cases do not break NNA background channels.

{{Testcase|format=it|name=filter-reset.it|pass=1165}}
As mentioned already, filtering is only ever done in IT if either cutoff is not full or if resonance is set. When a Z7F command is found next to a note and no portamento is applied, it ''disables'' the filter, however in other cases this should not happen.

{{Testcase|format=it|name=filter-reset-carry.it|pass=1165}}
I think this is also just an extenion to the previous test case, to make sure that it does not break anything else.

{{Testcase|format=it|name=filter-reset-envelope.it|pass=16016}}
This test checks that the filter is reset correctly for delayed filtered notes, and also acts as a regression test for [[#filter-reset.it|filter-reset.it]], because the first implementation for this test broke the other test. The output should stay silent (small pops are okay).

{{Testcase|format=it|name=FilterResetPatDelay.it|pass=16137}}
An extension of [[#filter-reset-envelope.it|filter-reset-envelope.it]], this verifies the filter reset behaviour on rows with a Pattern Delay. The filter reset logic should only be applied on rows that are actually retriggering the note: If there is no note delay, the note is retriggered only on the first tick. If there is a note delay, the note is retriggered on every repetition of that row (see [[#PatternDelay-NoteDelay.it|PatternDelay-NoteDelay.it]]).

{{Testcase|format=it|name=FineVolColSlide.it|pass=2400}}
Unlike fine volume slides in the effect column, fine volume slides in the volume column are only ever executed on the first tick — not on multiples of the first tick if there is a pattern delay. Thus, the left and right channel of this example should always have the same volume.

{{Testcase|format=it|name=flt-env-carry.it|pass=693 (?)}}
Envelope carry on the filter envelope. I think this is just a general test on how envelope carry is applied. It is possible that Impulse Tracker’s MMX drivers will play this in a different way from the WAV writer.

{{Testcase|format=it|name=fltmacro.it|pass=???}}
This test uses a custom macro configuration that uses the instrument volume to control the filter cutoff. A correctly implemented MIDI Macro system should pass this test.

{{Testcase|format=it|name=freqreset-noins.it|pass=325}}
When using multisample instruments, even notes with no instrument number next to them can change the sample (based on the active instrument’s sample map). When switching between samples, you must not forget to update the C-5 frequency of the playing sample as well.

{{Testcase|format=it|name=GlobalVolFirstTick.it|pass=6362}}
Set Global Volume (Vxx) should be applied on the first tick (and multiples in case of pattern delays). If played correctly, the first and second row of this module should sound more or less identical, i.e. each row should play 16 fading notes.

{{Testcase|format=it|name=globalvol-invalid.it|pass=290}}
Out-of-range global volume commands (V81...VFF) should not change the current global volume. This test module should remain completely silent.

{{Testcase|format=it|name=GlobalVolume-Macro.it}}
Global volume, channel volume and various other parameters are taken into account when interpreting the 'u' and 'v' letters in MIDI macros. However, this feature seems to be quirky, and I have decided not to support these quirks in OpenMPT, as I do not think that anyone used this feature in Impulse Tracker very much and I would want it to work in a sane way when using it to control instrument plugins in OpenMPT. The quirks are:
* Channel and global volume seem to be applied one row after they have been set. This does not seem to be the whole truth, though, as looking at pattern 0, row 9, you should hear that IT applies the M40 channel volume change on row 10.
* Instrument / sample volume also seems to be applied one row late when using the 'u' macro, but not the 'v' macro (compare first and second pattern, row 15 - 22 each).
There are also some problems with volume swing which might be fixed later.

{{Testcase|format=it|name=gxsmp.it|pass=1671}}
Another test case with an empty sample map slot which is simply ignored by Impulse Tracker.

{{Testcase|format=it|name=gxsmp2.it|pass=1671}}
Going one step further by also changing the sample next to that portamento.

{{Testcase|format=it|name=gxxtest.it|pass=4330}}
And another similar test.

{{Testcase|format=it|name=InitialNoteMemory.it|pass=18838}}
The initial "last note" memory of each channel in Impulse Tracker is initialized to C-0. So the first lone instrument number without any note next to it will play a C-0 of that instrument.

{{Testcase|format=it|name=InitialNoteMemoryInstrMode.it|pass=18838}}
A variation of [[#InitialNoteMemory.it|InitialNoteMemory.it]], but in instrument mode. The lowest note of instrument 1 has no sample association, which will also cause subsequent notes without instrument number to not play.

{{Testcase|format=it|name=ins-flt-porta-reset.it|pass=???}}
Instrument filter settings should not be applied if there is a portamento effect.

{{Testcase|format=it|name=ins-oc.it|pass=11293 + 22849}}
Instrument number resets envelope behaviour test with Old Effects enabled, Compatible Gxx enabled: Always reset envelopes.

Note: Some output drivers play the instruments with Envelope Carry enabled differently in Impulse Tracker (see [[#CarryNNA.it|CarryNNA.it]] for an explanation why this happens). A previous version of this test reflected the behaviour of those drivers, but technically for the wrong reason (they relied on a bug / misunderstanding of the Carry feature in OpenMPT). As this OpenMPT bug was fixed, the test case was adjusted to follow the WAV writer / SB16 MMX driver behaviour.

{{Testcase|format=it|name=ins-ox.it|pass=11293 + 22849}}
Instrument number resets envelope behaviour test with Old Effects enabled, Compatible Gxx disabled: Reset envelopes if there is no tone portamento.

Note: Some output drivers play the instruments with Envelope Carry enabled differently in Impulse Tracker (see [[#CarryNNA.it|CarryNNA.it]] for an explanation why this happens). A previous version of this test reflected the behaviour of those drivers, but technically for the wrong reason (they relied on a bug / misunderstanding of the Carry feature in OpenMPT). As this OpenMPT bug was fixed, the test case was adjusted to follow the WAV writer / SB16 MMX driver behaviour.

{{Testcase|format=it|name=ins-xc.it|pass=11293 + 22849}}
Instrument number resets envelope behaviour test with Old Effects disabled, Compatible Gxx enabled: Reset envelopes if there is a tone portamento.

Note: Some output drivers play the instruments with Envelope Carry enabled differently in Impulse Tracker (see [[#CarryNNA.it|CarryNNA.it]] for an explanation why this happens). A previous version of this test reflected the behaviour of those drivers, but technically for the wrong reason (they relied on a bug / misunderstanding of the Carry feature in OpenMPT). As this OpenMPT bug was fixed, the test case was adjusted to follow the WAV writer / SB16 MMX driver behaviour.

{{Testcase|format=it|name=ins-xx.it|pass=0}}
Instrument number resets envelope behaviour test with Old Effects disabled, Compatible Gxx disabled: Never reset envelopes.

{{Testcase|format=it|name=InstrAfterMultisamplePorta.it|pass=7465}}
A lone instrument number should only reset sample properties to those of the corresponding sample in instrument mode. Example:
C#5 01 ... <-- sample 1
C-5 .. g02 <-- sample 2
... 01 ... <-- still sample 1, but with properties of sample 2
In the above example, no sample change happens on the second row. In the third row, sample 1 keeps playing but with the volume and panning properties of sample 2.

{{Testcase|format=it|name=InstrumentNumberChange.it|pass=1902}}
While Impulse Tracker cuts playing samples if it encounters an invalid sample number in sample mode, the same does not happen if we are in instrument mode.

{{Testcase|format=it|name=JxxTicks.it|pass=1537}}
Impulse Tracker’s arpeggio logic is pretty sane compared to some other trackers, but one detail should be kept in mind: Pattern Delays reset the tick counter, but it keeps incrementing with Fine Pattern Delays. The arpeggio sequence thus resets every (ticks per row + fine pattern delay) ticks.

{{Testcase|format=it|name=LinearSlides.it|pass=4330}}
Impulse Tracker internally uses actual frequency values, while Fasttracker 2 still uses exponentially scaled fine Amiga periods. When doing fine slides, errors from using periods instead of frequency can add up very quickly, and thus the two channel's frequency in this test will converge noticeably.

{{Testcase|format=it|name=LoopBreak.it|pass=5413}}
A pattern break (Cxx) on the same row as the end of a pattern loop (SBx) repeats the pattern loop x times and then jumps to the desired row. However, a position jump (Bxx) on the same row as the end of a pattern loop prevents the loop from being executed if it is right of the SBx effect. In this test, the left and right channel of the module should produce the same click patterns.

{{Testcase|format=it|name=LoopStartAfterPatternEnd.it|pass=7791}}
Since the start row of a pattern loop is not reset on pattern transitions, it is possible to use a loop start past the end of the current pattern when using a pattern loop without explicit start command (SB0). In this case, playback should continue in the next pattern. In the example, this happens because the loop start is set to one row after the loop end after properly terminating the loop in pattern 0.

{{Testcase|format=it|name=LxxWith0Portamento-Amiga.it|pass=r22552}}
A strange edge case when using Lxx (Volume Slide + Tone Portamento) while the tone portamento effect memory is 0: The tone portamento comamnd is not initialized properly in this case, causing it always to assume that it's trying to execute a portamento down. If the current note is below the note to which the tone portamento would lead, this causes the note to immediately jump to the target note. If the current note is above the target note, nothing happens.

{{Testcase|format=it|name=LxxWith0Portamento-Linear.it|pass=r22552}}
Same as [[#LxxWith0Portamento-Amiga.it|LxxWith0Portamento-Amiga.it]], but with linear slides. The difference is that when the current note is above the target note, the frequency is decremented by 1 Hz on every tick (linear slides always slide by at least 1 Hz).

{{Testcase|format=it|name=macro-lastnote.it|pass=947 (?)}}
A test of the MIDI macro letter “n”. This letter will always send the MIDI note value of the last triggered note, note cuts and similar “notes” are not considered. This module should remain silent as both channels should receive exactly the same cutoff values.

{{Testcase|format=it|name=MacroExtendedParam.it|pass=16715}}
Even fixed macros (Z80-ZFF) can contain the letter “z”, which inserts the raw command parameter into the macro (i.e. a value in [80, FF[). In this file, macro ZF0 is used to insert byte F0 into the string. This way, two MIDI messages to set both the filter cutoff and resonance to 60h are created, which are the same filter settings as used in instrument 2, so the module should stay silent.

{{Testcase|format=it|name=MultiZxx.it|pass=947 (?)}}
A MIDI macro can contain more than one MIDI message. In this case, the Z90 macro sets both the filter cutoff frequency and resonance, so if only the first MIDI message is considered in this macro, the module will no longer stay silent at row 8.

{{Testcase|format=it|name=NoMap.it|pass=1671}}
Yet another sample map test case. Why are there so many of them? They are all fixed by the same code...

{{Testcase|format=it|name=NoMapEffects.it|pass=20790 + 20820}}
Empty instrument note map slots are truly one of the most mysterious parts of Impulse Tracker’s reply routines. This particular test started out to verify that a currently playing instrument’s envelopes are not reset by sample-less note map slots, but it quickly evolved into a complete nightmare. In this test you see many global effects, and not a single one of them does anything. They do not jump around in the pattern, they do not modify the tempo. Anything in a cell where a sample-less note map slot is hit is ignored completely. This also affects the first row of the module due to [[#InitialNoteMemory.it|InitialNoteMemory.it]] - this mechanism also takes previously triggered notes into account. Only on row 3 it does not apply, because Note Off / Note Cut / Note Fade invalidate the previously triggered note.

All in all, this absolutely crazy test case should play identically on the left and right channel.

{{Testcase|format=it|name=NoSlide.it|pass=???}}
This seems to be just a fancy test of portamento from a stopped note, but in this case an empty sample slot assigned to the same instrument was played before.

{{Testcase|format=it|name=NoteFade-SmpMode.it|pass=317}}
A “note fade” note (any invalid note) should not do anything in sample mode. The sample should not be stopped.

{{Testcase|format=it|name=NoteFade-InsMode.it|pass=317}}
A “note fade” note (any invalid note) should fade out the instrument using its fadeout value.

{{Testcase|format=it|name=noteoff2.it|pass=??? + 5829}}
The sample changes on rows 4 and 20, but not on rows 8 and 24. However, the new sample′s default volume is loaded.

{{Testcase|format=it|name=noteoff3.it|pass=12284}}
This is the same as noteoff2.it, but with old effects enabled. In this case, the sample should never fade out.

{{Testcase|format=it|name=NoteOffInstr.it|pass=5829}}
Any kind of Note Cut (SCx or ^^^) should stop the sample and not set its volume to 0. A subsequent volume command cannot continue the sample, but a note, even without an instrument number can do so. When played back correctly, the module should stay silent.

{{Testcase|format=it|name=Off-Porta.it|pass=1344}}
When "Compatible Gxx" is disabled, the key-off flag should only be removed when triggering new notes, but not when continuing a note using a portamento command.

{{Testcase|format=it|name=Off-Porta-CompatGxx.it|pass=0 (temporarily broken in rev. 1344)}}
When "Compatible Gxx" is enabled, the key-off flag should also be removed when continuing a note using a portamento command (row 2, 4, 6). This test case was written to discover a code regression when fixing [[#Off-Porta.it|Off-Porta.it]]).

{{Testcase|format=it|name=OffsetWithInstr.it|pass=20863}}
An offset effect can be triggered if only an instrument number and no note is next to it, if the last triggered note was not a note cut, note off or note fade.

{{Testcase|format=it|name=PanbrelloHold.it|pass=4712}}
The panbrello offset should not only be added on the same row as the panbrello effect appears on, but also on all follow-up rows, until a panning command or a new note is encountered. This test case should remain mostly silent.

{{Testcase|format=it|name=PanReset.it|pass=4713}}
Contrary to XM, the default instrument and sample panning should only be reset when a '''note''' is encountered, not when an '''instrument number''' (without note) is encountered. The two channels of this module should be panned identically.

{{Testcase|format=it|name=PanResetInstr.it|pass=11856}}
Instruments and samples with a defined panning should not override the channel panning for following notes. That is, if a different instrument with no panning set follows an instrument that has panning set, the first instrument’s panning should not be applied to the second instrument, but rather the channel panning as it was set before playing the first instrument (or if the channel panning was changed while that instrument was playing, the new channel panning applies as well).
If played correctly, this test case should remain silent.

{{Testcase|format=it|name=PatternDelay-NoteDelay.it|pass=1240}}
Delayed notes (using SDx) that are on the same row as a Row Delay effect are retriggered on every repetition. Notes ''without'' a note delay are ''not'' retriggered.

{{Testcase|format=it|name=PatternDelays.it|pass=1224}}
Tick delays (S6x) are added up, but when there are multiple row delays (SEx), only the first one is considered. The tricky part here is that Impulse Tracker even ignores all row delays next to a SE0 row delay. I suggest to do the following:
* Initialize a <tt>row delay</tt> variable with <tt>0</tt>.
* Go through all channels. If there is a row delay on the current row and <tt>row delay</tt> is 0, set <tt>row delay = parameter + 1</tt>.
* Calculate the complete row length: <tt>row length = (speed + tick delay) * max(1, row delay)</tt>

{{Testcase|format=it|name=PatternDelaysRetrig.it|pass=1221}}
Rows on which a row delay (SEx) effect is placed have multiple “first ticks”, i.e. you should set your “first tick flag” on every tick that is a multiple of <tt>speed + tick delay</tt>. In this test module, the note pitch is changed multiple times per row, depending on the row and tick delay values.
 Note: This test case broke in r3520 and was fixed again in r4895.

{{Testcase|format=it|name=PitchPanReset.it|pass=15870}}
Pitch/Pan Separation can be overriden by panning commands, and should not be affected by Note Off or Note Fade notes.

{{Testcase|format=it|name=PortaCutCompat.it|pass=9139}}
A follow-up test to [[#PortaSampleCompat.it|PortaSampleCompat.it]] and [[#PortaInsNumCompat.it|PortaInsNumCompat.it]] to verify that the behaviour described in these tests is not used when currently no note is playing. Both channels should sound identical.

{{Testcase|format=it|name=PortaInsNum.it|pass=1671}}
Portamento with funny sample maps. Without compatible Gxx, portamento between different samples should play the new sample.

{{Testcase|format=it|name=PortaInsNumCompat.it|pass=2842}}
Portamento with funny sample maps, in compatible Gxx mode. With compatible Gxx, portamento between different samples should keep playing the old sample.

{{Testcase|format=it|name=PortaJustStoppedNote.it|pass=6193}}
[[#Fade-Porta.it|Fade-Porta.it]] already tests the general case of portamento picking up a stopped note (portamento should just be ignored in this case), but there is an edge case when the note just stopped on the previous tick. In this case, OpenMPT did previously behave differently and still execute the portamento effect.

{{Testcase|format=it|name=porta-offset.it|pass=0}}
Unlike Fasttracker 2, Impulse Tracker does not ignore offset commands next to portamentos and executes them both. Even ModPlug Tracker 1.16 gets this test right.

{{Testcase|format=it|name=PortaReset.it|pass=4181}}
Impulse Tracker completely resets the tone portamento target on every new non-portamento note, i.e. a follow-up Gxx effect should not slide back to the previously triggered note.

{{Testcase|format=it|name=PortaResetAfterRetrigger.it|pass=7465}}
After a note has stopped playing, a lone instrument number can restart the note. In this case, portamento and other properties should be reset.

{{Testcase|format=it|name=PortaSample.it|pass=1671}}
Impulse Tracker executes the portamento when switching to instrument two on the second row when compatible Gxx is disabled.

{{Testcase|format=it|name=PortaSampleCompat.it|pass=2842}}
Impulse Tracker executes the portamento and doesn't switch to the new sample on the second row when compatible Gxx is enabled.

{{Testcase|format=it|name=RandomPan.it|pass=2545}}
Pan swing should not be overridden by effects such as instrument panning or panning envelopes. Previously, pan swing was overridden in OpenMPT if the instrument also had a panning envelope. In this file, pan swing should be applied to every note.

{{Testcase|format=it|name=RandomWaveform.it|pass=3670}}
When selecting the random waveform for panbrello, the “speed” nibble indicates for how many ticks the random value will be held. This behaviour is ''not'' used for vibrato / tremolo.

{{Testcase|format=it|name=ResetEnvNoteOffOldFx.it|pass=11276 - 11283}}
In Old Effects mode, an instrument number next to a note-off does not just recall the default volume and panning, but also resets the envelopes.

If the instrument is different from the currently playing instrument, the new instrument's envelope and default sample settings (default volume, panning, but not global volume) are loaded, but the old sample waveform keeps playing.

When played correctly, the left and right audio channel should sound identical. On the last note, the tracker channels swap their stereo position.

{{Testcase|format=it|name=ResetEnvNoteOffOldFx2.it|pass=11284}}
An extension of ResetEnvNoteOffOldFx.it which also tests instrument note-off and sample sustain loop behaviour: While the sample sustain loop should be released, the instrument should not be faded out.

{{Testcase|format=it|name=retrig.it|pass=364}}
A combination of the retrigger effect and instrument envelopes. Not sure how this works.

{{Testcase|format=it|name=retrig-short.it|pass=1140}}
Impulse Tracker does not retrigger notes that are shorter than the duration of a tick. One might argue that this is a bug in Impulse Tracker, but OpenMPT emulates it anyway.

{{Testcase|format=it|name=s7xinsnum.it|pass=1062}}
Changing the NNA action through the S7x command only affects the current note - The NNA action is reset on every ''note change'', and not on every ''instrument change''.

{{Testcase|format=it|name=s77.it|pass=561 (preliminary), 1112}}
The S77 / S79 / S7B commands pause the instrument envelopes, they do not turn them off. S78 / S7A / S7C should resume the envelope at exactly the position where it was paused. In this test, it is again very important that the envelope position is incremented ''before'' the point is evaluated, not ''afterwards'' (see [[#EnvLoops.it|EnvLoops.it]]).

{{Testcase|format=it|name=SampleNumberChange.it|pass=0}}
Contrary to [[#InstrumentNumberChange.it|InstrumentNumberChange.it]], even ModPlug Tracker 1.16 passes it.

{{Testcase|format=it|name=SampleSustainAfterPorta.it|pass=20760}}
When a sample’s sustain loop was released, and a new note from a different sample is played with tone portamento applied, the second sample’s sustain loop also stays released.

{{Testcase|format=it|name=SampleSustainAfterPortaCompatGxx.it|pass=20760}}
Same as [[#SampleSustainAfterPorta.it|SampleSustainAfterPorta.it]], but with Compatible Gxx turned on.

{{Testcase|format=it|name=SampleSustainAfterPortaInstrMode.it|pass=20760}}
Same as [[#SampleSustainAfterPorta.it|SampleSustainAfterPorta.it]], but in instrument mode. Here a difference in the behaviour can be observed when doing a second switch after the initial note-off: The first time, the sustain loop remains disabled, but for the subsequent note, the sustain loop is used again. This does not happen in sample mode.

{{Testcase|format=it|name=sbx-priority.it|pass=12171}}
This is an extension of [[#LoopBreak.it|LoopBreak.it]]. A position jump (Bxx) on the same row as the end of a pattern loop prevents the loop from being executed if it is right of the SBx effect, but if the position jump is left of the SBx effect, the loop should be prioritized. In this test, the left and right channel of the module should produce the same beep patterns.

{{Testcase|format=it|name=scx.it|pass=1109}}
The SCx command cuts notes just like a normal note cut (^^^), it does not simply mute them. However, there is a difference when placing a lone instrument number after a note that was cut with SCx and one cut with ^^^, as it can be seen in this test case.

{{Testcase|format=it|name=SCx-Reset.it|pass=23476}}
When a lone instrument number after a SCx command picks up the previous note, it resets its pitch to the original note, undoing any portamento effects - the same as if there was a note next to the instrument number.

If there is a note and a tone portamento next to an SCx command, the Note Cut is not executed - unless there is also a row delay effect and we are on the second repetition of the row.

When played correctly, this test should remain silent.

{{Testcase|format=it|name=SlideDelay.it|pass=3520}}
If there's a note delay, slide and vibrato commands in the volume column next to it should not start before the delay has finished.
So if there's a fine volume slide next to a SD5 effect should start on the 6th (one-based) tick. If this was a normal volume or pitch slide and the speed was 6 ticks per row, it would never execute, as the first non-zero tick would be the seventh tick.

{{Testcase|format=it|name=SmpInsPanSurround.it|pass=1259}}
Sample and instrument panning override the channel surround status, i.e. surround is turned off by samples or instruments with panning enabled.

{{Testcase|format=it|name=surround-pan.it|pass=1134}}
Pan swing, panbrello, panning envelopes, etc. should have no effect on surround channels.

{{Testcase|format=it|name=StoppedInstrSwap.it|pass=5829}}
An instrument number with no note or next to a ^^^ should always be remembered for the next instrument-less note, even if sample playback is stopped.

{{Testcase|format=it|name=SusAfterLoop.it|pass=1085}}
When a sample sustain loop, which is placed partly or completely behind a “normal” sample loop is exited (through a note-off event), and the current sample playback position is past the normal loop’s end, it is adjusted to <tt>loop start + ((current position - loop start) % loop length)</tt>.

{{Testcase|format=it|name=SwapNNA.it|pass=10239}}
Related to [[#s7xinsnum.it|s7xinsnum.it]], the NNA action should be reset when doing an instrument swap with portamento.

{{Testcase|format=it|name=swaptest.it|pass=???}}
A test focussing on finding the correct sample playback position when switching samples “on the fly” (using instrument numbers without notes next to them). The module should remain silent when being played.

{{Testcase|format=it|name=swing1.it|pass=1046 (?)}}
Probably a very MPT-specific bug, as OpenMPT was adding the volume swing to the current volume, so even after setting the volume to 0, it was possible that you could hear the sample playing.

{{Testcase|format=it|name=swing2.it|pass=1046 (?)}}
This module should remain completely silent, as the random variation is multiplied with the sample volume.

{{Testcase|format=it|name=swing3.it|pass=1046 (?)}}
Of course you are not supposed to produce the same sequence of random number to fulfil this test case. I think this was just a test to explore which volume variables are actually affected by volume swing, and how it is applied.

{{Testcase|format=it|name=swing4.it|pass=1046 (?)}}
Same as above.

{{Testcase|format=it|name=swing5.it|pass=1046 (?)}}
Same as above.

{{Testcase|format=it|name=tickdelay.it|pass=4948}}
This test detects whether out-of-range note delays are handled properly. If the SDx parameter is greater than the row length (''including'' tick delay, but ''excluding'' row delay), any note and volume effects next to it are supposed to ignored (interestingly, the instrument number is saved, but not instantly used). The first two rows test tick delay behaviour (OpenMPT passes this test since revision 1306), the third row tests row delay behaviour.

{{Testcase|format=it|name=tremolo.it|pass=345 (?)}}
A test for checking if tremolo tables are implemented correctly.

{{Testcase|format=it|name=vibrato.it|pass=1189}}
A test for checking if vibrato tables are implemented correctly when old FX are disabled.

{{Testcase|format=it|name=VibratoDouble.it|pass=7804}}
Vibrato in the volume column should be applied separately from vibrato in the effect column. The two commands will add up when occuring at the same time. However, since there is only one vibrato effect memory for both commands, the volume column’s vibrato parameter has precedence if it is not 0.

{{Testcase|format=it|name=vibrato-oldfx.it|pass=1189}}
A test for checking if vibrato tables are implemented correctly when old FX are enabled. Vibrato is played backwards in this mode!

{{Testcase|format=it|name=VibratoSweep0.it|pass=7134}}
Auto-vibrato should not be processed at all if the rate (speed) is 0. This is relevant for vibrato waveforms that do not start at zero, i.e. all except sine.

{{Testcase|format=it|name=VolColMemory.it|pass=1545}}
Volume column commands a, b, c and d (volume slide) share one effect memory, but it should not be shared with Dxy in the effect column. Furthermore, there is '''no''' unified effect memory across different kinds of volume column effects (that's how OpenMPT used to handle it up to revision 1544).

{{Testcase|format=it|name=VolColNoSlideMemoryPropagation.it|pass=23742}}
An extension of [[#VolColMemory.it|VolColMemory.it]]. While that test case verifies that regular Dxy volume slides do not propagate their effect memory to the volume column, it fails to verify the other way around. This test case rectifies that, also checking that volume column commands a, b, c and d do not update the Dxy effect memory.

{{Testcase|format=it|name=vol-env-carry.it|pass=1781}}
Similar to [[#flt-env-carry.it|flt-env-carry.it]]. This test case temporarily broke in revision 1481 and was fixed in revision 1781.

{{Testcase|format=it|name=Volume-Macro-Letters.it|pass=1465}}
This test demonstrates how Zxx macros are parsed in Impulse Tracker:
* Macros are evaluated only on the first tick.
* They appear to be parsed after note / instrument information has been read from the pattern, but before any other effects (excluding "Set Volume").
* 'u' and 'v' macros seem to emit at least a value of 1, not 0 - v00 corresponds to Z01.
I am not quite sure why the first row with notes on it emits a filter value of 1, and I am not even completely sure why OpenMPT gets this right.
If interpreted correctly, the module should stay silent (minus slight filter artefacts, of course - but they should be nearly inaudible).

{{Testcase|format=it|name=weirdloop.it|pass=0}}
A nice broken pattern loop. The voice should say “1 4 2 1 4 2” and then repeat forever “3 4 2”. Theoretically, this would even work in ModPlug Tracker 1.16, if it did not reset the Cxx target on song loop.

{{Testcase|format=it|name=ZxxSecrets.it|pass=9855}}
Impulse Tracker supports three MIDI macro characters which are not documented in MIDI.TXT:
* <tt>h</tt>: Host channel, i.e. the pattern channel in which the Zxx command is encountered (0-based).
* <tt>o</tt>: The last used sample offset value. The high offset (SAx) is not taken into account. Note that offsets above 80h are not clamped, i.e. they generate MIDI command bytes (e.g. O90 would cause a note-on command to be emitted).
* <tt>m</tt>: This command sends the current MIDI note if the channel is a MIDI channel, but on sample channels the current loop direction (forward = 0, backward = 1) of the sample is stored in the same memory location, so the macro evaluates to that instead of a note number.

In addition, the MIDI messages FA (start song), FC (stop song) and FF (reset) reset the resonant filter parameters (cutoff = 127, resonance = 0) for all channels, but do not immediately update the filter coefficients.

{{Testcase Summary}}

[[Category:Development|Test Cases/IT]]
[[Category:IT Format|Test Cases]]

Manual: Compatible Playback

2025-07-12T21:11:50Z

Saga Musix: /* IT compatibility settings */

== Why a compatible playback mode? ==

[[Image:Compatible Mode.png|thumb|300px|More compatible playback of modules can be enabled in the [[Manual: Song Properties#Miscellaneous Flags|Song Properties]]. When you see this warning icon, it might be a good idea to review the compatibility settings.]]

Playback accuracy has always been a problem with tracked music. While the tracker interface with its effect letters and such is simple and fast to use, the internal algorithms used to process effects are not always as simple as they might appear on-screen. For example, due to a little typo, an effect might behave erratically under certain conditions in its original tracker application.

When another tracker (like OpenMPT) decides to support a certain third-party format (for example the XM format of Fasttracker 2), it should faithfully reproduce the meaning of every effect letter and all other behaviour. Sadly, this has not always been the case with (Open)MPT. In the past, users of other trackers have often complained that OpenMPT does not behave like other trackers and thus replays their music (that has been written in another tracker like Fasttracker 2) incorrectly.

Often, making OpenMPT “emulate” those original behaviours, or indeed “quirks”, is the matter of changing a single line of code. However, the same feature that has previously been playing wrong in (Open)MPT may of course, after having fixed it, sound “wrong” in any modules composed with (Open)MPT that made use of this feature. Thus, the programmers of OpenMPT found it necessary to add a “Compatible Playback” option (to be found in the [[Manual: Song Properties#Miscellaneous Flags|Song Properties]]) to switch between OpenMPT’s and other tracker’s behaviour. That way, people do not have to fear that their modules made with older versions of OpenMPT suddenly sound wrong after upgrading, and people who want to listen to their tunes made with another application can also happily listen to them without problems.

== What should I do when composing a track in OpenMPT? ==

That depends on your intentions and goals. When using OpenMPT’s own MPTM format, you do not need to care about compatibility settings. You do not need to enable any compatible playback settings — it does not hurt to do so, but some commands behave in more logical or consistent way when some compatibility settings are disabled.

However, if you are composing IT and XM modules, you most likely want to spread them on the internet and share them with friends. In that case, it is important to set all compatibility settings to their defaults, because many people are using other players (such as XMPlay, Schism Tracker, MilkyTracker or indeed Impulse Tracker and Fasttracker 2), and all of those try to “emulate” Impulse Tracker and Fasttracker 2 as precisely as possible - they do not want to emulate OpenMPT’s own “quirks”. Thus, if you compose a track in those formats, you are absolutely recommended to enable the most compatible playback by clicking the '''Set Defaults''' button in the compatibility section of the [[Manual: Song Properties#Miscellaneous Flags|Song Properties]] dialog - you do not want to get a bad review on your music because it sounds “totally horrible” in XMPlay, just because you forgot to turn on compatible playback, do you?

You should take Impulse Tracker (for IT files) or Fasttracker 2 (for XM files) as a reference when composing your tracks, or at least XMPlay (a very accurate player for both file formats) if you cannot get the original trackers to run. Upcoming OpenMPT updates will bring further improvements to the compatible playback mode, so if something in OpenMPT sounds different from Impulse Tracker / Fasttracker 2, do not hesitate to report it on our [https://bugs.openmpt.org/ Issue Tracker] and it will most likely sound correct in the next version of OpenMPT - when enabling the respective compatibility setting, that is.

It is advised to use [[Manual: Saving and exporting#Compatibility Export|Compatibility Export]] together with this feature.

== Upgrading from an old OpenMPT version ==

When loading a module made with an earlier version of OpenMPT, only the compatibility settings that apply to this old version are enabled; newer settings will not be enabled automatically. This way, playback will be as close as possible to the version the module was last saved with.

If you resume your work on a module made with an earlier version, it is recommended to switch to the default compatibility settings in the Song Properties dialog — as long as your module still sounds identical afterwards, of course. If it does not, you may want to go through all compatibility settings and review what changes they introduce, and if applicable modify the module so that it will also sound correct after enabling these compatibility settings.

== Playback Compatibility Settings ==

[[Image:Playback Compatibility Settings.png|thumb|300px|Playback Compatibility Settings dialog]]

The Playback Compatibility Settings dialog allows you to edit the detailed compatibility settings. Below is a list of all possible compatibility settings that can be toggled in this dialog.

=== Common compatibility settings ===

The following compatibility settings apply to all formats. Some of them may only be visible in legacy modules saved with old OpenMPT versions.

Greyed out checkboxes indicate the emulation of ''really'' old OpenMPT bugs. After disabling those checkboxes, they will remain unavailable.

* '''OpenMPT 1.17 compatible random variation behaviour for instruments''' Random volume and panning variation behaves like in early OpenMPT versions.
* '''Plugin volume MIDI CC bug emulation''' Swaps the controller and parameter byte of the MIDI channel volume CC when choosing “MIDI volume” as an instrument’s volume command handling, effectively breaking the MIDI command.
* '''Old Pitch Wheel behaviour for instrument plugins''' Enables the counterintuitive MIDI pitch wheel behaviour found in earlier OpenMPT versions where sample and plugin portamento did not match.
* '''Execute regular portamento slides at speed 1''' Only fine and extra-fine portamentos are supposed to do something at a speed of one tick per row. This setting is automatically enabled for modules made with very old versions of OpenMPT.
* '''Compute note frequency in Hertz rather than periods''' For best accuracy of high-pitched notes, all note slides etc. are computed in Hertz rather than tracker periods.
* '''Clamp tempo to 32-255 range''' Tempo slides cannot exceed a tempo of 255.
* '''Global volume slide memory is per-channel''' If disabled, there is only one effect memory for global volume slide commands.
* '''Panning commands override surround and random pan variation''' If disabled, surround and random pan variation effects are not interrupted by panning commands.
* '''Note delays next to a row delay are repeated on every row repetition''' Delayed notes that are on the same row as a row delay are retriggered on every row repetition.
* '''Old volume envelope release node scaling behaviour''' This option is only available when importing modules saved with OpenMPT 1.27 or earlier that make use of the volume envelope release node. With this setting enabled, the volume envelope after the release node is added to the volume at release time, while the new behaviour causes this part of the envelope to be relative to the volume at release time.
* '''Reset VST volume on note-off''' Previous versions of OpenMPT sent bogus volume commands or dry / wet ratio settings on plugin note-offs. This setting retains this behaviour.
* '''Send OPL key-off when triggering notes''' Note-off events are sent for OPL instruments also when two notes are played on the same channel without interruption.
* '''Use old imprecise ping-pong loop end calculation''' In previous versions of OpenMPT, the loop length could be noticeably off for very short ping-pong loops and thus cause those samples to be slightly detuned. This setting retains this behaviour.
* '''Assume initial plugin MIDI program and bank number is 1''' In previous versions of OpenMPT, if an instrument was set to use MIDI program 1 or bank 1, this program or bank change was not set to plugins (unless another instrument previously explicitly selected a different program or bank for this plugin). Importing such a legacy module will enable this compatibility setting to restore the old behaviour, otherwise it is not available.
* '''MIDI notes can be sent to channel plugins''' MIDI notes can be sent to channel plugins in addition to instrument plugins. Only available when importing modules made with OpenMPT 1.25 or older.
* '''Report inaccurate PPQ position to VST plugins (like OpenMPT 1.31 and older)''' When importing a module made with OpenMPT 1.31 or older that contains any VST plugins, this setting is enabled automatically to report the song PPQ position to plugins the same incomplete, broken way as those old versions did.
* '''Plugin notes with New Note Action set to Continue are affected by note-offs (like OpenMPT 1.31 and older)''' When importing a module made with OpenMPT 1.31 or older that contains any VST plugins, this setting is enabled automatically to use the same buggy New Note Action behaviour for plugins as found in those old versions.

=== MPTM compatibility settings ===

The following settings address behaviour changes that were made to make the MPTM format more intuitive:

* '''Full control over OPL notes after note-off''' Allows OPL notes to be controlled (volume, panning, pitch, etc.) after the note has been released.
* '''New Note Action / Duplicate Note Action set to Note Off and Note Fade affect OPL notes like samples''' Previously, New Note Action / Duplicate Note Action types Note Off and Note Fade would both simply release OPL notes. With this setting enabled, Note Fade fades the note the same way as with samples, and with Note Off the post-sustain part of the volume envelope is applied as well.
* '''Do not reset OPL channel status at end of envelopes''' This setting is only available in files made with OpenMPT 1.28. It re-enables the old end-of-envelope behaviour that was inconsistent with sample channels.

In addition, all the following compatibility settings for the IT format also apply to MPTM files:

=== IT compatibility settings ===

Impulse Tracker’s playback routine is relatively bug-free and logical.
OpenMPT’s IT playback is already relatively good even with compatible mode being disabled, however some small (and not-so-small) details are not handled correctly. Sometimes they can cause quite drastic differences in playback.

The following compatibility settings are only available in IT and MPTM modules.

* '''Retrigger instrument envelopes on instrument change''' An instrument number with no note next to it plays the new instrument and plays its envelopes from start.
* '''Volume column portamento never does fine portamento''' A fine portamento followed by e00 and f00 is not continued as a fine portamento. Instead, its parameter is treated as if it was a normal portamento.
* '''IT arpeggio algorithm''' Handles arpeggio slightly differently than OpenMPT does by default.
* '''Out-of-range delay commands queue new instrument''' A note next to a delay command that exceeds the current row’s length is not played, but its instrument number will be used for the next note (if it has no instrument number).
* '''Gxx shares memory with Exx and Fxx''' All portamento commands use the same memory.
* '''After finishing a pattern loop, set the pattern loop target to the next row''' A lone SBx effect with no corresponding SB0 will restart its loop one row after the previous loop, if there was one in the same pattern.
* '''Nested pattern loop behaviour''' If there are several pattern loops running concurrently, execute them like IT and FT2 do.
* '''Do not reset ping pong direction with instrument numbers''' An instrument number does not cause a ping-pong loop to change its direction.
* '''IT envelope reset behaviour''' The rules for when to restart envelopes are changed to Impulse Tracker’s WAV writer behaviour.
* '''Forget the previous note after cutting it''' An instrument number after a note cut cannot restart the previously playing note.
* '''More IT-like Vibrato, Tremolo and Panbrello handling''' These effects will use Impulse Tracker’s waveforms and retrigger behaviour.
* '''Ixx behaves like in IT''' Tremor reset and tick counting behaviour is more like in IT.
* '''Qxx behaves like in IT''' Retrigger tick counting is more like in IT.
* '''Properly update C-5 frequency when changing note in multisampled instrument''' When playing a multisampled instrument with no instrument numbers in the pattern, the middle-C frequency is still updated properly.
* '''Clear portamento target after it has been reached''' Once the portamento target has been reached, any subsequent Tone Portamento effects will do nothing.
* '''Do not reset loop count on pattern break''' If a pattern loop is interrupted by a pattern break, the loop count is remembered for subsequent loops.
* '''Offset after sample end is treated like in IT''' With “Old Effects” enabled, the offset is clamped to the sample end (so when there is no sample loop, the note will not sound). Otherwise, the sample plays from start.
* '''Volume and panning random variation work more like in IT''' Among the biggest differences, volume random variation is a percentage of the instrument’s global volume, not of its note volume.
* '''NNA is reset on every note change, not every instrument change''' When using S7x effects to change an instrument’s NNA behaviour, the original value is reset with the next note rather than the next instrument number.
* '''SCx really stops the sample and does not just mute it''' A subsequent volume effect cannot pick up a note that was previously stopped using the SCx command.
* '''IT-style envelope position advance + enable/disable behaviour''' When disabling envelopes, the last value of the envelope keeps being applied.
* '''More compatible instrument change + portamento''' Resets the volume envelope even on notes with Tone Portamento. A sample change during a Tone Portamento with “Compatible Gxx” enabled does not cause the new sample to be played.
* '''Do not repeat last sample point in ping pong loop, like IT’s software mixer''' Not noticeable unless you use ping-pong-looped chip samples. If disabled, OpenMPT sounds more like IT’s Gravis Ultrasound driver.
* '''Use triggered note rather than translated note for PPS and DNA note check''' When modifying the note-to-note mapping of an instrument, the Pitch-Pan-Separation and Duplicate Note Action are based on the note found in the pattern rather than the “translated” note.
* '''SAx does not apply an offset effect to a note next to it''' High Offset commands next to a note do not instantly apply an offset effect, they only affect subsequent Offset commands.
* '''User IT’s filter coefficients (unless extended filter range is used) and behaviour''' Higher resonance than OpenMPT’s original filter implementation, and slightly different rules when to enable and disable filters.
* '''Panning modulation is disabled on surround channels''' Panning random variation, panbrello and panning envelopes are ignored on surround channels, unless OpenMPT’s “Quad Surround” panning mode (S9B command) is enabled.
* '''Do not retrigger already stopped channels''' A sample is not retriggered if it already stopped playing. Unfortunately, this also affects retriggering very short samples (such as Hi-Hats), so it is advised to put a silent loop at the end of such samples if they need to be retriggered.
* '''Do not apply any portamento if no previous note is playing''' Applying Tone Portamento on a channel where a note was previously stopped will not slide from this stopped note to the new note but rather play the new note directly at its target frequency.
* '''Reset note-off on portamento if there is an instrument number in Compatible Gxx mode''' Only reset the “Note Off” status of a note with Tone Portamento if “Compatible Gxx” is enabled.
* '''Volume column effects share their memory with the effect column''' Volume slides in the volume column have no own effect memory but share it with their effect column counterparts. This setting also ensures that fine volume slides in the volume column are only applied on the very first tick of a row, and not on multiples of the first tick if there is a Pattern Delay command.
* '''Portamento with sample swap plays the new sample from the beginning''' When swapping samples during a Tone Portamento, they are played from the start rather than being continued at the play position of the old sample.
* '''Ignore instrument note map entries with no note completely''' When triggering a note that is mapped to nothing at all in an instrument’s sample map, it should not even trigger New Note Actions and such.
* '''IT-style first tick handling''' If there is a note delay, fine volume slides next to it will be executed on the tick that matches the delay rather than the “true” first tick of the row.
* '''IT-style sample&hold panbrello waveform''' Setting the panbrello waveform to “random” will cause the speed parameter of the Panbrello command to hold the current random value for the given number of ticks.
* '''New notes reset portamento target in IT''' A previous portamento target is not remembered after a note change with no Tone Portamento.
* '''Do not reset panbrello effect until next note or panning effect''' After executing Panbrello, its panning offset remains on the following rows until a new note or other panning effect is encountered. If disabled, the panning offset is reset immediately.
* '''Sample and instrument panning is only applied on note change, not instrument change''' An instrument number does not re-apply the sample’s or instrument’s default panning, only a new note does.
* '''Bxx on the same row as SBx terminates the loop in IT''' Pattern loops that also have a Position Jump on the last row are never executed.
* '''Instrument number with note-off recalls default volume''' An instrument number next to a Note-Off note will apply the sample’s default volume.
* '''Lone instrument number after portamento within multi-sampled instrument sets the target sample's settings''' A tone portamento between two notes of the same instrument that are assigned to different samples does not switch to new samples; however, a lone instrument number after such a tone portamento will apply the sample settings (volume and panning) of the target sample while continuing to play the first sample. Additionally, this setting resets the portamento on a stopped note if it is picked up using a lone instrument number.
* '''Broken release node after sustain end behaviour''' From OpenMPT 1.23 to OpenMPT 1.27, a release node past the sustain loop end did not work correctly if the “IT-style envelope position advance + enable/disable behaviour” compatibility setting was enabled as well. If such a module is loaded, this option is enabled automatically. Otherwise, it is not available.
* '''Instrument number with note-off retriggers envelopes with Old Effects enabled'''
* '''Instruments / samples with forced panning do not override channel panning for following instruments / samples''' The panning options of samples and instruments do not override channel panning for any following notes.
* '''Bxx right of SBx terminates the loop in IT''' If a Bxx command is found right of the terminating SBx command of a pattern loop, the pattern loop is never executed.
* '''Duplicate Sample Check requires same instrument, Duplicate Note Check uses pattern notes for comparison''' If an instrument has its duplicate check type set to ''Sample'', then these checks are carried out only if the old and new instrument match. If an instrument has its duplicate check type set to ''Note'', the old and new pattern note are compared, regardless of how they are transposed in the instrument.
* '''Pitch / Pan Separation can be overridden by panning commands''' Rather than applying Pitch / Pan Separation as an offset on top of all other panning, this setting causes it to behave more like an implicit panning command that is overridden if a real panning command is encountered in the pattern data.
* '''Ignore tone portamento for instrument plugins''' If enabled, tone portamento commands do not slide from one instrument plugin note to the next, but instead keep the old note playing while also triggering the new note simultaneously.
* '''Reset filter on portamento if new note plays a different sample''' In sample mode, when doing a tone portmento between two differetn samples, the filter may be deactivated in the same way as it can be deactivated when triggering a new note (i.e. when the previous note was playing with filter cutoff fully open and resonance at 0).
* '''Initial Last Note Memory of each channel is C-0 instead of No Note''' When this setting is active, a lone instrument number with no previous note on the same channel will trigger a C-0 note instead of not doing anything.
* '''Portamento after note-off does not re-enable sample sustain loop''' When using tone portamento after a note-off event, the sample sustain loop is not re-enabled.
* '''Ignore pattern cell completely when trying to play unmapped instrument note''' Any effects in a pattern cell are ignored if that pattern cell contains a note or instrument that points to an unmapped entry in the instrument’s sample map.
* '''Offset command with instrument number recalls offset with last note''' If there is no note, but an instrument number and offset effect, the previous note is used to apply the offset effect to.
* '''Parameters of conflicting volume and effect column portamento commands may overwrite each other''' This setting emulates the strange interactions between different portamento commands when they are encountered in both the volume and effect column at the same time.
* '''Note-Off status does not influence Envelope Carry behaviour''' Previously, instrument envelopes restarted after a note-off even if Envelope Carry was enabled. With this setting enabled, they reset only if there is an instrument number without a note.
* '''Note Cut (SCx) resets note pitch and interacts with tone portamento + row delay'''' This setting enables two quirks: When a lone instrument number picks up a note cancelled by an SCx command, any previous portamento effects are undone and the original note pitch is restored. A combination of SCx with a note and tone portamento also ignores the SCx command, unless there is also a pattern delay effect on the same row.
* '''Do not propagate volume column volume slide memory to regular effect column''' This setting prevents the volume column volume slides c and d from propagating their effect parameter to the memory of the regular effect column Dxy volume slide command.

=== XM compatibility settings ===

Fasttracker 2 has a '''very quirky''' playback routine which makes even common pattern effects (and combinations thereof) behave totally unpredictable.
These idiosyncrasies are not handled very well (or not at all) when compatible playback is disabled, so you are '''absolutely advised''' to use the default compatible playback settings for XM Files.
Many people listen to those files with MilkyTracker and XMPlay, and those two programs emulate Fasttracker 2’s quirks rather well - and so does OpenMPT’s compatible playback mode.

The following compatibility settings are only available in XM modules.

* '''Use smooth Fasttracker 2 volume ramping''' Enables extra smooth sample ramping, like Fasttracker 2 did it. When enabled, percussive instruments (e.g. Bass Drums) will sound very muffled, as most of their attack will be lost.
* '''Reset note-off on portamento if there is an instrument number''' Resets the “Note Off” status of a note with Tone Portamento.
* '''FT2 arpeggio algorithm''' FT2 has a very buggy arpeggio command that, among other things, plays arpeggios backwards (second parameter’s note comes first).
* '''Rxx behaves like in FT2''' The Retrigger command also has very erratic behaviour in FT2, which is emulated by this setting.
* '''Vibrato depth in volume column does not actually execute the vibrato effect''' The uxx command only sets the vibrato speed for subsequent vibrato commands, but does not actually play a vibrato.
* '''Do not play portamento-ed note if no previous note is playing''' If there is no playing note, a new note with a Tone Portamento command next to it will not sound.
* '''FT2-style Kxx handling''' Key Off is another weird command in FT2 and behaves differently with volume commands and instrument numbers next to it.
* '''Volume-column pan slides are finer''' lxx and rxx are as fine as fine panning slides in Impulse Tracker.
* '''Offset past sample end stops the note''' Notes with offset commands beyond the sample length are never triggered.
* '''Do not allow ModPlug extensions to X command''' Only X1x and X2x commands will work, X5x and higher do not.
* '''Retrigger envelopes if there is a note delay with no note''' A note delay with no note next to it will still retrigger instrument envelopes.
* '''Lxx only sets the pan envelope position if the volume envelope's sustain flag is set'''
* '''Portamento with instrument number applies volume settings of new sample, but not the new sample itself'''
* '''No volume column memory''' Volume column slides do not have a parameter memory.
* '''Next pattern starts on the same row as the last E60 command''' After a pattern loop has been executed, the next pattern will start from the row where the loop started rather than from the first row. To avoid this, put a Pattern Break command at the end of the pattern.
* '''Keep processing faded channels for later portamento pickup''' After a channel has been faded out, a Tone Portamento can still pick up this silent note.
* '''Reload sample settings even if a note-off is placed next to an instrument number''' Even an instrument number next to a Note-Off note will apply the sample’s default volume and panning.
* '''Portamento with note delay next to it is ignored''' Tone Portamentos only work on notes with no note delays.
* '''Ignore out-of-range transposed notes''' A note, after applying the sample’s transpose amount, may not leave a certain range of notes. If it does, it is ignored.
* '''Bxx or Dxx on the same row as E6x terminates the loop''' Pattern loops that also have a Position Jump or Pattern Break effect on the last row are never executed.
* '''Portamento target is not reset with new notes''' Applying a Tone Portamento after a new note with no portamento has been triggered will slide back to the last note with portamento.
* '''Sustain point at end of envelope loop stops the loop after release''' If the sustain point is at the loop end and the sustain point has been released, do not loop anymore.
* '''Txx behaves like in FT2''' Tremor is another somewhat idiosyncratic command in FT2.
* '''Do not trigger notes with out-of-range note delay''' If the note delay is greater than the ticks per row (ignoring any pattern delays), it is ignored.
* '''Use FT2's broken period handling''' When sliding a note too deep, it will wrap around at some point and become a very high note.
* '''Panning command with delayed note-off is ignored''' If there is a Note Delay and Note-Off, a panning command next to them is ignored.
* '''FT2-style volume column handling if there is a note delay''' If there is a note delay, volume column effects are ''not'' executed on the first tick and, if there is an instrument number, on the delayed tick.
* '''Round sample finetune to multiples of 8''' FT2 has a finetune ranging from -128 to 127, but a finetune change only be heard at every multiple of 8.
* '''Fade instrument on note-off when there is no volume envelope; instrument numbers reset note-off status.''' Instruments with no instrument envelope are instantly muted when a note-off is encountered. If this note-off is not delayed (i.e. there is no EDx effect next to it), the instrument is also faded out, which is only relevant if a volume effect is encountered after the note-off. Additionally, instrument numbers after a note-off reset the note-off status, so the sustain status of the envelope is reset.
* '''Emulate FT2/ProTracker tremolo ramp down / triangle waveform''' The “ramp down” tremolo waveform (E71) is very buggy and even influenced by vibrato in FT2.
* '''Portamento Up and Down have separate effect memory''' 1xx and 2xx do not share effect memory.
* '''If the sustain point of the panning envelope is reached before key-off, it is never released'''
* '''Delayed instrument-less notes should not recall volume and panning''' From OpenMPT 1.19 to 1.27, notes with a note delay but no instrument number accidentally recalled the sample’s default volume and panning settings, which should only happen if there is an instrument number.
* '''Tone Portamento direction resets after reaching portamento target from below''' After a tone portamento has reached its target note, FT2 will act as if the tone portamento should always decrease the frequency of the note, so if the note’s frequency is decreased (e.g. with 2xx) afterwards and another Tone Portamento effect is encountered, it will directly jump back to the target note.
* '''Ignore tone portamento and fine pitch slides for instrument plugins''' If enabled, tone portamento commands do not slide from one instrument plugin note to the next, but instead keep the old note playing while also triggering the new note simultaneously. Additionally, fine and extra-fine pitch slides are not applied to instrument plugins.
* '''Key-off before auto-vibrato sweep-in is complete resets auto-vibrato depth''' After a note-off / key-off event, sample auto-vibrato only continues to play if it already reached its full depth before the note-off / key-off event.
* '''Offset effect memory is only updated when the command is next to a note''' The effect memory of the Offset command (9xx) is only updated when the command is placed next to a note.

=== S3M compatibility settings ===

The following compatibility settings are only available in S3M modules. They are not saved in S3M files, but OpenMPT tries to guess the most appropriate settings when loading such files.

S3M files made with OpenMPT always use all compatibility settings. However, when loading S3M files made with less compatible trackers (such as Impulse Tracker), compatible playback settings are disabled automatically as required. Re-saving such a file in OpenMPT will re-enable them.

* '''Do not reset panbrello effect until next note or panning effect''' After executing Panbrello, its panning offset remains on the following rows until a new note or other panning effect is encountered. If disabled, the panning offset is reset immediately.
* '''Offset past sample end stops the note''' Notes with offset commands beyond the sample length are never triggered.
* '''Do not process any effects on muted S3M channels''' Any effect commands (even tempo and global volume commands) on muted channels are completely ignored. Many trackers and players still apply these commands on muted channels.
* '''Most effects share the same memory''' Most effects in Scream Tracker 3 share a single effect memory (the only exception being vibrato and tone portamento effects). Many trackers and players implement effect-specific memory instead.
* '''Portamento with instrument number applies volume settings of new sample, but not the new sample itself (GUS)''' The default volume of the sample number next to a Tone Portamento command is applied, but no sample swap happens. This emulates the Gravis Ultrasound driver in Scream Tracker 3. Disable this option to emulate Sound Blaster playback instead.
* '''Do not remember vibrato type in effect memory''' Do not distinguish between vibrato types in effect memory, so that e.g. U1F followed by H00 causes the second effect to play a H1F vibrato. Effectively, this also means that Kxx will never play a fine vibrato.
* '''Stop note when reaching the format's maximum note frequency''' Only available when importing modules made with old ModPlug Tracker versions or BeRoTracker, notes stop playing when their pitch exceeds the S3M frequency limits after a portamento slide. Otherwise, the poratmento slide stops at the frequency limit.
* '''Portamento immediately following an arpeggio effect continues at the last arpeggiated note''' If a portamento up or portamento down effect immediately follows an arpeggio effect, it starts sliding from the last arpeggiated note, and not from the channel frequency as it was before the arpeggio.
* '''Notes without instrument use the previous note's sample offset''' Similarly to the MOD format, this setting causes notes without an instrument number to use the same sample offset as the previous note.
* '''Notes cannot be retriggered after they have been cut''' The Qxy command (with no note next to it) will not retrigger notes after the previous note has been forcefully cut.
* '''Enable on-the-fly sample swapping (SoundBlaster driver)''' The Sound Blaster driver in Scream Tracker 3 supports MOD-like sample swapping by just providing a new sample number without a note. As OpenMPT mostly follows Gravis Ultrasound playback for S3M modules, this setting is disabled by default.
* '''Retrigger effect (Qxy) affects OPL notes''' If disabled, only the note volume is affected by the Qxy effect (like in Scream Tracker 3). Otherwise, OPL notes are restarted like sample notes. This setting is only available for files made with OpenMPT 1.28, which did not use the same retrigger behaviour as Scream Tracker 3.
* '''Apply lower frequency limit''' This stops notes from sliding down lower than Scream Tracker 3 supports.
* '''OPL notes with Tone Portamento are delayed until the next row''' Tone Portamento is not available for OPL notes, instead the new note starts playing on the next row without any portamento.
* '''Ignore combined fine slides (Kxy / Lxy)''' Fine volume slides are not possible with commands K and L, like in Scream Tracker 3.

=== MOD compatibility settings ===

The following compatibility settings are only available in MOD modules. They are not saved in MOD files, but OpenMPT tries to guess the most appropriate settings when loading such files.

* '''VBlank timing''' F20 and above sets speed instead of tempo.
* '''ProTracker one-shot loops''' If (and only if) a sample’s loop starts at 0, the sample is first played in its ''entire'' length. Afterwards, only the loop section of the sample is repeated.
* '''Ignore panning commands''' 8xx and E8x commands will do nothing.
* '''Enable on-the-fly sample swapping''' Instrument numbers with no note next to them cause the playing sample to be exchanged by the newly specified sample. The effect takes place as soon as the currently played sample reaches its loop end.
* '''Emulate FT2/ProTracker tremolo ramp down / triangle waveform''' The “ramp down” tremolo waveform (E71) is very buggy and even influenced by vibrato in ProTracker.
* '''Out-of-range note delay is played on next row''' A note that is played with a note delay greater than the current ticks per row is postponed to the first tick of the next row, unless the next row already plays another note. The postponed note is played with an instant portamento from a previously playing note rather than being played from start.
* '''Tempo changes are handled on second tick instead of first''' F20 and above are only applied after the first tick of the row. At a speed of one tick per row, the change happens on the next row.

=== Miscellaneous compatibility settings ===

The following compatibility settings belong to neither of the aforementioned formats; they may be set when importing files from other formats and are not available otherwise.

* '''Beating OPL oscillators''' Only available when importing C67 files, this option slightly detunes OPL instruments based on the channel they are played on to create a fatter sound.
* '''OPL key-off sets note frequency to 0 Hz''' Only available when importing FMT files, this options sets the note pitch to 0 Hz to cut notes in addition to releasing the note-on flag.
* '''Offset commands work without a note next to them''' Offset commands can change the playback position of the sample without a note next to them. This behaviour is for example supported in the DMF, MDL and PLM formats.
* '''New note without instrument number does not play looped samples from the start''' Looped samples continue to play when a new note has no instrument number next to it, as if there was an instant tone portamento effect.

[[Category:Manual|Compatible Playback]]

Manual: Hidden Settings

2025-07-11T15:33:36Z

Saga Musix: Remove empty section

[[Image:Settings Advanced.png|thumb|300px|Advanced tab of the settings dialog]]

Some settings for advanced users cannot be changed directly in OpenMPT, however they can be changed by modifying OpenMPT’s configuration file, mptrack.ini, or from the [[Manual:_Setup/Advanced|Advanced Settings]]. When using the latter method, it might be necessary to restart OpenMPT for some options to take effect.

== [Broken Plugin Workarounds] ==
* '''VSTMaskAllCrashes''': Determines whether crashes in VST plugins should be reported to the user (1) or passed on to the system, i.e. OpenMPT crashes (0). Note that if a plugin crashed, its internal state or even OpenMPT’s state may be inconsistent, so in this situation it is best to close and reopen the tracker anyway.
* '''VSTNeverUnloadAnyPlugin''': If set to 1, VST plugins are not fully unloaded when closing them. This may help with some buggy plugins (e.g. made with older versions of SynthEdit 1.4). Do not enable this setting unless you have issues when unloading plugins that cannot be solved by using the plugin bridge.

== [Components] ==
* '''BlockASIO''', '''BlockPortAudio''', '''BlockRtAudio''', '''BlockWaveOut''': If set to 1, the respective sound device types do not get initialized or queried by OpenMPT. You should not need to disable any of these unless told to do so by the OpenMPT developers in order to diagnose problems.
* '''BlockMediaFoundation''': If set to 1, OpenMPT will not load any samples using MediaFoundation codecs.
* '''BlockWineWrapper''': If set to 1, OpenMPT will not load the Wine native audio wrapper.
* '''KeepLoaded''': If set to 0, optional OpenMPT components (e.g. MP3 codecs) are unloaded after usage. This frees up memory used by these components but slows down subsequent uses.
* '''LoadOnStartUp''': If set to 1, some optional components are loaded right on statup instead of when they are first used.

== [Debug] ==
Options in this section should generally only be changed if you are advised by an OpenMPT developer to do so.
* '''DelegateToWindowsHandler''': If set to 1, OpenMPT will invoke the Windows default crash handler after its own crash handler has finished generating the crash report which had been the behaviour in OpenMPT before 1.27.
* '''StopSoundDeviceBeforeDump''': By default, the sound device is closed after writing out a crash dump. Setting this option to 1 inverts the behaviour.
* '''StopSoundDeviceOnCrash''': If set to 0, OpenMPT will not close or otherwise touch the state of the sound device when writing out a crash dump. Only change this setting when asked by the OpenMPT developers to do so in order to diagnose sound device related crashes.
* '''TraceAlwaysDump''': If set to 1 and '''TraceEnable''' is also set to 1, OpenMPT will always write out the trace log on program exit even if no crash happened. Do not enable this setting unless you are advised by the developers to do so.
* '''TraceEnable''': If set to 1, a trace logging system is enabled which can be used by the OpenMPT developers to debug certain problems. Do not enable this setting unless you are advised by the developers to do so.
* '''TraceSize''': Configures the tracer buffer size. By default, it contains 1,000,000 entries.

== [Display] ==
* '''FSUpdateInterval''': OpenMPT watches the '''f'''ile '''s'''ystem in order to update the [[Manual:_Tree_View#Instrument_Library|instrument library]] tree view when files get added or removed to the directory while OpenMPT is running. This setting limits the rate of the GUI updates in these cases to the given value in milliseconds. The default is 500ms.
* '''GUIUpdateInterval''': Defines the update interval of the GUI in milliseconds (default: depends on the period value found in the sound card settings).
* '''ShowSplashScreen''': If set to 0, no splash screen is shown when starting the program (same effect as [[Manual: Command-line Parameters|command line option]] /NoLogo).
* '''UseOldStyleFolderBrowser''': When set to 1, the classic tree-style folder picker is used on Windows Vista and newer. On older systems and Wine, it is always used.
* '''VuMeterUpdateInterval''': Defines the update interval of the VU meters in milliseconds (default: 15ms).
* '''VuMeterDecaySpeedDecibelPerSecond ''': Sets the VU meter's decay speed The default value is 88 dB/s.

== [Export] ==
* '''DefaultToSoundcardSamplerate''': By default, the [[Manual: Saving and exporting#Exporting tracks|export dialog]] presets the export frequency to the tracker’s currently selected sample rate. One reason for this behaviour is that some plugins do not like it when the sample rate is changed between normal playback and export. If you do not like this behaviour, you can set this value to 0. In this case, OpenMPT remembers the previously selected sample rate instead.
* '''FLACCompressionLevel''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to FLAC format, this value sets the FLAC compression level. Higher values mean better compression ratio and require more CPU time. For details, please refer to the FLAC documentation.
* '''FLACMultithreading''': By default, the FLAC encoder uses all available CPU cores for FLAC encoding. Setting this to 0 disables the multithreaded encoding.
* '''MP3ID3v2MinPadding''': This value is the minimum amount of padding bytes to add to ID3v2 tags.
* '''MP3ID3v2PaddingAlignHint''': This aligns the MP3 data after the ID3v2 tag in addition to the minimum padding to a multiple of the configured value. Set to 0 to disable additional aligning.
* '''MP3ID3v2WriteReplayGainTXXX''': Write ReplayGain information (if calculated, see '''MP3LameCalculateReplayGain''' and '''MP3LameCalculatePeakSample''') to the ID3v2 tag. This setting defaults to 1.
* '''MP3LameCalculateReplayGain''' and '''MP3LameCalculatePeakSample''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to MP3 format, calculate the ReplayGain track gain adjustment and the peak sample value (as require by ReplaGain) respectively. The calculated values get written to the VBR/Lame info header automatically in VBR mode. Additionally, the values can be written to the ID3v2 tags when enabled (see '''MP3ID3v2WriteReplayGainTXXX'''). Both settings default to 1.
* '''MP3LameID3v2UseLame''': If set to 1, when [[Manual: Saving and exporting#Exporting tracks|exporting]] to MP3 format, uses the libmp3lame ID3v2.3 implementation instead of the OpenMPT ID3v2.4 implementation. ID3v2.3 is more widely supported by older player software.
* '''MP3LameQuality''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to MP3 format using libmp3lame, this value selects the internal algorithm quality used by LAME. Lower values mean better quality and require more CPU time. This is the same as the -q command line parameter for LAME. More details can be found e.g. on [http://wiki.hydrogenaud.io/index.php?title=LAME_-q_switch Hydrogenaudio].
* '''OpusComplexity''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to Opus format, this value selects the internal complexity used by libopus. Higher values mean better encoding efficiency and require more CPU time. Value -1 uses the libopus default value. For details, please refer to the [https://opus-codec.org/docs/ libopus documentation].

== [MIDI Input Ports] ==
In this section, you can set “friendly names” for all MIDI input ports. If you have lots of MIDI ports with undescriptive names (such as “MIDI Device Port 1”, “MIDI Device Port 2”, …), it can be useful to replace those names with more suitable names, e.g. to describe which device is connected to a specific port. To replace a name, add a pair like <code>MIDI Device Port 1=Synthesizer 1</code> to this section.

Friendly names are also recognized by the MIDI Input / Output plugin: If the selected ports have friendly names assigned when the module is saved, the next time is opened it will try to find the correct device by its friendly name. So if a MIDI device is connected to a different MIDI port, you can rename the ports and OpenMPT will automatically choose the correct port.

== [MIDI Output Ports] ==
Same as [[#.5BMIDI Input Ports.5D|[MIDI Input Ports]]], but for MIDI output ports.

== [Misc] ==
* '''AllowMultipleCommandsPerKey''': By default, a key combination can be used by only one command. Setting this to 1 allows you to bind more than one command to a key combination. Beware that this might lead to problems with existing keyboard mappings with overlapping commands!
* '''CacheCompleteFileBeforeLoading''': If set to 1, OpenMPT caches entire (module, instrument, etc.) files in memory, which may improve file reading performance at the expense of more memory being used.
* '''DistinguishModifiers''': Enable this option to distinguish between left and right <kbd>Ctrl</kbd> / <kbd>Alt</kbd> / <kbd>Shift</kbd> modifiers, e.g. to create FastTracker 2-like pattern play shortcuts.
* '''FlushFileBuffersOnSave''': Disabling this option avoids flushing of file buffers after saving modules, samples and other files on disk. This can speed up the write operation but increases the risk of data loss e.g. in case of a power failure.
* '''ITCompressionMono''': Enables IT-compressed mono samples when saving IT/MPTM files, depending on the value. To enable saving for normal IT files, add 1 to the value, for IT files saved through Compatibility Export, add 2, and for MPTM files add 4. So to enable saving of compressed samples in compatible ITs and MPTMs only, you would use the value 6. Some caveats regarding the usage of compressed samples have been written down on the [https://forum.openmpt.org/index.php?topic=4961.0 forum].
* '''ITCompressionStereo''': Enables IT-compressed stereo samples when saving IT/MPTM files, depending on the value (see above).
* '''MRUListLength''': Sets the maximum length of the most recently used file list in the file menu. Allowed values are between 0 (no list) and 15 entries.
* '''ProcessPriorityClass''': Set the Windows process priority class for OpenMPT. Possible values are: "idle", "below", "normal", "above", "high", "realtime". The default is "normal". See further discussion on the [https://forum.openmpt.org/index.php?topic=5655.0 forum]. '''Warning''': Changing this setting can cause system lockups requiring hard system reset.
* '''SaveChannelMuteStatus''': If set to 1, OpenMPT will save the channel mute status in IT, MPTM and S3M files.
* '''SmoothFT2Ramping''': If set to 1, XM files made with Fasttracker 2 will automatically use [[Manual:_Compatible_Playback#XM_compatibility_settings|very smooth sample ramping]] settings (like Fasttracker 2 did).
* '''UseSingleInstance''': Always forces OpenMPT to only use a single program instance, even when the '''/shared''' command line switch is not specified.

== [Paths] ==
* '''Export_Directory''': The default export directory for lossless and lossy audio export. OpenMPT always uses the last used directory for exporting, so changing this setting does not make a lot of sense.
* '''UseAppDataDirectory''': This is a legacy setting imported from portable OpenMPT installations prior to version 1.29. If <code>mptrack.ini</code> is found next to <code>OpenMPT.exe</code> and this value is to 0, portable mode is assumed and all other configuration files are searched directly in the same directory as OpenMPT’s executable (by default they are placed in %APPDATA%\OpenMPT). When upgrading to a newer OpenMPT version, this setting is automatically converted to the new way of enabling portability. See also: [[Manual: System Setup#Portability|System Setup]].

== [Pattern Editor] ==
* '''AccessibilityFormat''': Defines the description of the pattern editor that can be obtained by screen readers. The string may contain the following variables: <code>%sequence%</code>, <code>%order%</code>, <code>%pattern%</code>, <code>%row%</code>, <code>%channel%</code>, <code>%channel_name%</code>, <code>%column_type%</code>, <code>%column_description%</code>.
* '''AlwaysDrawWholePatternOnScrollSlow''': If set to 1, OpenMPT will always repaint the whole pattern display instead of re-using parts of the window that have only moved and not changed. This will be measurably slower, however in some situation the display will look broken otherwise (like jittering play cursor, not updating regions of the pattern display properly when switching to and from the window, or generally sluggish/jerky display). The problem is related to certain graphics drivers (known examples are systems with multiple AMD GPUs in Windows 7, Windows XP in VirtualBox, and all Wine systems). By default, this setting is 0. On Wine, this setting has no effect and is treated as always 1, regardless of its actual value.
* '''AutoHideVolumeColumnForMOD''': When set to 1, the volume column is hidden by default for MOD and other formats that do not have a volume column.
* '''DefaultSequenceMargins''': Defines how many order items are shown at least before and after the currently selected order item (0 by default).
* '''EditStepAppliesToCommands''': When set to 1, the edit step setting is also applied when entering a command into the volume or effect column.
* '''FontDot''': Overriding this setting allows to specify a custom character to be used for empty cells with user-configured pattern fonts.
* '''NoEditPopup''': Disables the reminder popup when trying to edit patterns while editing is disabled and treats all channel columns like the note column to simplify jamming (keyjazz).
* '''OrderListOldDropBehaviour''': Restores pre-OpenMPT 1.29 drag & drop behaviour in the order list editor. That is, patterns are always dropped left of the drop position, even if the drop position is right of the source.
* '''RowDisplayOffset''': Defines the displayed number of the first pattern row; by default, it is 0. This does not affect the Goto dialog or break commands in patterns.
* '''VolumeColumnInHex''': If set to 1, parameters in the volume column are shown in hexadecimal rather than decimal. In order to be able to enter hex digits A-F, the corresponding [[Manual: Keyboard Actions#Volume Column|keyboard shortcuts]] need to be assigned (note that you may have to re-assign effect letters a-f to avoid conflicts).

== [Sample Editor] ==
* '''FLACMultithreading''': By default, the FLAC encoder uses one thread for FLAC sample saving. Setting this to 1 enables multithreaded FLAC encoding for samples.

== [Sound Settings] ==
* '''AllowDeferredProcessing''': If set to 0, deferred processing is never used for ASIO drivers.
* '''BoostedThreadPriority''': Set the priority (for Windows XP) used for sound devices which have "Boost thread priority" set. Possible values are -15,-2,-1,0,1,2,15 (or the full range -15..15 if [Misc]ProcessPriorityClass is set to "realtime"). Default value is 2. See further discussion on the [https://forum.openmpt.org/index.php?topic=5655.0 forum]. '''Warning''': Changing this setting can cause system lockups requiring hard system reset.
* '''BoostedThreadMMCSSClass''': Set the Multimedia Class Scheduler Service (MMCSS) class used for sound devices which have "Boost thread priority" set. Possible values are "Pro Audio", "Games", "Audio" or anything else that may be configured on your systems MMCSS. Default value is "Pro Audio". See further discussion on the [https://forum.openmpt.org/index.php?topic=5655.0 forum]. '''Warning''': Changing this setting can cause system lockups requiring hard system reset.
* '''MaskDriverCrashes''': If set to 1, OpenMPT will try ignore crashes in ASIO drivers.
* '''MixChannels''': Default is 256. The maximum number of sound channels that OpenMPT will use to render. In other words, Polyphony is the allowable number of notes that OpenMPT will process at once. Any computer that has been built in the last ten years should be able to handle the maximum amount of channels for most modules, but while older, low-end computers you will want to decrease the number of channels. Note that reducing the maximum polyphony only reduces the CPU load if those extra channels were actually used — if you play a 10-channel MOD file, it does matter little, if at all, whether the maximum polyphony is set to 16 or 256.
* '''ResamplerWFIRCutoff''': Configures the bandwidth of the audio signal that is retained by the 8-tap Sinc filter (without low-pass) in percent. The default of 97% offers a good compromise between “freshness” and quality of the resampled sound.
* '''SampleRates''': A comma-separated list of sample rates that OpenMPT will show in the sound device settings (if supported by the device) and when exporting a WAVE or FLAC file.
* '''XMMSModplugResamplerWFIRType''': Configures the windowing function of the 8-tap Sinc filter (without low-pass). The windowing functions, from 0 to 7, are: Hann, Hamming, Blackman Exact, Blackman 3-Tap 61, Blackman 3-Tap 67, Blackman-Harris, Blackman 4-Tap 74, Kaiser α=7.5

== [VST Plugins] ==
* '''BridgeAllPlugins''': All plugins are forced to be used through the integrated plugin bridge.
* '''EnableAutoSuspend''': Enables auto-suspend for all plugins newly added to modules after this setting is turned on. If a plugin did not emit any sound during the last four seconds, it is suspended until new notes or sound data are fed into the plugin.
* '''EnableMidiMappingInEditor''': If set to 0, holding <kbd>Shift</kbd> while modifying a plugin parameter does not open the [[Manual: MIDI Mapping|MIDI Mapping dialog]].
* '''HostProductString''': Here you can enter a custom host name that is sent to VST plugins. This can be useful if a plugin claims to only run in certain hosts and refuses to run in others.
* '''HostVendorString''': Here you can enter the host vendor name for the same reasons as above.
* '''HostVendorVersion''': Here you can enter the host version as a 32-Bit integer for the same reasons as above.
* '''ProjectPath''': Some plugins can store extra data alongside the module file. This behaviour can be overridden so that plugins use a different path. This setting can be either a normal absolute path or use the variables <code>%1</code> (module path) and <code>%2</code> (module filename) to build a path relative to the module location. So if all external plugin data should be stored in the folder <code>module.mptm-data</code> (assuming module.mptm is the module filename) next to the module, this value should be set to <code>%1%2-data</code>. Due to restrictions posed by the VST architecture, this path must not contain characters outside the current [https://en.wikipedia.org/wiki/Windows_code_page#ANSI Windows ANSI code page].

[[Category:Manual|Hidden Settings]]
[[de:Handbuch: Versteckte Optionen]]

Tutorial: Getting Started

2025-07-05T21:31:47Z

Saga Musix: /* Introduction */

== Introduction ==
Welcome to this beginners tutorial. It is directed towards newbies who have just downloaded OpenMPT and are about to get started with using the program. Read this tutorial to get the hang of this piece of software. In easy steps, you will learn how to load samples and use them to create a simple song. This tutorial will not cover each screen in depth. There are other pages in this manual that do this.

This tutorial will use the song Aryx.s3m as a reference. You can download Aryx at [https://modarchive.org/module.php?191789 The Mod Archive].

== Getting Started ==
If you have not even downloaded OpenMPT yet, you should read the [[Manual: System Setup#Installation|System Setup]] page first for instructions on how to download and install OpenMPT.

Assuming that you did everything on that page, you can now start OpenMPT. If it is the first time that you start the program, the Welcome dialog will pop up. You can configure OpenMPT to your needs in this dialog and the [[Manual: Setup|Setup dialog]] now, or you can do that at a later stage by pressing View → Setup.

=== Setting up the sound card ===

The only important thing right now is to set up the sound card properly. Go to the [[Manual: Setup/Soundcard|Sound Card]] tab of the Setup dialog. Check the available sound devices by pulling down the list. If you have a WASAPI device available, select it (this is the default). If you have professional audio hardware with a dedicated ASIO driver, you may also select that. WASAPI devices usually work fine with a latency of 20-30ms. If using an ASIO or WaveRT driver, you should be able set the latency to less than 10ms without problems. If you use MME (not recommended), try a value between 30-100ms.

The lower this latency is, the better — but setting it too low will result in crackling. The Update Interval should also be as low as possible, to keep the GUI as tightly in sync with the audio as possible.

[[Image:Settings Keyboard.png|thumb|300px|Setting up the keyboard]]

=== Setting up the keyboard ===

This tutorial references key combinations that are used by the default keyboard configuration of OpenMPT. If available, you might have chosen a language-specific keyboard mapping in the Welcome dialog. Almost all default keyboard configurations are almost identical and are mostly adjusted to fit differening keyboard layouts, though. If some of the keys referenced in this tutorial do not “fit”, you may want to go to the [[Manual: Setup/Keyboard|Keyboard Settings]] and hit the “Restore default configuration” button or look up the correct shortcut there.

When you are done, press OK to close the dialog.

== Creating a new song ==

In the menu bar, go to the “[[Manual: Menus#File|File]]” menu, open the sub menu “New” and choose “IT” from the list of offered formats.

== Loading drum samples from Aryx ==

OpenMPT can handle working on several songs at once. You probably will not want to actually edit two songs at the same time in most situations, but you can view one while working on another. :) We are going to use this principle to load in samples from Aryx, which you should have downloaded from [https://modarchive.org/module.php?34036 The Mod Archive]..

The second icon in the toolbar is the open button. Press this button to open an existing song. Browse to the Aryx song. Note, OpenMPT can load songs inside ZIP archives, and also from RAR, LHA and GZ archives. You must set the file filter to '''All files''' to let the ZIP files be shown though… and saving to a ZIP file is not possible. :)

[[Image:Tutorial Tree View.png|thumb|184px|“Aryx” in the tree view.]]

Once you have loaded Aryx, you will see that it appears in the [[Manual: Tree View|Tree View]] on the left. It will also be the active song.

* In the tree view, click on the '''Module 1''' folder to jump back to our newly created module.
* Click on the '''[[Manual: Samples|Samples]]''' tab.
* In the tree view on your left, locate Aryx again. Do not click on Aryx, but on the little plus sign next to the '''Samples''' folder to expand it.
* Drag “3: Time: 2:21” to the big black screen on the right to load that sample.
* Click on the first icon in the toolbar on this screen (New Sample). Drag “6: Tune composed using” to the right to load it too.
* Click on the New Sample button. Drag “5:” to the right to load it as well.
* Click on the New Sample button. Drag “4: ___________________________” to the right to load it too.

When you see these waveforms, note that you can use any key on your keyboard (<kbd>A</kbd>-<kbd>Z</kbd>) to get sound out of them. This works like a piano. In fact, most keyboard configurations will actually set it as a piano with the white and black keys positioned as that too. The default configuration however allows you to have more notes to work with. Note that when pressing QWERT in that order (AZERT on a French keyboard), the tone pitch raises by semitones. ASDFG does the same but one octave higher, and ZXCVB is the same too but another octave higher.

We have now loaded some basic samples which we can use to make a drum pattern.

== Making your first 4/4 drum pattern ==

[[Image:Tutorial Bass Drum.png|thumb|150px|Select the first instrument and start jamming!]]
4/4 drum patterns (aka “Four-to-the-Floor”) are common in all kinds of disco and dance music. Really simple stuff so it is great to start with that. First, let us go to the '''[[Manual: Patterns|Patterns]]''' tab to be able to enter notes.

Since making a beat largely depends on the time signature used, it is nice to actually see the beats in your pattern. If every row in the pattern looks the same to you, row highlighting has probably been turned off. In that case, you can turn it on again in the [[Manual: Setup/Display|Display setup]]. Turn on both “Primary highlight” and “Secondary highlight”.

As you see, every 16th row has a darker colour than every 4th row. These are measures and beats. By default, a pattern has four measures with four beats each. This can be changed, but we are not going to do that now.

* In the toolbar, you see a dropdown list with a spin button on the left side. In this list, you can choose the '''main instrument''' that is used for editing. Set this to '''01:...''', as it can be seen in the screenshot on the right.
* Next to this dropdown list, you see '''Edit Step'''. Set this value to 4. It will make the pattern cursor move down by four rows after having entered a note.
* In the toolbar on top (below the menu) there is a field '''Octave''' which configures the base octave of your keyboard. By default, this is to 4, so if you have changed it before, set it to 4 again.
* Click on the first row in Channel 1.
* Make sure that the cursor is positioned in the leftmost cell of that channel. This cell is used for entering notes.
* Start tapping A until you have a C-5 01 on row 12.
* Now, select the measure you have just entered using your mouse cursor: Click on the '''0''' left to the first row of the first pattern and hold the mouse button clicked while you drag the mouse down to the row that has '''15''' next to it. Release the mouse button and press <kbd>Ctrl</kbd>+<kbd>C</kbd> (or choose '''Copy''' from the '''Edit''' menu).
* Move the cursor to the leftmost column of the row that has '''16''' next to it. Right-click on that position, choose '''Paste Special''' from the menu, and in the now opening sub menu, choose '''Paste Flood'''. Great, now the whole pattern is filled with a 4/4 beat! Using '''Paste Flood''', you can quickly create beats and other song structures that do not change a lot.
* Press F6 to play your first pattern.

At any time, you can press <kbd>F8</kbd> to stop the sound, so you can continue to work. Now would be a good time to press <kbd>F8</kbd>. :)

=== Adding percussion to your rhythm ===

Of course this simple 4/4 drum beat is not enough. Let us add some Hi-Hats in between.

* Start by selecting instrument 04 from the '''main instrument''' panel above.
* Scroll up so you can see row 0 again.
* Select the first cell in channel 2, row 2.
* Start tapping <kbd>Z</kbd> until you have a C-6 04 on row 62. Again, you can speed up this process by using '''Paste Flood''' if you want.
* Press <kbd>F6</kbd> to audit the result.
* Set the '''Edit Step''' to 1 using the toolbar above.
* Select the cell in channel 2 on row 29 and press <kbd>Z</kbd> to enter a note.
* Scroll down, select the cell: channel 2, row 61 and enter a note there too.
* Note how the cursor automatically moves to row 62. Press Delete to remove the note.
* If the instrument number next to the note is still there (this depends on the keymap you use), move the cursor to the instrument column and press delete again to also remove the 04.
* Move left again, and one down to row 63 and press <kbd>Z</kbd> to enter a note.
* Press <kbd>F6</kbd> to audit the result.

=== Adding a snare to give it even more depth ===

* Select Instrument 2 from the '''main instrument''' panel above.
* Set '''Edit Step''' to 8.
* Select the first cell of channel 3, row 4.
* Start tapping <kbd>Z</kbd> until you have a C-6 02 on row 60.
* Press <kbd>F6</kbd> to hear the result.

=== A hint in between ===

You have now succesfully created a drum loop. Before you continue, note how we made use of every fourth line for the beat to emphasize it, and every second line after to get a balanced feeling. Also note how between lines 29 and 31 and 61 and 63 we used the other two lines to make it out of balance to get a nice variation. You will learn how this works automatically by making (and listening to) more music, though it will probably not happen within a week, maybe not even in a month. To start with, you should therefore experiment with different settings and see if you can create different kind of drum loops. Often, you can make a beat sound more interesting by delaying or pushing up some notes by a line every now and then.

This however just takes time, so do not worry and let us continue to the next part of this tutorial.

== Adding a Bassline ==

Before I just tell you what notes to enter, I would like to explain a bit how basslines work. A bassline is not just a melody played on a lower octave with a bass instrument. A bassline actually forms part of the rhythm. The bassline usually sets the base note for your rhythm. The bass section in a song can be seen as part of the background. Although it is strong and present, it usually does not play a melody of its own. In certain musical styles, it can be done to play a repetitive melody so that you get more groove.

Okay, so let us add that bassline to our track! To start, we will need a sound for our bass.

Select the sample tab and create a new sample (first button in the sample toolbar). From the treeview, drag in sample 8: ___________________________ from Aryx to your sample window. This will be our bass sound. Before we enter our bassline, let us play the pattern one more time by pressing the play button on the main toolbar (below the menu) to get some ideas on what to enter, and stop playback once you get an idea. As this is a tutorial, I do not expect you to actually get ideas yet, but at least you now know a way to look for inspiration. :)

=== Entering a simple bassline ===

Go back to the pattern screen and select sample 5 from the toolbar if that has not been set yet.

Go to the first cell of channel 4, row 0, and press <kbd>E</kbd>, which will put in a D-4 05. Play the pattern to hear the result. As you can hear, the sound is there, but it certainly is not a bass sound. It is too high for that. We will need to adjust the octave in order to get the right range of notes. In the main tool bar, there is an '''Octave''' setting. Set it to 3 using the arrow buttons next to it.

Again, go to the first cell in channel 4, row 0 and press <kbd>E</kbd> to enter a D-3. Play it again to hear the difference. Note that pressing a number between 0 and 9 while having the cursor on a note is also a quick way to change the octave of an existing note, but doing this for every note can be quite tiresome.
Let us make the bassline more fancy. Remain in channel 4 and press the following keys in the following rows:

* Row 16: Press <kbd>Y</kbd>
* Row 32: Press <kbd>Q</kbd>
* Row 48: Press <kbd>I</kbd>

And play your pattern.

We have just created a really simple bassline, but frankly, it sounds rather dull at the moment. Let us make it a bit better by adding silence.

Enter the following notes:

* Row 8: Press the key left to the <kbd>1</kbd> key to put a Stop note (“^^”) in the pattern. On US keyboards, this key is labelled <kbd>~</kbd> and will from now on be referenced as such.
* Row 24: press <kbd>~</kbd>
* Row 40: press <kbd>~</kbd>
* Row 56: press <kbd>~</kbd>

Press <kbd>F6</kbd> to hear the results.
[[Image:Tutorial Bassline.png|thumb|300px|Adding a bassline makes our song a lot more interesting.]]

=== Entering a more complex bassline ===

Okay, so this is indeed a better bassline, but you will probably be like: “But how about those fancy dance basslines?” Sure, We will make one. To start, remove the notes in channel 4 first. Make sure that you are in channel 4, and hit <kbd>Ctrl</kbd>-<kbd>L</kbd>. This will make a selection in that column. If you accidentally hit <kbd>Ctrl</kbd>-<kbd>L</kbd> again, it will select the entire pattern. Hit it again to select just one channel. Press Delete to delete the content.

Go back to row 0. At this time, we are going to make it easy for us. Set the Edit Step to 2, and repeat the following four times:

* Press <kbd>~</kbd>
* Press <kbd>E</kbd>

Then do the following 4 times:

* Press <kbd>~</kbd>
* Press <kbd>Y</kbd>

Do the same 4 times with <kbd>Q</kbd> and <kbd>I</kbd>.

If you have done it right, you should have this nice dancy baseline, so go ahead, play your pattern to find out.

== Creating your first sample ==

Sometimes, you need a sample with a very basic waveform, or you have to fix the waveform of an existing sample (probably because it contains unwanted “clicks”). For these purposes, OpenMPT offers a sample drawing functionality, which is especially popular among chiptune artists. With this feature, you can easily create small chiptune samples within seconds. So let’s try this!

[[Image:Tutorial Pencil and New.png|thumb|61px|Sample Drawing]]
Go to the Sample tab and, as always, create a new sample slot by pressing the upper-left button in the sample editor.
This time, we will not drag an existing sample into the sample editor, but rather create our own. To do this, click the yellow icon next to the pencil icon, right above the sample view (which is still completely blank). You are asked to enter a sample length; in this case we choose a length of '''173''' sampling points. Press OK to confirm the choice — you now have an empty sample!

Now you can start doodling around in the sample view by pressing the pencil icon. Draw a straight line that goes from the lower-left to the upper-right corner. Press the note icon (next to the sample name) to preview your sample. Keep doodling around by drawing other kinds of lines until you like the result. Press the note icon again to stop playback and the pencil icon to disable sample drawing.

[[Image:Tutorial Sample Freq.png|thumb|133px|Middle-C Frequency]]
Next up, we are going to modify the middle-C frequency of this sample, so that it is tune with the bass sample. To accomplish this, locate the “Freq. (Hz)” in the upper half of the sample editor and enter '''44125''' in the box next to it. This is the playback frequency at middle-C (C-5).

[[Image:Tutorial Loop Sample.png|thumb|123px|Loop Settings]]
Since we are using a very short sample (a “chip” sample), the perceived pitch of the sample does not only depend on the middle-C frequency, but also the loop length of the sample. Go back to sample 5. Play it, and you will notice that it does not have quite the same pitch as sample 6, even though they have the same middle-C frequency. To fix this, go back to sample 6 and enter '''7''' in the “Start” box in the “Loop” section. Now the sample’s loop is exactly as long as the bass sample’s loop and thus they have the same pitch.

== Adding a Melody ==

Basically this is the same as adding a bassline, except that you will be focussing on that what plays in the foreground.

The melody is something that can continuously change throughout the entire track, or can be a repetition with certain variations. In order to know what types of melodies there are, listen to music, focus on the melodies and start noticing. :)

But at this stage, we just want to add a melody to our tutorial song. Go back to the pattern editor and let us enter a simple melody. Select Sample 6 from the toolbar for that.

Assuming that you still have the Edit Step set to 2, go to channel 5 row 0, and enter the following notes:

<kbd>C</kbd>, <kbd>~</kbd>, <kbd>B</kbd>, <kbd>N</kbd>, <kbd>~</kbd>

Then go to row 24 and enter the following notes:

<kbd><</kbd>, <kbd>~</kbd>, <kbd>N</kbd>, <kbd>~</kbd>, <kbd>Z</kbd>, <kbd>~</kbd>, <kbd>C</kbd>, <kbd>B</kbd>, <kbd>~</kbd>

Then go to row 56 and enter the following notes:

<kbd>N</kbd>, <kbd>~</kbd>, <kbd>B</kbd>, <kbd>~</kbd>

You now have created a basic melody.

== Adding depth to your melody to make it cool! ==

Yes, I have to admit, the melody is a bit dry like this. So let us put an echo on it. There are several ways to do it actually. You could program the echo in the patterns or you could use a sound processing plugin.

[[Image:Tutorial Plugins.png|thumb|300px|Plugins are managed in the lower part of the General Tab.]]

Here, we will actually discover both possibilites to learn about various techniques.

First, we start with the easier solution (although I prefer the second solution).

=== Adding an echo using a plugin ===

* Go to the '''[[Manual: General|General tab]]'''.
* In the lower third of the tab, you see the plugin configuration area. There is a dropdown list which reads “FX1: undefined”.
* Next to that list, click the '''Select''' button.
* Expand the '''DirectX Media Audio Effects''' folder.
* Double-click '''Echo'''.

“FX1: undefined” has now changed to “FX1: Echo”, and this plugin slot contains an instance of the built-in [[Manual: Echo Plugin|Echo plugin]]. Let us add it to our lead melody to hear its effect.

[[Image:Plugin Manager.png|thumb|300px|From the plugin manager, load the Echo plugin.]]
[[Image:Tutorial Plugin Editor.png|thumb|300px|Edit the plugin parameters to make the echo sound as intended.]]

* Above the plugin configuration area, you can find the channel settings. At the top of this area, there are tabs labelled “1 - 4”, “5 - 8”, and so on. As our melody is in channel 5, we select the '''5 - 8''' tab.
* Below Channel 5, there is a dropdown list labelled '''Effect'''. In that list, select '''FX1: Echo'''.
* If you play your song now, it sounds surprisingly nice already, but we are going to make it sound even nicer.
* In the plugin configuration area, press the '''Edit''' button next to the '''Select''' button we pressed earlier.
* Set the '''WetDryMix''' parameter to 44.40, by entering 444 in the edit box next to the corresponding slider.
* Set the '''Feedback''' to 50.00 (enter 500 in the edit box).
* Set the '''LeftDelay''' to 360.82 (enter 180)
* Set the '''RightDelay''' to 720.64 (enter 360) — Notice that the right delay is twice as long as the left delay.
* Set the '''PanDelay''' to Yes (drag the slider way to the right).

And there we go, a nice echo on the lead!

=== Adding an echo using pattern programming ===

First, we remove the echo from the previous step again.

* Go back to the General Tab if you have left it in the meanwhile.
* In the plugin area, check the '''Bypass''' checkbox, so that our echo effect will not be processed anymore.

If you want, you can also remove the echo effect completely by clicking the '''Select''' button and choosing '''No plugin''' from the plugin list.

Now, go back to the pattern editor.

* Put your cursor on channel 5 and press <kbd>Ctrl</kbd>-<kbd>L</kbd>, <kbd>Ctrl</kbd>-<kbd>C</kbd>.
* Go to channel 6, or press <kbd>Tab</kbd> to go to the next channel. Go back to row 0, by pressing <kbd>Ctrl</kbd>+<kbd>Home</kbd> and press <kbd>Ctrl</kbd>-<kbd>V</kbd>.

An exact copy of your channel has been made. That is of course not an echo yet.

* Press <kbd>Insert</kbd> 3 times.
* Press <kbd>Ctrl</kbd>-<kbd>L</kbd> and then <kbd>Ctrl</kbd>-<kbd>M</kbd>.
* Enter Amplify by 50%.
* Repeat the above steps for Channel 7, so <kbd>Ctrl</kbd>-<kbd>C</kbd>, <kbd>Tab</kbd>, <kbd>Ctrl</kbd>-<kbd>V</kbd>, 3x <kbd>Insert</kbd>, <kbd>Ctrl</kbd>-<kbd>L</kbd>, <kbd>Ctrl</kbd>-<kbd>M</kbd>, 50%.
* Repeat the above steps for Channel 8.

If done correctly, the notes in channel 8 have a '''v08''' next to them. This means that play at a volume of 8, which is quite soft (the maximum volume is 64).

Note: We have duplicated the channel using the Copy and Paste mechanism. Of course this would be quite tiresome if we want to duplicate a channel that contains some note data on several patterns already. For that reason, you can also use the '''Duplicate Channel''' menu item from the channel header’s context menu to speed this process up.

== Working with the order list ==

Now you know how to fill a pattern with notes so you can create some music. Let me explain how to create different patterns and play them as a song.

Directly above the pattern view, you can see a big horizontal bar with squares in it. The first square is filled with '''0''', the rest with '''---'''. This is the '''order list'''. It dictates in which order the different patterns are played. So far, only pattern 0 (the first pattern) is played at all, as we do not have any other patterns yet.

Every number in the order list references a pattern. In the pattern editor, you can see the number of each pattern in the top left corner, above the row numbers. At the moment, it should say '''#0'''. Note that you can click this number to bring up the [[Manual: Pattern Properties|Pattern Properties dialog]] which you can use to '''change the length of the pattern''', i.e. how many rows the current pattern contains.

* Back to the order list. Right-click the '''0''' and select '''Duplicate Pattern''' from the context menu.
* Go back to the pattern editor and use the mouse to make a selection from channel 4, row 0 to channel 8, row 63.
* Press <kbd>Ctrl</kbd>-<kbd>Q</kbd> 5 times. Now you have transposed the notes in those channels, which is one way to alter patterns.

You can also remove and / or add notes to change the pattern. Here, creativity is your key.

In the orderlist, you can also right-click a pattern and select '''Insert Pattern''' to make a new order with the same pattern. That way, when you play your song, it will have the same patterns played twice. Note that if you edit the first occurrence of a pattern, it will change '''all''' patterns with the same number.

Now, select pattern 0 from the order list, right-click it, and select '''Insert Pattern'''. Now you should have an order list that contains pattern 0 twice and after that pattern 1.
Now, do the same for pattern 1, so that the order list reads 0-0-1-1.

Now we want to listen to our song. In the main toolbar below the main menu, click the play button. Now you can watch how the patterns play by checking the '''Follow Song''' checkbox.

You can go on building your song from here. When you right-click an order list item, you can also choose '''Create New Pattern'''. This creates new, completely empty pattern. Sometimes, this is useful if you have made a transition and want to start with completely something new.

=== Keeping your order list tidy ===

[[Image:Tutorial Order List.png|thumb|232px|A tidy order list can speed up editing significantly.]]

A neat trick to keep the order list tidy is to add separator ('''+++''') patterns. You can think of them as markers that do not contain an actual pattern but are being skipped. It is common to add a separator pattern after each four patterns, as that fits with most song structures. To insert a separator pattern, click on an empty pattern ('''---''') and press the <kbd>Minus</kbd> key once. If you want to add a separator pattern between two existing patterns, you can simply click on the pattern after which the separator should be added and press <kbd>I</kbd>. As with many other things in OpenMPT, there are mutiple ways to do the same thing. :)

It is also worth knowing that you can select a range of patterns to insert or duplicate. Simply click on the first pattern that you want to insert / duplicate and <kbd>Shift</kbd>-click the last pattern. Now you can drag multiple patterns at the same time, duplicate them, etc...

== Using Find / Replace ==

[[Image:Find_And_Replace.png|thumb|300px|Using Find / Replace can eliminate the need for searching manually.]]

Let’s say you’ve been making your song now for quite a while. Maybe you want to replace an instrument with another one, or you entered a wrong effect and need to change it. You could do this by manually going through each and every pattern, but there is a more efficient method available: [[Manual:_Find_and_Replace|Find / Replace]].

=== Accessing Find / Replace ===

You can access the Find / Replace through “Edit” in the main menu bar by choosing “Find / Replace”, or through a hotkey, the default being <kbd>Ctrl</kbd>+<kbd>F</kbd>. If you already have a search set up, you can select “Find Next” or its hotkey, the default being <kbd>F3</kbd>, to cycle through each occurrence all the to the end of the module. Otherwise, the Find / Replace menu will appear.

=== Setting up a Search ===

With the Find / Replace menu open, select the '''Find''' tab. This is where you will set up your search parameters and what to look for in the module. There is a fairly comprehensive list of options available. Click the checkbox next to each option to have the search look for it. If multiple checkboxes are enabled, all criteria must be met for a term to be found.

You can have the search only look in the current pattern, the entire song, or if you have a selection highlighted, your selection. You can also click the checkbox for “Only Certain Channels” to have the search only consider the channels in the range allotted (inclusive).

For our tutorial module, we want to transpose the melody to sound an octave higher:
* Press <kbd>Ctrl</kbd>+<kbd>F</kbd> to open up the Find / Replace dialog.
* Select from the “Instrument” dropdown menu instrument 006. The “Instrument” checkbox will be checked automatically.
* At the bottom, select “Find in the whole song”
* Switch to the “Replace” tab at the top.
* Check the “Note” box, and select “+1 oct” from the dropdown menu.
* Make sure that “Replace All (no confirmation)” is checked, and hit OK.

Now all of the melody, which is sample number 6, will sound 1 octave higher than it did before. If this is too high and you want to back to how it was, you can repeat the above steps and select “-1 oct” instead of “+1 oct”. Alternatively, you can undo the whole replacement by using the “Undo” functionality in the “Edit” menu.

== Looking for Inspiration ==

Just like with most things, the art of tracking requires time and effort in order to be mastered. To see good examples of what can be done in OpenMPT, open “Help” in the main menu bar, and then select a module from the “Example Modules” list to open it. Each of these modules are by a listed author and with their own title, all in OpenMPT's [[Manual:_Module_formats#Manual:_Module_formats_MPTM|‘MPTM’ Module Format]]. It is encouraged to look through all of these modules to see a variety of styles and genres that can be done in OpenMPT, and you may even pick up a few good habits and knowledge from closely studying them. The modules usually have comments that will provide helpful advice as well, so do not skimp on reading them. If you are just beginning your tracking journey, don't immediately expect to reach the quality of these modules, as great accomplishment comes from great practice first and foremost.

== That’s all, folks! ==

That’s it for now. If you have any questions, feel free to ask them at our [https://forum.openmpt.org/index.php forums].

If you want to see the tutorial song as it should be if you have done everything as described above, you may [https://download.openmpt.org/resources/modules/beginner_tutorial.it download it].

[[Category:Tutorials|Getting Started]]
[[Category:Manual|Getting Started with OpenMPT]]

Manual: Edit History

2025-07-02T13:52:42Z

Saga Musix:

[[Image:Edit History.png|thumb|400px|Edit History of a loaded IT module]]

You can view this dialog by selecting “Edit History” from the [[Manual: Menus#View|View menu]]. The full edit history is only available for IT and MPTM files, but a more limited history may be available in other formats (e.g. S3M files saved with Impulse Tracker). This dialog lists the edit events, displaying the timestamps for each time the file was loaded into the tracker and modified. The first entry is when the track was created (if the history was never cleared). At the bottom of the window is the total time elapsed while the file was open, and the number of times the track was loaded. Clicking on the Clear button will erase all of this data, but the info is lost only if you save the track afterwards.

[[Category:Manual|Edit History]]
[[Category:Windows|Edit History]]

File:OPL Export.png

2025-06-29T12:25:55Z

Saga Musix: Saga Musix uploaded a new version of File:OPL Export.png

File:MIDI Conversion Setup.png

2025-06-29T12:24:38Z

Saga Musix: Saga Musix uploaded a new version of File:MIDI Conversion Setup.png

MIDI Conversion Setup dialog

File:Wave Convert.png

2025-06-29T12:24:31Z

Saga Musix: Saga Musix uploaded a new version of File:Wave Convert.png

Wave Convert dialog

Manual: Hidden Settings

2025-06-29T11:10:07Z

Saga Musix:

[[Image:Settings Advanced.png|thumb|300px|Advanced tab of the settings dialog]]

Some settings for advanced users cannot be changed directly in OpenMPT, however they can be changed by modifying OpenMPT’s configuration file, mptrack.ini, or from the [[Manual:_Setup/Advanced|Advanced Settings]]. When using the latter method, it might be necessary to restart OpenMPT for some options to take effect.

== [Broken Plugin Workarounds] ==
* '''VSTMaskAllCrashes''': Determines whether crashes in VST plugins should be reported to the user (1) or passed on to the system, i.e. OpenMPT crashes (0). Note that if a plugin crashed, its internal state or even OpenMPT’s state may be inconsistent, so in this situation it is best to close and reopen the tracker anyway.
* '''VSTNeverUnloadAnyPlugin''': If set to 1, VST plugins are not fully unloaded when closing them. This may help with some buggy plugins (e.g. made with older versions of SynthEdit 1.4). Do not enable this setting unless you have issues when unloading plugins that cannot be solved by using the plugin bridge.

== [Components] ==
* '''BlockASIO''', '''BlockPortAudio''', '''BlockRtAudio''', '''BlockWaveOut''': If set to 1, the respective sound device types do not get initialized or queried by OpenMPT. You should not need to disable any of these unless told to do so by the OpenMPT developers in order to diagnose problems.
* '''BlockMediaFoundation''': If set to 1, OpenMPT will not load any samples using MediaFoundation codecs.
* '''BlockWineWrapper''': If set to 1, OpenMPT will not load the Wine native audio wrapper.
* '''KeepLoaded''': If set to 0, optional OpenMPT components (e.g. MP3 codecs) are unloaded after usage. This frees up memory used by these components but slows down subsequent uses.
* '''LoadOnStartUp''': If set to 1, some optional components are loaded right on statup instead of when they are first used.

== [Debug] ==
Options in this section should generally only be changed if you are advised by an OpenMPT developer to do so.
* '''DelegateToWindowsHandler''': If set to 1, OpenMPT will invoke the Windows default crash handler after its own crash handler has finished generating the crash report which had been the behaviour in OpenMPT before 1.27.
* '''StopSoundDeviceBeforeDump''': By default, the sound device is closed after writing out a crash dump. Setting this option to 1 inverts the behaviour.
* '''StopSoundDeviceOnCrash''': If set to 0, OpenMPT will not close or otherwise touch the state of the sound device when writing out a crash dump. Only change this setting when asked by the OpenMPT developers to do so in order to diagnose sound device related crashes.
* '''TraceAlwaysDump''': If set to 1 and '''TraceEnable''' is also set to 1, OpenMPT will always write out the trace log on program exit even if no crash happened. Do not enable this setting unless you are advised by the developers to do so.
* '''TraceEnable''': If set to 1, a trace logging system is enabled which can be used by the OpenMPT developers to debug certain problems. Do not enable this setting unless you are advised by the developers to do so.
* '''TraceSize''': Configures the tracer buffer size. By default, it contains 1,000,000 entries.

== [Display] ==
* '''FSUpdateInterval''': OpenMPT watches the '''f'''ile '''s'''ystem in order to update the [[Manual:_Tree_View#Instrument_Library|instrument library]] tree view when files get added or removed to the directory while OpenMPT is running. This setting limits the rate of the GUI updates in these cases to the given value in milliseconds. The default is 500ms.
* '''GUIUpdateInterval''': Defines the update interval of the GUI in milliseconds (default: depends on the period value found in the sound card settings).
* '''ShowSplashScreen''': If set to 0, no splash screen is shown when starting the program (same effect as [[Manual: Command-line Parameters|command line option]] /NoLogo).
* '''UseOldStyleFolderBrowser''': When set to 1, the classic tree-style folder picker is used on Windows Vista and newer. On older systems and Wine, it is always used.
* '''VuMeterUpdateInterval''': Defines the update interval of the VU meters in milliseconds (default: 15ms).
* '''VuMeterDecaySpeedDecibelPerSecond ''': Sets the VU meter's decay speed The default value is 88 dB/s.

== [Export] ==
* '''DefaultToSoundcardSamplerate''': By default, the [[Manual: Saving and exporting#Exporting tracks|export dialog]] presets the export frequency to the tracker’s currently selected sample rate. One reason for this behaviour is that some plugins do not like it when the sample rate is changed between normal playback and export. If you do not like this behaviour, you can set this value to 0. In this case, OpenMPT remembers the previously selected sample rate instead.
* '''FLACCompressionLevel''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to FLAC format, this value sets the FLAC compression level. Higher values mean better compression ratio and require more CPU time. For details, please refer to the FLAC documentation.
* '''FLACMultithreading''': By default, the FLAC encoder uses all available CPU cores for FLAC encoding. Setting this to 0 disables the multithreaded encoding.
* '''MP3ID3v2MinPadding''': This value is the minimum amount of padding bytes to add to ID3v2 tags.
* '''MP3ID3v2PaddingAlignHint''': This aligns the MP3 data after the ID3v2 tag in addition to the minimum padding to a multiple of the configured value. Set to 0 to disable additional aligning.
* '''MP3ID3v2WriteReplayGainTXXX''': Write ReplayGain information (if calculated, see '''MP3LameCalculateReplayGain''' and '''MP3LameCalculatePeakSample''') to the ID3v2 tag. This setting defaults to 1.
* '''MP3LameCalculateReplayGain''' and '''MP3LameCalculatePeakSample''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to MP3 format, calculate the ReplayGain track gain adjustment and the peak sample value (as require by ReplaGain) respectively. The calculated values get written to the VBR/Lame info header automatically in VBR mode. Additionally, the values can be written to the ID3v2 tags when enabled (see '''MP3ID3v2WriteReplayGainTXXX'''). Both settings default to 1.
* '''MP3LameID3v2UseLame''': If set to 1, when [[Manual: Saving and exporting#Exporting tracks|exporting]] to MP3 format, uses the libmp3lame ID3v2.3 implementation instead of the OpenMPT ID3v2.4 implementation. ID3v2.3 is more widely supported by older player software.
* '''MP3LameQuality''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to MP3 format using libmp3lame, this value selects the internal algorithm quality used by LAME. Lower values mean better quality and require more CPU time. This is the same as the -q command line parameter for LAME. More details can be found e.g. on [http://wiki.hydrogenaud.io/index.php?title=LAME_-q_switch Hydrogenaudio].
* '''OpusComplexity''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to Opus format, this value selects the internal complexity used by libopus. Higher values mean better encoding efficiency and require more CPU time. Value -1 uses the libopus default value. For details, please refer to the [https://opus-codec.org/docs/ libopus documentation].

== [MIDI Input Ports] ==
In this section, you can set “friendly names” for all MIDI input ports. If you have lots of MIDI ports with undescriptive names (such as “MIDI Device Port 1”, “MIDI Device Port 2”, …), it can be useful to replace those names with more suitable names, e.g. to describe which device is connected to a specific port. To replace a name, add a pair like <code>MIDI Device Port 1=Synthesizer 1</code> to this section.

Friendly names are also recognized by the MIDI Input / Output plugin: If the selected ports have friendly names assigned when the module is saved, the next time is opened it will try to find the correct device by its friendly name. So if a MIDI device is connected to a different MIDI port, you can rename the ports and OpenMPT will automatically choose the correct port.

== [MIDI Output Ports] ==
Same as [[#.5BMIDI Input Ports.5D|[MIDI Input Ports]]], but for MIDI output ports.

== [Misc] ==
* '''AllowMultipleCommandsPerKey''': By default, a key combination can be used by only one command. Setting this to 1 allows you to bind more than one command to a key combination. Beware that this might lead to problems with existing keyboard mappings with overlapping commands!
* '''CacheCompleteFileBeforeLoading''': If set to 1, OpenMPT caches entire (module, instrument, etc.) files in memory, which may improve file reading performance at the expense of more memory being used.
* '''DistinguishModifiers''': Enable this option to distinguish between left and right <kbd>Ctrl</kbd> / <kbd>Alt</kbd> / <kbd>Shift</kbd> modifiers, e.g. to create FastTracker 2-like pattern play shortcuts.
* '''FlushFileBuffersOnSave''': Disabling this option avoids flushing of file buffers after saving modules, samples and other files on disk. This can speed up the write operation but increases the risk of data loss e.g. in case of a power failure.
* '''ITCompressionMono''': Enables IT-compressed mono samples when saving IT/MPTM files, depending on the value. To enable saving for normal IT files, add 1 to the value, for IT files saved through Compatibility Export, add 2, and for MPTM files add 4. So to enable saving of compressed samples in compatible ITs and MPTMs only, you would use the value 6. Some caveats regarding the usage of compressed samples have been written down on the [https://forum.openmpt.org/index.php?topic=4961.0 forum].
* '''ITCompressionStereo''': Enables IT-compressed stereo samples when saving IT/MPTM files, depending on the value (see above).
* '''MRUListLength''': Sets the maximum length of the most recently used file list in the file menu. Allowed values are between 0 (no list) and 15 entries.
* '''ProcessPriorityClass''': Set the Windows process priority class for OpenMPT. Possible values are: "idle", "below", "normal", "above", "high", "realtime". The default is "normal". See further discussion on the [https://forum.openmpt.org/index.php?topic=5655.0 forum]. '''Warning''': Changing this setting can cause system lockups requiring hard system reset.
* '''SaveChannelMuteStatus''': If set to 1, OpenMPT will save the channel mute status in IT, MPTM and S3M files.
* '''SmoothFT2Ramping''': If set to 1, XM files made with Fasttracker 2 will automatically use [[Manual:_Compatible_Playback#XM_compatibility_settings|very smooth sample ramping]] settings (like Fasttracker 2 did).
* '''UseSingleInstance''': Always forces OpenMPT to only use a single program instance, even when the '''/shared''' command line switch is not specified.

== [Paths] ==
* '''Export_Directory''': The default export directory for lossless and lossy audio export. OpenMPT always uses the last used directory for exporting, so changing this setting does not make a lot of sense.
* '''UseAppDataDirectory''': This is a legacy setting imported from portable OpenMPT installations prior to version 1.29. If <code>mptrack.ini</code> is found next to <code>OpenMPT.exe</code> and this value is to 0, portable mode is assumed and all other configuration files are searched directly in the same directory as OpenMPT’s executable (by default they are placed in %APPDATA%\OpenMPT). When upgrading to a newer OpenMPT version, this setting is automatically converted to the new way of enabling portability. See also: [[Manual: System Setup#Portability|System Setup]].

== [Pattern Editor] ==
* '''AccessibilityFormat''': Defines the description of the pattern editor that can be obtained by screen readers. The string may contain the following variables: <code>%sequence%</code>, <code>%order%</code>, <code>%pattern%</code>, <code>%row%</code>, <code>%channel%</code>, <code>%channel_name%</code>, <code>%column_type%</code>, <code>%column_description%</code>.
* '''AlwaysDrawWholePatternOnScrollSlow''': If set to 1, OpenMPT will always repaint the whole pattern display instead of re-using parts of the window that have only moved and not changed. This will be measurably slower, however in some situation the display will look broken otherwise (like jittering play cursor, not updating regions of the pattern display properly when switching to and from the window, or generally sluggish/jerky display). The problem is related to certain graphics drivers (known examples are systems with multiple AMD GPUs in Windows 7, Windows XP in VirtualBox, and all Wine systems). By default, this setting is 0. On Wine, this setting has no effect and is treated as always 1, regardless of its actual value.
* '''AutoHideVolumeColumnForMOD''': When set to 1, the volume column is hidden by default for MOD and other formats that do not have a volume column.
* '''DefaultSequenceMargins''': Defines how many order items are shown at least before and after the currently selected order item (0 by default).
* '''EditStepAppliesToCommands''': When set to 1, the edit step setting is also applied when entering a command into the volume or effect column.
* '''FontDot''': Overriding this setting allows to specify a custom character to be used for empty cells with user-configured pattern fonts.
* '''NoEditPopup''': Disables the reminder popup when trying to edit patterns while editing is disabled and treats all channel columns like the note column to simplify jamming (keyjazz).
* '''OrderListOldDropBehaviour''': Restores pre-OpenMPT 1.29 drag & drop behaviour in the order list editor. That is, patterns are always dropped left of the drop position, even if the drop position is right of the source.
* '''RowDisplayOffset''': Defines the displayed number of the first pattern row; by default, it is 0. This does not affect the Goto dialog or break commands in patterns.
* '''VolumeColumnInHex''': If set to 1, parameters in the volume column are shown in hexadecimal rather than decimal. In order to be able to enter hex digits A-F, the corresponding [[Manual: Keyboard Actions#Volume Column|keyboard shortcuts]] need to be assigned (note that you may have to re-assign effect letters a-f to avoid conflicts).

== [Sample Editor] ==
* '''FLACMultithreading''': By default, the FLAC encoder uses one thread for FLAC sample saving. Setting this to 1 enables multithreaded FLAC encoding for samples.

== [Sound Settings] ==
* '''AllowDeferredProcessing''': If set to 0, deferred processing is never used for ASIO drivers.
* '''BoostedThreadPriority''': Set the priority (for Windows XP) used for sound devices which have "Boost thread priority" set. Possible values are -15,-2,-1,0,1,2,15 (or the full range -15..15 if [Misc]ProcessPriorityClass is set to "realtime"). Default value is 2. See further discussion on the [https://forum.openmpt.org/index.php?topic=5655.0 forum]. '''Warning''': Changing this setting can cause system lockups requiring hard system reset.
* '''BoostedThreadMMCSSClass''': Set the Multimedia Class Scheduler Service (MMCSS) class used for sound devices which have "Boost thread priority" set. Possible values are "Pro Audio", "Games", "Audio" or anything else that may be configured on your systems MMCSS. Default value is "Pro Audio". See further discussion on the [https://forum.openmpt.org/index.php?topic=5655.0 forum]. '''Warning''': Changing this setting can cause system lockups requiring hard system reset.
* '''MaskDriverCrashes''': If set to 1, OpenMPT will try ignore crashes in ASIO drivers.
* '''MixChannels''': Default is 256. The maximum number of sound channels that OpenMPT will use to render. In other words, Polyphony is the allowable number of notes that OpenMPT will process at once. Any computer that has been built in the last ten years should be able to handle the maximum amount of channels for most modules, but while older, low-end computers you will want to decrease the number of channels. Note that reducing the maximum polyphony only reduces the CPU load if those extra channels were actually used — if you play a 10-channel MOD file, it does matter little, if at all, whether the maximum polyphony is set to 16 or 256.
* '''ResamplerWFIRCutoff''': Configures the bandwidth of the audio signal that is retained by the 8-tap Sinc filter (without low-pass) in percent. The default of 97% offers a good compromise between “freshness” and quality of the resampled sound.
* '''SampleRates''': A comma-separated list of sample rates that OpenMPT will show in the sound device settings (if supported by the device) and when exporting a WAVE or FLAC file.
* '''XMMSModplugResamplerWFIRType''': Configures the windowing function of the 8-tap Sinc filter (without low-pass). The windowing functions, from 0 to 7, are: Hann, Hamming, Blackman Exact, Blackman 3-Tap 61, Blackman 3-Tap 67, Blackman-Harris, Blackman 4-Tap 74, Kaiser α=7.5

== [Update] ==

== [VST Plugins] ==
* '''BridgeAllPlugins''': All plugins are forced to be used through the integrated plugin bridge.
* '''EnableAutoSuspend''': Enables auto-suspend for all plugins newly added to modules after this setting is turned on. If a plugin did not emit any sound during the last four seconds, it is suspended until new notes or sound data are fed into the plugin.
* '''EnableMidiMappingInEditor''': If set to 0, holding <kbd>Shift</kbd> while modifying a plugin parameter does not open the [[Manual: MIDI Mapping|MIDI Mapping dialog]].
* '''HostProductString''': Here you can enter a custom host name that is sent to VST plugins. This can be useful if a plugin claims to only run in certain hosts and refuses to run in others.
* '''HostVendorString''': Here you can enter the host vendor name for the same reasons as above.
* '''HostVendorVersion''': Here you can enter the host version as a 32-Bit integer for the same reasons as above.
* '''ProjectPath''': Some plugins can store extra data alongside the module file. This behaviour can be overridden so that plugins use a different path. This setting can be either a normal absolute path or use the variables <code>%1</code> (module path) and <code>%2</code> (module filename) to build a path relative to the module location. So if all external plugin data should be stored in the folder <code>module.mptm-data</code> (assuming module.mptm is the module filename) next to the module, this value should be set to <code>%1%2-data</code>. Due to restrictions posed by the VST architecture, this path must not contain characters outside the current [https://en.wikipedia.org/wiki/Windows_code_page#ANSI Windows ANSI code page].

[[Category:Manual|Hidden Settings]]
[[de:Handbuch: Versteckte Optionen]]

Manual: Hidden Settings

2025-06-29T11:08:49Z

Saga Musix: /* [Export] */

[[Image:Settings Advanced.png|thumb|300px|Advanced tab of the settings dialog]]

Some settings for advanced users cannot be changed directly in OpenMPT, however they can be changed by modifying OpenMPT’s configuration file, mptrack.ini, or from the [[Manual:_Setup/Advanced|Advanced Settings]]. When using the latter method, it might be necessary to restart OpenMPT for some options to take effect.

== [Broken Plugin Workarounds] ==
* '''VSTMaskAllCrashes''': Determines whether crashes in VST plugins should be reported to the user (1) or passed on to the system, i.e. OpenMPT crashes (0). Note that if a plugin crashed, its internal state or even OpenMPT’s state may be inconsistent, so in this situation it is best to close and reopen the tracker anyway.
* '''VSTNeverUnloadAnyPlugin''': If set to 1, VST plugins are not fully unloaded when closing them. This may help with some buggy plugins (e.g. made with older versions of SynthEdit 1.4). Do not enable this setting unless you have issues when unloading plugins that cannot be solved by using the plugin bridge.

== [Components] ==
* '''BlockASIO''', '''BlockPortAudio''', '''BlockRtAudio''', '''BlockWaveOut''': If set to 1, the respective sound device types do not get initialized or queried by OpenMPT. You should not need to disable any of these unless told to do so by the OpenMPT developers in order to diagnose problems.
* '''BlockMediaFoundation''': If set to 1, OpenMPT will not load any samples using MediaFoundation codecs.
* '''BlockWineWrapper''': If set to 1, OpenMPT will not load the Wine native audio wrapper.
* '''KeepLoaded''': If set to 0, optional OpenMPT components (e.g. MP3 codecs) are unloaded after usage. This frees up memory used by these components but slows down subsequent uses.
* '''LoadOnStartUp''': If set to 1, some optional components are loaded right on statup instead of when they are first used.

== [Debug] ==
Options in this section should generally only be changed if you are advised by an OpenMPT developer to do so.
* '''DelegateToWindowsHandler''': If set to 1, OpenMPT will invoke the Windows default crash handler after its own crash handler has finished generating the crash report which had been the behaviour in OpenMPT before 1.27.
* '''StopSoundDeviceBeforeDump''': By default, the sound device is closed after writing out a crash dump. Setting this option to 1 inverts the behaviour.
* '''StopSoundDeviceOnCrash''': If set to 0, OpenMPT will not close or otherwise touch the state of the sound device when writing out a crash dump. Only change this setting when asked by the OpenMPT developers to do so in order to diagnose sound device related crashes.
* '''TraceAlwaysDump''': If set to 1 and '''TraceEnable''' is also set to 1, OpenMPT will always write out the trace log on program exit even if no crash happened. Do not enable this setting unless you are advised by the developers to do so.
* '''TraceEnable''': If set to 1, a trace logging system is enabled which can be used by the OpenMPT developers to debug certain problems. Do not enable this setting unless you are advised by the developers to do so.
* '''TraceSize''': Configures the tracer buffer size. By default, it contains 1,000,000 entries.

== [Display] ==
* '''FSUpdateInterval''': OpenMPT watches the '''f'''ile '''s'''ystem in order to update the [[Manual:_Tree_View#Instrument_Library|instrument library]] tree view when files get added or removed to the directory while OpenMPT is running. This setting limits the rate of the GUI updates in these cases to the given value in milliseconds. The default is 500ms.
* '''GUIUpdateInterval''': Defines the update interval of the GUI in milliseconds (default: depends on the period value found in the sound card settings).
* '''ShowSplashScreen''': If set to 0, no splash screen is shown when starting the program (same effect as [[Manual: Command-line Parameters|command line option]] /NoLogo).
* '''UseOldStyleFolderBrowser''': When set to 1, the classic tree-style folder picker is used on Windows Vista and newer. On older systems and Wine, it is always used.
* '''VuMeterUpdateInterval''': Defines the update interval of the VU meters in milliseconds (default: 15ms).
* '''VuMeterDecaySpeedDecibelPerSecond ''': Sets the VU meter's decay speed The default value is 88 dB/s.

== [Export] ==
* '''DefaultToSoundcardSamplerate''': By default, the [[Manual: Saving and exporting#Exporting tracks|export dialog]] presets the export frequency to the tracker’s currently selected sample rate. One reason for this behaviour is that some plugins do not like it when the sample rate is changed between normal playback and export. If you do not like this behaviour, you can set this value to 0. In this case, OpenMPT remembers the previously selected sample rate instead.
* '''FLACCompressionLevel''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to FLAC format, this value sets the FLAC compression level. Higher values mean better compression ratio and require more CPU time. For details, please refer to the FLAC documentation.
* '''FLACMultithreading''': By default, the FLAC encoder uses all available CPU cores for FLAC encoding. Setting this to 0 disables the multithreaded encoding.
* '''MP3ID3v2MinPadding''': This value is the minimum amount of padding bytes to add to ID3v2 tags.
* '''MP3ID3v2PaddingAlignHint''': This aligns the MP3 data after the ID3v2 tag in addition to the minimum padding to a multiple of the configured value. Set to 0 to disable additional aligning.
* '''MP3ID3v2WriteReplayGainTXXX''': Write ReplayGain information (if calculated, see '''MP3LameCalculateReplayGain''' and '''MP3LameCalculatePeakSample''') to the ID3v2 tag. This setting defaults to 1.
* '''MP3LameCalculateReplayGain''' and '''MP3LameCalculatePeakSample''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to MP3 format, calculate the ReplayGain track gain adjustment and the peak sample value (as require by ReplaGain) respectively. The calculated values get written to the VBR/Lame info header automatically in VBR mode. Additionally, the values can be written to the ID3v2 tags when enabled (see '''MP3ID3v2WriteReplayGainTXXX'''). Both settings default to 1.
* '''MP3LameID3v2UseLame''': If set to 1, when [[Manual: Saving and exporting#Exporting tracks|exporting]] to MP3 format, uses the libmp3lame ID3v2.3 implementation instead of the OpenMPT ID3v2.4 implementation. ID3v2.3 is more widely supported by older player software.
* '''MP3LameQuality''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to MP3 format using libmp3lame, this value selects the internal algorithm quality used by LAME. Lower values mean better quality and require more CPU time. This is the same as the -q command line parameter for LAME. More details can be found e.g. on [http://wiki.hydrogenaud.io/index.php?title=LAME_-q_switch Hydrogenaudio].
* '''OpusComplexity''': When [[Manual: Saving and exporting#Exporting tracks|exporting]] to Opus format, this value selects the internal complexity used by libopus. Higher values mean better encoding efficiency and require more CPU time. Value -1 uses the libopus default value. For details, please refer to the [https://opus-codec.org/docs/ libopus documentation].

== [MIDI Input Ports] ==
In this section, you can set “friendly names” for all MIDI input ports. If you have lots of MIDI ports with undescriptive names (such as “MIDI Device Port 1”, “MIDI Device Port 2”, …), it can be useful to replace those names with more suitable names, e.g. to describe which device is connected to a specific port. To replace a name, add a pair like <code>MIDI Device Port 1=Synthesizer 1</code> to this section.

Friendly names are also recognized by the MIDI Input / Output plugin: If the selected ports have friendly names assigned when the module is saved, the next time is opened it will try to find the correct device by its friendly name. So if a MIDI device is connected to a different MIDI port, you can rename the ports and OpenMPT will automatically choose the correct port.

== [MIDI Output Ports] ==
Same as [[#.5BMIDI Input Ports.5D|[MIDI Input Ports]]], but for MIDI output ports.

== [Misc] ==
* '''AllowMultipleCommandsPerKey''': By default, a key combination can be used by only one command. Setting this to 1 allows you to bind more than one command to a key combination. Beware that this might lead to problems with existing keyboard mappings with overlapping commands!
* '''CacheCompleteFileBeforeLoading''': If set to 1, OpenMPT caches entire (module, instrument, etc.) files in memory, which may improve file reading performance at the expense of more memory being used.
* '''DistinguishModifiers''': Enable this option to distinguish between left and right <kbd>Ctrl</kbd> / <kbd>Alt</kbd> / <kbd>Shift</kbd> modifiers, e.g. to create FastTracker 2-like pattern play shortcuts.
* '''FlushFileBuffersOnSave''': Disabling this option avoids flushing of file buffers after saving modules, samples and other files on disk. This can speed up the write operation but increases the risk of data loss e.g. in case of a power failure.
* '''ITCompressionMono''': Enables IT-compressed mono samples when saving IT/MPTM files, depending on the value. To enable saving for normal IT files, add 1 to the value, for IT files saved through Compatibility Export, add 2, and for MPTM files add 4. So to enable saving of compressed samples in compatible ITs and MPTMs only, you would use the value 6. Some caveats regarding the usage of compressed samples have been written down on the [https://forum.openmpt.org/index.php?topic=4961.0 forum].
* '''ITCompressionStereo''': Enables IT-compressed stereo samples when saving IT/MPTM files, depending on the value (see above).
* '''MRUListLength''': Sets the maximum length of the most recently used file list in the file menu. Allowed values are between 0 (no list) and 15 entries.
* '''ProcessPriorityClass''': Set the Windows process priority class for OpenMPT. Possible values are: "idle", "below", "normal", "above", "high", "realtime". The default is "normal". See further discussion on the [https://forum.openmpt.org/index.php?topic=5655.0 forum]. '''Warning''': Changing this setting can cause system lockups requiring hard system reset.
* '''SaveChannelMuteStatus''': If set to 1, OpenMPT will save the channel mute status in IT, MPTM and S3M files.
* '''SmoothFT2Ramping''': If set to 1, XM files made with Fasttracker 2 will automatically use [[Manual:_Compatible_Playback#XM_compatibility_settings|very smooth sample ramping]] settings (like Fasttracker 2 did).
* '''UseSingleInstance''': Always forces OpenMPT to only use a single program instance, even when the '''/shared''' command line switch is not specified.

== [Paths] ==
* '''Export_Directory''': The default export directory for lossless and lossy audio export. OpenMPT always uses the last used directory for exporting, so changing this setting does not make a lot of sense.
* '''UseAppDataDirectory''': This is a legacy setting imported from portable OpenMPT installations prior to version 1.29. If <code>mptrack.ini</code> is found next to <code>OpenMPT.exe</code> and this value is to 0, portable mode is assumed and all other configuration files are searched directly in the same directory as OpenMPT’s executable (by default they are placed in %APPDATA%\OpenMPT). When upgrading to a newer OpenMPT version, this setting is automatically converted to the new way of enabling portability. See also: [[Manual: System Setup#Portability|System Setup]].

== [Pattern Editor] ==
* '''AccessibilityFormat''': Defines the description of the pattern editor that can be obtained by screen readers. The string may contain the following variables: <code>%sequence%</code>, <code>%order%</code>, <code>%pattern%</code>, <code>%row%</code>, <code>%channel%</code>, <code>%channel_name%</code>, <code>%column_type%</code>, <code>%column_description%</code>.
* '''AlwaysDrawWholePatternOnScrollSlow''': If set to 1, OpenMPT will always repaint the whole pattern display instead of re-using parts of the window that have only moved and not changed. This will be measurably slower, however in some situation the display will look broken otherwise (like jittering play cursor, not updating regions of the pattern display properly when switching to and from the window, or generally sluggish/jerky display). The problem is related to certain graphics drivers (known examples are systems with multiple AMD GPUs in Windows 7, Windows XP in VirtualBox, and all Wine systems). By default, this setting is 0. On Wine, this setting has no effect and is treated as always 1, regardless of its actual value.
* '''AutoHideVolumeColumnForMOD''': When set to 1, the volume column is hidden by default for MOD and other formats that do not have a volume column.
* '''DefaultSequenceMargins''': Defines how many order items are shown at least before and after the currently selected order item (0 by default).
* '''EditStepAppliesToCommands''': When set to 1, the edit step setting is also applied when entering a command into the volume or effect column.
* '''FontDot''': Overriding this setting allows to specify a custom character to be used for empty cells with user-configured pattern fonts.
* '''NoEditPopup''': Disables the reminder popup when trying to edit patterns while editing is disabled and treats all channel columns like the note column to simplify jamming (keyjazz).
* '''OrderListOldDropBehaviour''': Restores pre-OpenMPT 1.29 drag & drop behaviour in the order list editor. That is, patterns are always dropped left of the drop position, even if the drop position is right of the source.
* '''RowDisplayOffset''': Defines the displayed number of the first pattern row; by default, it is 0. This does not affect the Goto dialog or break commands in patterns.
* '''VolumeColumnInHex''': If set to 1, parameters in the volume column are shown in hexadecimal rather than decimal. In order to be able to enter hex digits A-F, the corresponding [[Manual: Keyboard Actions#Volume Column|keyboard shortcuts]] need to be assigned (note that you may have to re-assign effect letters a-f to avoid conflicts).

== [Sound Settings] ==
* '''AllowDeferredProcessing''': If set to 0, deferred processing is never used for ASIO drivers.
* '''BoostedThreadPriority''': Set the priority (for Windows XP) used for sound devices which have "Boost thread priority" set. Possible values are -15,-2,-1,0,1,2,15 (or the full range -15..15 if [Misc]ProcessPriorityClass is set to "realtime"). Default value is 2. See further discussion on the [https://forum.openmpt.org/index.php?topic=5655.0 forum]. '''Warning''': Changing this setting can cause system lockups requiring hard system reset.
* '''BoostedThreadMMCSSClass''': Set the Multimedia Class Scheduler Service (MMCSS) class used for sound devices which have "Boost thread priority" set. Possible values are "Pro Audio", "Games", "Audio" or anything else that may be configured on your systems MMCSS. Default value is "Pro Audio". See further discussion on the [https://forum.openmpt.org/index.php?topic=5655.0 forum]. '''Warning''': Changing this setting can cause system lockups requiring hard system reset.
* '''MaskDriverCrashes''': If set to 1, OpenMPT will try ignore crashes in ASIO drivers.
* '''MixChannels''': Default is 256. The maximum number of sound channels that OpenMPT will use to render. In other words, Polyphony is the allowable number of notes that OpenMPT will process at once. Any computer that has been built in the last ten years should be able to handle the maximum amount of channels for most modules, but while older, low-end computers you will want to decrease the number of channels. Note that reducing the maximum polyphony only reduces the CPU load if those extra channels were actually used — if you play a 10-channel MOD file, it does matter little, if at all, whether the maximum polyphony is set to 16 or 256.
* '''ResamplerWFIRCutoff''': Configures the bandwidth of the audio signal that is retained by the 8-tap Sinc filter (without low-pass) in percent. The default of 97% offers a good compromise between “freshness” and quality of the resampled sound.
* '''SampleRates''': A comma-separated list of sample rates that OpenMPT will show in the sound device settings (if supported by the device) and when exporting a WAVE or FLAC file.
* '''XMMSModplugResamplerWFIRType''': Configures the windowing function of the 8-tap Sinc filter (without low-pass). The windowing functions, from 0 to 7, are: Hann, Hamming, Blackman Exact, Blackman 3-Tap 61, Blackman 3-Tap 67, Blackman-Harris, Blackman 4-Tap 74, Kaiser α=7.5

== [Update] ==

== [VST Plugins] ==
* '''BridgeAllPlugins''': All plugins are forced to be used through the integrated plugin bridge.
* '''EnableAutoSuspend''': Enables auto-suspend for all plugins newly added to modules after this setting is turned on. If a plugin did not emit any sound during the last four seconds, it is suspended until new notes or sound data are fed into the plugin.
* '''EnableMidiMappingInEditor''': If set to 0, holding <kbd>Shift</kbd> while modifying a plugin parameter does not open the [[Manual: MIDI Mapping|MIDI Mapping dialog]].
* '''HostProductString''': Here you can enter a custom host name that is sent to VST plugins. This can be useful if a plugin claims to only run in certain hosts and refuses to run in others.
* '''HostVendorString''': Here you can enter the host vendor name for the same reasons as above.
* '''HostVendorVersion''': Here you can enter the host version as a 32-Bit integer for the same reasons as above.
* '''ProjectPath''': Some plugins can store extra data alongside the module file. This behaviour can be overridden so that plugins use a different path. This setting can be either a normal absolute path or use the variables <code>%1</code> (module path) and <code>%2</code> (module filename) to build a path relative to the module location. So if all external plugin data should be stored in the folder <code>module.mptm-data</code> (assuming module.mptm is the module filename) next to the module, this value should be set to <code>%1%2-data</code>. Due to restrictions posed by the VST architecture, this path must not contain characters outside the current [https://en.wikipedia.org/wiki/Windows_code_page#ANSI Windows ANSI code page].

[[Category:Manual|Hidden Settings]]
[[de:Handbuch: Versteckte Optionen]]

Manual: Keyboard Actions

2025-06-28T10:31:11Z

Saga Musix:

This is a list of all customisable keyboard actions in OpenMPT. They can be configured in the [[Manual: Setup/Keyboard|Keyboard Setup dialog]].

Default key combinations listed in the tables below assume a US keyboard layout. Generally, alphanumeric keys in shortcuts will stay the same in other keyboard layouts (so <kbd>Ctrl</kbd>+<kbd>Z</kbd> does not turn into <kbd>Ctrl</kbd>+<kbd>Y</kbd> on a German layout), with the exception of note entry keys, which are set up based on their position on the keyboard instead (so on a French keyboard, <kbd>A</kbd>, <kbd>Q</kbd> and <kbd>W</kbd> are used for playing a C across three octaves even though the table below says <kbd>Q</kbd>, <kbd>A</kbd> and <kbd>Z</kbd>). Non-alphanumeric keys generally vary a lot between keyboard layouts, so there might not be a direct mapping to your keyboard layout — the key might have a completely different label or not exist at all. You can always review the ''actual'' key combinations used by OpenMPT on your setup by reviewing them in the Keyboard setup dialog.

'''Note''': Keyboard shortcuts that clash with the default text editing shortcuts of the operating system (e.g. <kbd>Ctrl</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>+<kbd>Z</kbd>, etc.) are ignored when the input focus is within a text field.

== Global Keys ==

Global keyboard shortcuts work on most parts of OpenMPT as long as one of the program’s windows is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| File/New || <kbd>Ctrl</kbd>+<kbd>N</kbd> || Creates a new song. The currently edited song is not closed, as OpenMPT can have multiple documents open at the same time.
|-
| File/Open || <kbd>Ctrl</kbd>+<kbd>O</kbd> || Opens one or more existing songs.
|-
| File/Append Module || || [[Manual: Module Merging|Appends]] (merges) the song data (samples, instruments, plugins, patterns and sequences) of one or more existing songs to the currently active song.
|-
| File/Close || <kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes the current song. You are prompted to save the song if it has been modified.
|-
| File/Close All || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes all open songs. You are prompted to save modified songs.
|-
| File/Save || <kbd>Ctrl</kbd>+<kbd>S</kbd> || Saves the song to disk.
|-
| File/Save As || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>S</kbd> || Allows you to save the file with a new name or in another folder.
|-
| File/Save Copy || || Allows you to save a copy of the file. The next Save action will update the file at its original location again.
|-
| File/Save As Template || || Creates a template from the current song.
|-
| File/Open Template || || Opens a file picker in the template module folder.
|-
| File/Stream Export || || Exports the current track into a lossless or lossy [[Manual: Saving and exporting#Stream Export|streaming file]].
|-
| File/Export as MIDI || || Exports the current track into the .mid format. See the section on [[Manual: Saving and exporting#MIDI Export|MIDI export]] for a detailed explanation of how this file is exported.
|-
| File/Export OPL Register Dump || || Exports the current track into one of several OPL register dump formats. See the section on [[Manual: Saving and exporting#OPL Export|OPL export]] for a detailed explanation of how this file is exported.
|-
| File/Compatibility Export || || Exports the current track without any [[Manual: Saving and exporting#Compatibility Export|file format hacks]] to its original format.
|-
| File/Import MIDI Library || || Imports the MIDI Instrument Library of your choosing. The MIDI Library can be accessed from the [[Manual: Tree View#MIDI Library|Tree View]].
|-
| File/Add Sound Bank || || Imports a sound bank of your choosing. Sound banks can be accessed from the [[Manual: Tree View#Sound Banks|Tree View]].
|-
| Previous Document || || Goes to the previous module file that is open (these are visible in the Windows Menu).
|-
| Next Document || || Goes to the next module file that is open (these are visible in the Windows Menu).
|-
| Play Song / Pause Song || <kbd>F5</kbd> || Toggles the playback of the current track. The playback cursor is not reset when using this toggle; that is, it plays from where the cursor left off when it was last pressed.
|-
| Play Song / Stop Song || || Toggles the playback of the current track. The playback cursor is reset to the start of the song.
|-
| Pause Song || <kbd>F8</kbd> || Only stops the playback of the current track but does not reset the playback pointer.
|-
| Stop Song || <kbd>Escape</kbd> || Stops the playback of the current track and resets the playback cursor to the start of the song.
|-
| Play Song from Start || <kbd>F6</kbd> || Resets the playback cursor to the very first row and begins playback from there.
|-
| Play Song from Cursor / Pause || || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there if playback is currently stopped, otherwise it pauses playback. Playback will continue until the end of the track.
|-
| Play Song from Cursor || <kbd>Ctrl</kbd>+<kbd>F6</kbd> || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there. Playback will continue until the end of the track.
|-
| Play Song from Pattern Start / Pause || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there if playback is currently stopped, otherwise it pauses playback.
|-
| Play Song from Pattern Start || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there.
|-
| Play Pattern from Start || <kbd>F7</kbd> || Loops the current pattern, starting at the first row of the pattern.
|-
| Play Pattern from Cursor || <kbd>Ctrl</kbd>+<kbd>F7</kbd> || Loops the current pattern, starting at the row where the editing cursor is currently placed.
|-
| Toggle Loop Song || || Enables or disables the song loop status.
|-
| Panic || || Stops all sample, OPL and plugin instrument voices.
|-
| Estimate Song Length || || Estimates the playback length of the entire track.
|-
| Show Approx. Real BPM || || Estimates the beats per minute of the song, based on the current tempo and the number of ticks per row, plus the Tempo Mode in the Song Properties dialog.
|-
| Toggle MIDI Record || <kbd>F9</kbd> || Toggles the MIDI Record option.
|-
| Increase Tempo || || Increases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo || || Decreases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Tempo (Fine) || || Increases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo (Fine) || || Decreases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Ticks per Row || || Increases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Decrease Ticks per Row || || Decreases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Undo || <kbd>Ctrl</kbd>+<kbd>Z</kbd> || Rescinds the last edit in the pattern or sample editor.
|-
| Redo || <kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd> || Reapplies the last undone action.
|-
| Cut || <kbd>Ctrl</kbd>+<kbd>X</kbd> || Copies the selected pattern, sample or instrument data into the clipboard, then removes it from the selection it occupies.
|-
| Copy || <kbd>Ctrl</kbd>+<kbd>C</kbd> || Copies the selected pattern, sample or instrument data into the clipboard.
|-
| Paste || <kbd>Ctrl</kbd>+<kbd>V</kbd>, <kbd>Shift</kbd>+<kbd>Insert</kbd> || Pastes data from the clipboard. In the pattern editor, it is pasted at the location of the cursor, overwriting any pattern data that falls within the paste area. With sample data, clipboard contents replace the '''whole''' sample.
|-
| Mix Paste || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>V</kbd> || Mixes clipboard contents with existing data. In the pattern editor, clipboard contents are pasted in the same row at the same column of the current (visible) pattern where the cursor is located, except where there is already any data in any corresponding field of the paste area. In the sample editor, the source and clipboard sample waveforms are mixed together.
|-
| Mix Paste (IT Style) || || For detailed differences between Mix Paste and Mix Paste (IT Style), consult the [[Manual: Patterns#Paste Modes|Pattern Editor help]]. The two commands are identical when used in the sample editor.
|-
| Paste Flood || <kbd>Shift</kbd>+<kbd>V</kbd> || Clipboard contents are pasted from the cursor, repeating the data paste until every row in the pattern has been filled and pasting over any data in its path.
|-
| Push Forward Paste (Insert) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>V</kbd> || Patterns: Clipboard contents are inserted at the row of the cursor, and pushing all data below that row further down the pattern. Any data of the affected channels pushed beyond the pattern’s last row is deleted. Samples: The sample data from the clipboard replaces the current selection. If there is no selection, the sample is inserted at the last selected position.
|-
| Select All || <kbd>Ctrl</kbd>+<kbd>5</kbd> || Selects all pattern or sample data.
|-
| Find / Replace || <kbd>Ctrl</kbd>+<kbd>F</kbd> || Opens the Find/Replace dialog, which allows you to search for and/or replace given pattern data. Find starts from the cursor location.
|-
| Find Next || <kbd>F3</kbd> || Applies the current Find settings and searches for the next data that matches it, starting from the current cursor location.
|-
| View General || <kbd>Alt</kbd>+<kbd>G</kbd> || Opens the [[Manual: General|General Tab]] of the currently focussed module.
|-
| View Pattern || <kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Patterns|Pattern Tab]].
|-
| View Samples || <kbd>Alt</kbd>+<kbd>S</kbd> || Opens the [[Manual: Samples|Sample Tab]].
|-
| View Instruments || <kbd>Alt</kbd>+<kbd>N</kbd> || Opens the [[Manual: Instruments|Instrument Tab]].
|-
| View Comments || <kbd>Alt</kbd>+<kbd>C</kbd>, <kbd>Shift</kbd>+<kbd>F9</kbd> || Opens the [[Manual: Comments|Comments Tab]].
|-
| Toggle Main Toolbar || || Shows / hides the [[Manual: Main Toolbar|Main Toolbar]].
|-
| Toggle Tree View || <kbd>Ctrl</kbd>+<kbd>F2</kbd> || Shows / hides the [[Manual: Tree View|Tree View]].
|-
| View Options || <kbd>Ctrl</kbd>+<kbd>F1</kbd> || Opens the [[Manual: Setup|Setup dialog]].
|-
| View Channel Manager || || Opens the [[Manual: Channel Manager|Channel Manager]].
|-
| View Plugin Manager || || Opens the [[Manual: Plugin Manager|Plugin Manager dialog]].
|-
| View Song Properties || || Opens the [[Manual: Song Properties|Song Properties dialog]].
|-
| View Global Tempo Swing Settings || || Opens the [[Manual: Tempo Swing Settings|Tempo Swing Settings dialog]] for the song’s global time signature. If modern tempo mode is not enabled yet, the [[Manual: Song Properties|Song Properties dialog]] is opened instead so that it can be enabled.
|-
| View Zxx Macro Configuration || || Opens the [[Manual: Macro Configuration|MIDI Macro Configuration]] dialog.
|-
| View MIDI Mapping || <kbd>Ctrl</kbd>+<kbd>F3</kbd> || Opens the [[Manual: MIDI Mapping|MIDI Mapping dialog]].
|-
| View Edit History || || Opens the [[Manual: Edit History|Edit History]].
|-
| Toggle Between Upper / Lower View || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Tab</kbd> || Switches keyboard focus between the upper and lower half of the currently focussed song view.
|-
| Switch to Instrument Library || <kbd>Alt</kbd>+<kbd>I</kbd> || Sets keyboard focus to the [[Manual: Tree View|Instrument Library]], or switches back to the last used editor window if the tree view already has focus.
|-
| Help || <kbd>F1</kbd> || Opens the manual.
|-
| Open Context Menu || <kbd>▤ Application</kbd>, <kbd>Shift</kbd>+<kbd>F10</kbd> || Opens the context menu for the currently selected item.
|-
| Previous Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad/</kbd>, <kbd>Ctrl</kbd>+<kbd>Up</kbd> || Changes the current instrument to the previous one. In the sample editor, the previous sample is chosen.
|-
| Next Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad*</kbd>, <kbd>Ctrl</kbd>+<kbd>Down</kbd> || Changes the current instrument to the next one. In the sample editor, the next sample is chosen.
|-
| Previous Octave || <kbd>Numpad/</kbd> || Changes the current octave to the next lower octave.
|-
| Next Octave || <kbd>Numpad*</kbd> || Changes the current octave to the next higher octave.
|-
| Previous Order || <kbd>Ctrl</kbd>+<kbd>Left</kbd> || Changes the current pattern to the previous one in the pattern order.
|-
| Next Order || <kbd>Ctrl</kbd>+<kbd>Right</kbd> || Changes the current pattern to the next one in the pattern order.
|-
| Previous Order (Transition at end of current measure) || || Changes the current pattern to the previous one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current measure) || || Changes the current pattern to the next one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current beat) || || Changes the current pattern to the previous one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current beat) || || Changes the current pattern to the next one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current row) || || Changes the current pattern to the previous one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current row) || || Changes the current pattern to the next one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Dummy Shortcut || || Some keyboard shortcuts are created automatically by OpenMPT (e.g. the combinations of pressing the selection key together with navigation keys). If you need to prevent OpenMPT from automatically assigning a specific key combination, you can assign it to this dummy shortcut instead, so it will not be usable by automatically generated shortcuts. This will also prevent the key combination from being used by new default key combinations added by future OpenMPT updates.
|-
|}

== Pattern ==

=== Order List ===

These keyboard shortcuts operate while the cursor focus is in the Order List.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Delete Order || <kbd>Delete</kbd> || Erases the currently selected pattern(s) in the Order List (the pattern itself is not removed, only the reference).
|-
| Insert Order || <kbd>Insert</kbd> || Duplicates the currently selected pattern ''reference''(s) in the Order List.
|-
| Insert Separator || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Inserts a separator item (+++) at the next position.
|-
| Copy Orders || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Copies the currently selected pattern ''references'' in the Order List to the clipboard.
|-
| Edit Pattern || <kbd>Enter</kbd> || Resets the Pattern Editor to show the highlighted pattern.
|-
| Switch to Pattern Editor || <kbd>Tab</kbd> || Moves the cursor focus to the Pattern Editor. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Previous Order || <kbd>Left</kbd>, <kbd>Up</kbd> || Selects the previous pattern in the Order List.
|-
| Next Order || <kbd>Right</kbd>, <kbd>Down</kbd> || Selects the following pattern in the Order List.
|-
| First Order || <kbd>Home</kbd> || Selects the first pattern in the Order List.
|-
| Last Order || <kbd>End</kbd> || Selects the final pattern in the Order List.
|-
| Pattern Index Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the respective numeral into the pattern ID box.
|-
| Increase Pattern Index || <kbd>=</kbd>, <kbd>Numpad+</kbd> || Adds one to the pattern number, up to the highest indexed pattern.
|-
| Decrease Pattern Index || <kbd>-</kbd>, <kbd>Numpad-</kbd> || Subtracts one from the pattern number, to a minimum of index 0.
|-
| Separator Index || <kbd>I</kbd> || Adds a separator pattern item (+++) at the current position.
|-
| Stop Index || <kbd>Space</kbd> || Adds a stop pattern item (---) at the current position.
|-
| Lock Playback to Selection || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Song playback is locked to the patterns in the current order selection.
|-
| Unlock Playback || <kbd>Ctrl</kbd>+<kbd>U</kbd> || If playback has been limited to an order selection before, the playback lock can be removed here.
|-
| Queue Pattern (Transition at end of current pattern) || <kbd>Q</kbd> || The selected order list item is queued to be played next, after the current pattern has finished playing.
|-
| Queue Pattern (Transition at end of current measure) || <kbd>Shift</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current measure has finished playing.
|-
| Queue Pattern (Transition at end of current beat) || <kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current beat has finished playing.
|-
| Queue Pattern (Transition at end of current row) || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current row has finished playing.
|-
| Stream Export || || Opens the [[Manual: Saving and exporting#Stream Export|Wave Export dialog]] for the selected patterns.
|-
|}

=== Quick Channel Settings ===

These keyboard shortcuts operate while the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] is open.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Channel || <kbd>Alt</kbd>+<kbd>Left</kbd>, <kbd>Shift</kbd>+<kbd>Backspace</kbd> || Shows the channel settings for the previous channel.
|-
| Next Channel || <kbd>Alt</kbd>+<kbd>Right</kbd>, <kbd>Shift</kbd>+<kbd>Enter</kbd> || Shows the channel settings for the next channel.
|-
| Pick Color from Previous Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Left</kbd> || Assigns the color of the previous channel to the current channel.
|-
| Pick Color from Next Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Right</kbd> || Assigns the color of the next channel to the current channel.
|-
| Switch to Pattern Editor || <kbd>Enter</kbd> || Closes the dialog and returns to the Pattern Editor.
|-
|}

=== General Context ===

These keyboard shortcuts will work if the cursor focus is within any of the columns of the Pattern Editor, except where noted. When navigating (moving the cursor) to before the first row or after the last row in the pattern, the cursor “wraps” to the other side of the same pattern, if the “Cursor Wrap” option is enabled (in the Options section of the [[Manual: Setup/General|General tab]] of the Setup dialog). If navigating beyond the first or last row when the “Continuous Scroll” option is enabled, the cursor will instead move to the previous/next pattern in the order list.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Navigate Down by 1 Row || <kbd>Down</kbd> || Moves the cursor to the next row in the same column.
|-
| Navigate Up by 1 Row || <kbd>Up</kbd> || Moves the cursor to the previous row in the same column.
|-
| Navigate Down by Spacing || <kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor down by the value in the Row Spacing field.
|-
| Navigate Up by Spacing || <kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor up by the value in the Row Spacing field.
|-
| Navigate Left || <kbd>Left</kbd> || Moves the cursor to the previous column in the same row, going to the previous channel′s last column if moving from the first column of the current channel.
|-
| Navigate Right || <kbd>Right</kbd> || Moves the cursor to the next column in the same row, going to the next channel’s first column if moving from the last column of the current channel.
|-
| Navigate to Next Channel || <kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the next channel.
|-
| Navigate to Previous Channel || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the previous channel.
|-
| Jump Down by Measure || <kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Up by Measure || <kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Down by Beat || <kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump Up by Beat || <kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Measure || || Moves the cursor down to the first row of the next measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Up to Measure || || Moves the cursor up to the first row of the previous measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down to the first row of the next beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Snap Up to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up to the first row of the previous beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump to Previous Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column above the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the previous patterns.
|-
| Jump to Next Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column below the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the next patterns.
|-
| Go to First Channel || <kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the same row.
|-
| Go to First Row || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Moves the cursor to the first row of the same channel in the same column.
|-
| Go to First Row of First Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the first row.
|-
| Go to Last Channel || <kbd>End</kbd> || Moves the cursor to the last column of the last channel in the same row.
|-
| Go to Last Row || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Moves the cursor to the last row of the same channel in the same column.
|-
| Go to Last Row of Last Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>End</kbd> || Moves the cursor to the last column of the last channel in the last row.
|-
| Go to note column || || Moves the cursor to the note column of the current pattern cell.
|-
| Go to instrument column || || Moves the cursor to the instrument column of the current pattern cell.
|-
| Go to volume effect column || || Moves the cursor to the volume effect column of the current pattern cell.
|-
| Go to effect comamnd column || || Moves the cursor to the effect command column of the current pattern cell.
|-
| Go to effect parameter column || || Moves the cursor to the effect parameter column of the current pattern cell.
|-
| Previous Pattern || <kbd>Numpad-</kbd> || Displays the previous pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Next Pattern || <kbd>Numpad+</kbd> || Displays the next pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Previous Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>-</kbd> || Cycles to the previous sequence. If the current sequence is the first, the last sequence is selected.
|-
| Next Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>+</kbd> || Cycles to the next sequence. If the current sequence is the last, the first sequence is selected.
|-
| Scroll Left || || Scrolls the pattern editor to the left without changing the cursor position.
|-
| Scroll Right || || Scrolls the pattern editor to the right without changing the cursor position.
|-
| Scroll Up || || Scrolls the pattern editor up without changing the cursor position.
|-
| Scroll Down || || Scrolls the pattern editor down without changing the cursor position.
|-
| Selection Key || <kbd>Shift</kbd> || The modifier key to be used to extend the selection when navigating with keyboard shortcuts.
|-
| Copy Select Key || <kbd>Ctrl</kbd> || The modifier key to be used to copy the selection when dragging with the mouse.
|-
| Select Channel / Select All || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Selects all events of the channel where the cursor is located in the current pattern, or all events in the pattern if the entire channel is already selected.
|-
| Select Column || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Selects the column in which the cursor is located in all rows of the current pattern.
|-
| Select Row || || Completely selects all rows covered by the current selection.
|-
| Select Event || || Completely selects all events covered by the current selection.
|-
| Select Beat || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a beat and ends on the last row of a beat.
|-
| Select Measure || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a measure and ends on the last row of a measure.
|-
| Lose Selection || || Resets the selection rectangle to contain only the cursor position.
|-
| Copy and Lose Selection || || Copies the selected events to the clipboard and unselects them.
|-
| Quick Copy || <kbd>Enter</kbd> || Copies only one event of data (where the cursor is located) to OpenMPT′s “Quick” clipboard; the standard clipboard is not erased. Each column pair has its own Quick clipboard.
|-
| Quick Paste || <kbd>Space</kbd> || Pastes the data in OpenMPT′s “Quick” clipboard to the location of the cursor. The data last saved in that column’s clipboard will be pasted in the cursor′s corresponding column.
|-
| Cut to Pattern Channel Clipboard || || Copies and clears the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Cut to Pattern Clipboard || || Copies and clears the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Copy to Pattern Channel Clipboard || || Copies the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Copy to Pattern Clipboard || || Copies the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Paste from Pattern Channel Clipboard || || Replaces the contents of the channel the cursor is located in with the contents of the pattern channel clipboard.
|-
| Paste from Pattern Clipboard || || Replaces the contents of the current pattern with the contents of the pattern clipboard.
|-
| Toggle Clipboard Manager || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Toggles the visibility of the pattern clipboard manager.
|-
| Cycle to Previous Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Left</kbd> || Makes the previous internal clipboard the current clipboard.
|-
| Cycle to Next Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Right</kbd> || Makes the next internal clipboard the current clipboard.
|-
| Clear Row || || Deletes all event data in the same row in the current channel.
|-
| Clear Field || <kbd>Delete</kbd> || Deletes the selected pattern data, or just the data under the current cursor position if no selection has been made.
|-
| Clear Field (IT Style) || <kbd>Shift</kbd>+<kbd>.</kbd> || Same as “Clear field”, but also clears the instrument number if a note event is selected.
|-
| Clear Row and Step || <kbd>Ctrl</kbd>+<kbd>Delete</kbd> || Same as “Clear row”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step || || Same as “Clear field”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step (IT Style) || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Clear field (IT Style)”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Delete Row(s) || <kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; the data is moved up to replace the cleared data, and empty rows are added at the end of the affected channels.
|-
| Delete Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; the data is moved up to replace the cleared data, and empty rows are added at the end of the pattern.
|-
| Delete Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; this also affect all following patterns as no empty rows are inserted.
|-
| Delete Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; this also affect all following patterns as no empty rows are inserted.
|-
| Insert Row(s) || <kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last row of those channels is deleted.
|-
| Insert Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last row of all channels is deleted.
|-
| Insert Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Insert Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Mute Current Channel || <kbd>F10</kbd> || Toggles the sound output (mute) for the channel(s) covered by the current selection.
|-
| Solo Current Channel || <kbd>Ctrl</kbd>+<kbd>F10</kbd> || Toggles the sound output (mute) for all channels except the channel(s) covered by the current selection.
|-
| Unmute All Channels || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F10</kbd> || Unmutes the sound output for all channels.
|-
| (Un)mute Channel on Pattern Transition || || Toggles the sound output (mute) for the channel(s) covered by the current selection, but the change takes place when the current pattern is finished playing.
|-
| Unmute All Channels on Pattern Transition || || Unmutes the sound output for all channels when the current pattern is finished playing.
|-
| Solo Channel on Pattern Transition || || Toggles the sound output (mute) for all channels except the one where the cursor is located, but the change takes place when the current pattern is finished playing.
|-
| Channel Record Select || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Toggles the channel(s) covered by the current selection to belong to the primary record group.
|-
| Channel Split Record Select || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Toggles the channel(s) covered by the current selection to belong to the [[Manual: Keyboard Split|split record]] group.
|-
| Reset Channel || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Stops all note processing, and resets all channel variables to their defaults (volume, panning, etc.) on the selected channel(s).
|-
| Transpose Channel || || Changes the pitch of all notes on the selected channel in all patterns by a selectable amount of semitones.
|-
| Duplicate Channel || || Adds a new channel to the module and carries over all note data from the channel containing the edit cursor to this new channel.
|-
| Add Channel Before Current || || Adds a new empty channel before the channel containing the edit cursor.
|-
| Add Channel After Current || || Adds a new empty channel after the channel containing the edit cursor.
|-
| Remove Current || || Removes the channel containing the edit cursor. If the channel contains any data on any pattern, a confirmation prompt is shown.
|-
| Move Channels to Left || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the left by one channel.
|-
| Move Channels to Right || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the right by one channel.
|-
| Quick Channel Settings || || Opens the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] for the channel where the cursor is located.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the note number of the currently selected notes.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the note number of the currently selected notes.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the octave number of the currently selected notes.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the octave number of the currently selected notes.
|-
| Transpose Custom || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Lowers or raises the selected notes by an arbitrary amount of semitones.
|-
| Transpose Custom (Quick) || || Applies a previously chosen custom transpose amount. If no amount has been chosen before, the behaviour of this shortcut is identical to Transpose Custom.
|-
| Data Entry +1 || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry -1 || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry Up (Coarse) || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Data Entry Down (Coarse) || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Insert New Pattern || || Inserts a new blank pattern after the current pattern, displays it, and moves the cursor to the same position in it. Also functions when cursor focus is in the Order list.
|-
| Duplicate Pattern || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Inserts a new pattern with the current pattern′s contents.
|-
| Split Pattern || || Splits the current pattern at the cursor location.
|-
| Amplify Selection || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens a dialog to change the note volume commands of the selected volume data.
|-
| Interpolate Note || || Transitions smoothly (using all available notes) between notes in the selection, filling in (and replacing if necessary) all rows with new note data.
|-
| Interpolate Instrument || || Transitions smoothly (using all available instrument numbers) between instrument numbers in the selection, filling in all rows with new instrument data.
|-
| Interpolate Volume || <kbd>Ctrl</kbd>+<kbd>J</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new volume effects. The first and last rows of the selection must contain the same volume effect, or one of the two rows might be empty.
|-
| Interpolate Effect || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new effect data. The first and last rows of the selection must contain the same effect, or one of the two rows might be empty. Different effects within the selection are not overwritten.
|-
| Apply Current Instrument || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Applies the current instrument to all cells in the selection that contain note data.
|-
| Apply Current Instrument to Existing Only || || Applies the current instrument to all cells in the selection that contain an instrument numbers. Notes without instrument numbers are not updated.
|-
| Grow Selection || <kbd>Alt</kbd>+<kbd>E</kbd> || “Expands” the selection by doubling the number of the selected rows, and evenly spacing out the event data within it. The expansion will replace event data below it in the same channels as the selection.
|-
| Shrink Selection || <kbd>Alt</kbd>+<kbd>D</kbd> || “Shrinks” the selection by deleting every other row of the selection. However, if only part of any row is selected, the data corresponding to the deleted selected data is also deleted.
|-
| Expand Pattern || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>E</kbd> || “Expands” the entire pattern by doubling the number of the rows, and evenly spacing out the event data within it.
|-
| Shrink Pattern || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>D</kbd> || “Shrinks” the entire pattern by removing every other row.
|-
| Toggle Follow Song || <kbd>F11</kbd> || Toggles the “Follow Song” function.
|-
| Toggle Loop Pattern || <kbd>Shift</kbd>+<kbd>F11</kbd> || Toggles the Loop Pattern feature.
|-
| Play Row || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Process and play only the events in the current row where the cursor is located.
|-
| Go to Row/Channel/… || <kbd>Ctrl</kbd>+<kbd>G</kbd> || Opens the [[Manual: Go To|Go To]] dialog to allow you to jump to a different position in the module.
|-
| Pick Up Nearest Instrument Number || || Seeks for the nearest instrument number in the pattern channel the cursor currently is in. If an instrument number is found, it is set as the currently active instrument.
|-
| Enable Recording || <kbd>Ctrl</kbd>+<kbd>Space</kbd> || Toggles the Event Record feature. When enabled, patterns may be edited.
|-
| Toggle Metronome || <kbd>Alt</kbd>+<kbd>M</kbd> || Toggles the [[Manual: Metronome Settings|Metronome]].
|-
| Set Edit Step on Note Entry || <kbd>Alt</kbd> || The modifier key(s) that, when pressed with digits 0-9, allows you to change the Edit Step amount without using the mouse or moving the cursor focus out of the editor.
|-
| Increase Edit Step || || Increases the Edit Step by one row.
|-
| Decrease Edit Step || || Decreases the Edit Step by one row.
|-
| Switch to Order List || <kbd>Ctrl</kbd>+<kbd>Tab</kbd> || Toggles the cursor focus between the pattern editor and the current pattern in the Pattern Order list. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Toggle PC Event/Instrument Plugin Editor || <kbd>Ctrl</kbd>+<kbd>/</kbd> || Opens the editor for the plugin of the selected Parameter Control Event or instrument number.
|-
| Toggle Channel’s Plugin Editor || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the editor for the current channel′s assigned plugin.
|-
| Show Note Properties || <kbd>▤ Application</kbd> || Opens the [[Manual: Note Properties|Note Properties]] dialog, where you can assign any event data to the current row of the current channel.
|-
| Show Pattern Properties || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Pattern Properties|Pattern Properties]] dialog.
|-
| Split Keyboard Settings Dialog || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Keyboard Split|Keyboard Split]] dialog.
|-
| Open Effect Visualizer || <kbd>Alt</kbd>+<kbd>B</kbd> || Opens the [[Manual: Parameter Editor|Parameter Editor]] dialog.
|-
| Show Chord Editor || || opens the [[Manual: Chord Editor|Chord Editor]] dialog.
|-
| Show Context (Right-Click) Menu || || Opens the edit context menu at the cursor location without using the mouse.
|-
| Show Channel Context (Right-Click) Menu || || Opens the channel context menu at the cursor location without using the mouse.
|-
| Show Channel Plugin Context (Right-Click) Menu || || Opens the plugin context menu of the channel at the cursor location without using the mouse.
|-
| Show Playback Time at Current Row || <kbd>Ctrl</kbd>+<kbd>P</kbd> || Shows the estimated time within the track at the start of the current row.
|-
| Lock Playback to Rows || || If a selection is made, playback is locked to the selected rows. Otherwise, a previous playback lock is removed.
|-
| Quantize Settings || <kbd>Alt</kbd>+<kbd>Q</kbd> || Opens the record quantization settings.
|-
| Toggle row playback when navigating || || Toggles the state of the "play whole row when navigating" feature. The new state of the feature is announced in the status bar.
|-
| Toggle Overflow Paste || || When enabled, pasting will continue to the next pattern if the data overflows the current pattern.
|-
| Toggle Note Off Record (PC Keyboard) || || Toggles the recording of Note Off events from the PC keyboard in the pattern editor (also configurable from the [[Manual: Setup/General#Record note off|General setup]] page).
|-
| Toggle Note Off Record (MIDI) || || Toggles the recording of Note Off events from MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Apply Octave Transpose to incoming MIDI Notes || || Toggles application of the base octave transposition to notes received via MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Continue Song when MIDI Note is received || || Toggles whether pattern playback continues when a note is received via MIDI (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Respond to Play / Continue / Stop Song MIDI messages || || Toggles whether pattern playback starts / stops / continues when the corresponding MIDI commands are received (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Velocity || || Toggles whether MIDI velocity is recorded (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Pitch Bend || || Toggles whether MIDI pitch bends are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI CCs || || Toggles whether MIDI CC events are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Instrument Column Visibility || || Shows or hides the instrument column.
|-
| Toggle Volume Column Visibility || || Shows or hides the volume column.
|-
| Toggle Effect Column Visibility || || Shows or hides the effect column.
|}

=== Note Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the note column (the first column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Base Octave [note] || <kbd>Q</kbd>, <kbd>W</kbd>, ... || Enters a note in the octave indicated in the Octave field.
|-
| Base Octave +1 [note] || <kbd>A</kbd>, <kbd>S</kbd>, ... || Enters a note in the next higher octave indicated in the Octave field.
|-
| Base Octave +2 [note] || <kbd>Z</kbd>, <kbd>X</kbd>, ... || Enters a note two octaves higher than the one indicated in the Octave field.
|-
| Base Octave +3 [note] || || Enters a note three octaves higher than the one indicated in the Octave field.
|-
| Base Octave +4 [note] || || Enters a note four octaves higher than the one indicated in the Octave field.
|-
| Set Octave [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Sets the selected note’s octave.
|-
| Chord Modifier || <kbd>Shift</kbd> || The modifier key(s) that calls a chord rather than a note. The chords are set and assigned in the [[Manual: Chord Editor|Chord Editor]].
|-
| Note Cut || <kbd>`</kbd> || Enters a Note Cut command (^^). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>1</kbd>.
|-
| Note Off || <kbd>=</kbd> || Enters a Note Off command (==). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>Backspace</kbd>.
|-
| Note Fade || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a Note Fade command (~~). Note: The default shortcut is position-independent and is bound to the key that is usually lef of <kbd>Backspace</kbd>.
|-
| Parameter Control || <kbd>Shift</kbd>+<kbd>-</kbd> || Enters an absolute [[Manual:_Parameter_Control_Events|Parameter Control event]] (PC). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
| Parameter Control (Smooth) || <kbd>-</kbd> || Enters a smooth sliding Parameter Control event (PCs). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
|}

=== Instrument Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the instrument column (the second column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Instrument Digit [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the instrument field, moving the existing digits to the left.
|-
|}

=== Volume Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the volume column (the third column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Volume Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left.
|-
| Set Volume Digit [A - F] || || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left. By default, volume column parameters are shown in decimal and these shortcuts are not assigned. You can use them after enabling the [[Manual: Hidden Settings#.5BPattern Editor.5D|Pattern Editor.VolumeColumnInHex]] hidden setting.
|-
| Volume Command - Volume || <kbd>V</kbd> || Enters a note volume (vxx) command into the pattern.
|-
| Volume Command - Panning || <kbd>P</kbd> || Enters a panning command (pxx) into the pattern.
|-
| Volume Command - Volume Slide Up || <kbd>C</kbd> || Enters volume slide up (cxx) into the pattern.
|-
| Volume Command - Volume Slide Down || <kbd>D</kbd> || Enters a volume slide down (dxx) into the pattern.
|-
| Volume Command - Fine Volume Slide Up || <kbd>A</kbd> || Enters a fine volume slide up (axx) into the pattern.
|-
| Volume Command - Fine Volume Slide Down || <kbd>B</kbd> || Enters a fine volume slide down (bxx) into the pattern.
|-
| Volume Command - Vibrato Speed || <kbd>U</kbd> || Enters a vibrato speed command (uxx) into the pattern.
|-
| Volume Command - Vibrato Depth || <kbd>H</kbd> || Enters a vibrato depth command (hxx) into the pattern.
|-
| Volume Command - XM Pan Slide Left || <kbd>L</kbd> || Enters a pan slide to the left (lxx) into the pattern.
|-
| Volume Command - XM Pan Slide Right || <kbd>R</kbd> || Enters a pan slide to the right (rxx) into the pattern.
|-
| Volume Command - Tone Portamento || <kbd>G</kbd> || Enters a tone portamento command (gxx) into the pattern.
|-
| Volume Command - Portamento Up || <kbd>F</kbd> || Enters a pitch bend up command (fxx) into the pattern.
|-
| Volume Command - Portamento Down || <kbd>E</kbd> || Enters a pitch bend down command (exx) into the pattern.
|-
| Volume Command - Offset || <kbd>O</kbd> || Enters a coarse sample offset command (oxx) into the pattern.
|-
|}

=== Effect Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect column (the fourth column). Alphanumeric effect letters (0-9, A-Z) are currently not editable — they are automatically assigned to the respective keys on your keyboard.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Smooth MIDI Macro Slide || <kbd>\</kbd> || Enters a Smooth MIDI Macro Slide (\xx) into the pattern.
|-
| Combined Note Delay and Note Cut || <kbd>;</kbd>, <kbd>Shift</kbd>+<kbd>;</kbd> || Enters a Delay-Cut (:xy) command into the pattern.
|-
| Parameter Extension Command || <kbd>/</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Parameter Extension Command]] (#xx) into the pattern.
|-
| Finetune || <kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Finetune Command]] (+xx) into the pattern.
|-
| Finetune (Smooth) || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Smooth Finetune Command]] (*xx) into the pattern.
|-
|}

=== Effect Parameter Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect parameter column (the fifth column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Effect Parameter Digit [0 – F] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd>, <kbd>A</kbd>-<kbd>F</kbd> || Enters the digit into the rightmost place in the effect parameter field, moving the existing digits to the left.
|-
|}

== Sample Editor ==

These shortcuts are applied when the [[Manual: Samples|Samples Tab]] is active.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Trim Sample around Loop Points || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Trims the sample to the selection, if there is one. Otherwise, if loop points are specified, all sample data outside of these start/end times are deleted.
|-
| Trim to Loop End || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>T</kbd> || If loop points are specified, all sample data past the loop end is deleted.
|-
| Silence Sample Selection || <kbd>Backspace</kbd> || All of the sample data within the selected area is set to zero, effectively placing silence in that span.
|-
| Normalize Sample || <kbd>Shift</kbd>+<kbd>N</kbd> || Applies Normalisation to the sample.
|-
| Amplify Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens the [[Manual: Amplify|Amplify]] dialog, allowing you to alter the volume of the sample and apply Fade In or Fade Out (from / to silence).
|-
| Reverse Sample || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>R</kbd> || Puts the selected sample data in reverse order, so it is being played backwards.
|-
| Delete Sample Selection || <kbd>Delete</kbd> || Deletes the sample data within the selection, moving the remaining data together.
|-
| Toggle Sample Drawing || || Turns sample drawing mode on or off.
|-
| Add Silence / Create Sample || || Opens the dialog for adding silence, resizing samples and initializing FM instruments.
|-
| Configure Sample Grid || || Opens the dialog for setting the sample grid properties.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the data-to-display ratio, effectively zooming in to show more graphic detail of the sample data.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the data-to-display ratio, effectively zooming out to show less graphic detail of the sample data.
|-
| Zoom into Selection || <kbd>Space</kbd> || Zooms so much into the sample data that the current selection covers as much of the sample display as possible. If no selection has been made, auto-zoom is enabled.
|-
| Zoom into Sample Start || <kbd>1</kbd> || Zooms into the sample and ensures that the sample start is visible in the view.
|-
| Zoom into Sample End || <kbd>2</kbd> || Zooms into the sample and ensures that the sample end is visible in the view.
|-
| Center Loop Start in View || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Ensures that the normal sample loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Loop End in View || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Ensures that the normal sample loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop Start in View || <kbd>Ctrl</kbd>+<kbd>3</kbd> || Ensures that the sample sustain loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop End in View || <kbd>Ctrl</kbd>+<kbd>4</kbd> || Ensures that the sample sustain loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Convert Ping-Pong Loop to Unidirectional || || Turns a bidi-looped sample loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Convert Ping-Pong Sustain Loop to Unidirectional || || Turns a bidi-looped sustain loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Convert to 8-bit / 16-bit || <kbd>Ctrl</kbd>+<kbd>8</kbd> || Changes the sample’s bit depth between 8-bit and 16-bit.
|-
| Convert to Mono (Mix) || <kbd>Shift</kbd>+<kbd>M</kbd> || Mixes the left and right channels of a stereo sample equally together.
|-
| Convert to Mono (Left Channel) || <kbd>Shift</kbd>+<kbd>L</kbd> || Only keeps the left channel of a stereo sample.
|-
| Convert to Mono (Right Channel) || <kbd>Shift</kbd>+<kbd>R</kbd> || Only keeps the right channel of a stereo sample.
|-
| Convert to Mono (Split Sample) || <kbd>Shift</kbd>+<kbd>S</kbd> || Create two sample slots for this sample, one containing only the left channel and the other containing just the right channel. If the sample is referenced by an instrument, this instrument is duplicated as well for the right channel.
|-
| Change Stereo Separation || <kbd>Shift</kbd>+<kbd>P</kbd> || Adjusts the stereo separation of the sample by a given amount, either widening or narrowing the stereo width.
|-
| Upsample || <kbd>Shift</kbd>+<kbd>F</kbd>|| Doubles the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Downsample || <kbd>Shift</kbd>+<kbd>G</kbd>|| Halves the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Resample || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Changes the sample’s middle-C frequency to a new arbitrary frequency.
|-
| Invert Sample Phase || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Inverts the sample’s phase, i.e. it is mirrored along the time axis.
|-
| Signed / Unsigned Conversion || <kbd>Ctrl</kbd>+<kbd>U</kbd> || Re-interprets the sample data as a signed or unsigned sample.
|-
| Remove DC Offset || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Removes an unwanted static DC Offset from the waveform, i.e. it is centered around the time axis.
|-
| Quick Fade || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Applies a fade-in for the selected sample data if the selection includes the beginning of the sample, or applies a fade-out if the selection includes the end of the sample. If neither the beginning or end of the waveform is part of the selection, the Amplify dialog is shown.
|-
| Crossfade Sample Loop || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Opens the Crossfade Loop dialog to crossfade the sample loop’s end with the loop start, to create seamless loop transitions.
|-
| Tune Sample to Given Note || || Opens the [[Manual: Sample Tuner|Sample Tuner]] dialog, where the sample can be tuned to a given note.
|-
| Load Sample || <kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. This command also works in the Instrument Tab, importing an instrument to the current Instrument slot.
|-
| Load Raw Sample || <kbd>Shift</kbd>+<kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. The [[Manual: Raw Sample Import|Raw Sample Import]] is shown, ignoring the sample format even if it is known to OpenMPT.
|-
| Save Sample || || Opens the Save File dialog to allow you to save the sample as a Wave Audio or Raw file into a folder of your choice. This command also works in the Instrument Tab, saving the instrument and its accompanying samples as an .iti, .xi or .sfz file.
|-
| New Sample || || Creates a blank sample in the next unused slot. This command also works in the Instrument Tab.
|-
| Duplicate Sample || || Duplicates the current sample slot into the next unused slot.
|-
| Initialize OPL Instrument || || Configures the current sample slot to be a synthesized OPL instrument and recalls the default instrument parameters.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises the middle-C frequency by one semitone.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers the middle-C frequency by one semitone.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises (doubles) the middle-C frequency by one octave.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers (halves) the middle-C frequency by one octave.
|-
| Increment Finetune || <kbd>Shift</kbd>+<kbd>Up</kbd> || Raises the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Decrement Finetune || <kbd>Shift</kbd>+<kbd>Down</kbd> || Lowers the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Toggle Follow Sample Play Cursor|| <kbd>Shift</kbd>+<kbd>F</kbd> || Cycles through all three [[Manual: Setup/Samples#Automatic Scrolling when_Zoomed-In|sample playback cursor follow modes]]. The new follow mode is announced in the status bar.
|-
| Preview / Set Sample Cue [1 - 9] || <kbd>Shift</kbd>+<kbd>1</kbd>-<kbd>9</kbd> || Previews the sample at middle-C, starting from the chosen cue point. If the cue point is unset and the sample is currently being previewed, the cue point is set to the current play position.
|-
| Slice at Cue Points || || Creates new samples from the current sample by splitting the sample at its cue points.
|-
|}

== Instrument Editor ==

These shortcuts are applied when the [[Manual: Instruments#Sample Map|Sample Map]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Duplicate Instrument || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Creates a new instrument slot using ''all'' the same instrument attributes as the currently displayed instrument.
|-
| Edit Sample Map || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Sample Map|Sample Map]] dialog.
|-
| Edit Current Sample || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the Samples page of the currently selected sample slot.
|-
| Map All Notes to Selected Note || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected note to all notes.
|-
| Map All Notes to Selected Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected sample slot to all notes.
|-
| Reset Note Mapping || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Resets the note assignments, so that each note maps to itself (C-5 → C-5, D-5 → D-5, and so on).
|-
| Remove All Samples || || Removes any sample associations from the instrument.
|-
| Transpose +1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one semitone.
|-
| Transpose -1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one semitone.
|-
| Transpose +1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one octave.
|-
| Transpose -1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one octave.
|-
|}

=== Envelope Editor ===

These shortcuts are applied when the [[Manual: Instruments#Envelope Editor|envelope editor]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Load Envelope || || Replaces the currently active envelope with an envelope from disk.
|-
| Save Envelope || || Stores the currently active envelope to disk.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the detail of the Envelope Window, showing a smaller excerpt of the envelope.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the detail of the Envelope Window, showing a bigger excerpt of the envelope.
|-
| Scale Envelope Points || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Scale Envelope Points|Scale Envelope Points]] dialog.
|-
| Switch to Volume Envelope || <kbd>Shift</kbd>+<kbd>M</kbd> || Selects the Volume Envelope for editing.
|-
| Switch to Panning Envelope || <kbd>Shift</kbd>+<kbd>P</kbd> || Selects the Panning Envelope for editing.
|-
| Switch to Pitch / Filter Envelope || <kbd>Shift</kbd>+<kbd>I</kbd> || Selects the Pitch / Filter Envelope for editing.
|-
| Toggle Volume Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd> || Enables or disables the Volume Envelope.
|-
| Toggle Panning Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> || Enables or disables the Panning Envelope.
|-
| Toggle Pitch Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> || Enables or disables the Pitch Envelope.
|-
| Toggle Filter Envelope || <kbd>Shift</kbd>+<kbd>F</kbd> || Enables or disables the Filter Envelope.
|-
| Toggle Envelope Loop || <kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Loop.
|-
| Select Envelope Loop Start || <kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope loop start.
|-
| Select Envelope Loop End || <kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope loop end.
|-
| Toggle Envelope Sustain Loop || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Sustain Loop.
|-
| Select Envelope Sustain Start || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope sustain start.
|-
| Select Envelope Sustain End || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope sustain end.
|-
| Toggle Envelope Carry || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Enables or disables the Envelope Carry.
|-
| Select Previous Envelope Point || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the selection to the previous envelope point.
|-
| Select Next Envelope Point || <kbd>Tab</kbd> || Moves the selection to the following envelope point.
|-
| Move Envelope Point Left || <kbd>Left</kbd> || Moves the selected envelope point left one tick.
|-
| Move Envelope Point Left (Coarse) || <kbd>Shift</kbd>+<kbd>Left</kbd> || Moves the selected envelope point left one beat.
|-
| Move Envelope Point Right || <kbd>Right</kbd> || Moves the selected envelope point right one tick.
|-
| Move Envelope Point Right (Coarse) || <kbd>Shift</kbd>+<kbd>Right</kbd> || Moves the selected envelope point right one beat.
|-
| Move Envelope Point Up || <kbd>Up</kbd> || Moves the selected envelope point up one unit.
|-
| Move Envelope Point Up (Coarse) || <kbd>PageUp</kbd> || Moves the selected envelope point up 8 units.
|-
| Move Envelope Point Down || <kbd>Down</kbd> || Moves the selected envelope point down one unit.
|-
| Move Envelope Point Down (Coarse) || <kbd>PageDown</kbd> || Moves the selected envelope point down 8 units.
|-
| Insert Envelope Point || <kbd>Insert</kbd> || Inserts an envelope point after the selected point.
|-
| Remove Envelope Point || <kbd>Delete</kbd>, <kbd>Backspace</kbd> || Deletes the selected envelope point.
|-
| Set Loop Start || <kbd>Home</kbd> || Sets the selected envelope point as the Envelope Loop start point.
|-
| Set Loop End || <kbd>End</kbd> || Sets the selected envelope point as the Envelope Loop end point.
|-
| Set Sustain Loop Start || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Sets the selected envelope point as the Sustain Loop start point.
|-
| Set Sustain Loop End || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Sets the selected envelope point as the Sustain Loop end point.
|-
| Toggle Release Node || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the selected envelope point as the start point for the Release Envelope.
|-
|}

== Comments [Bottom] ==

These shortcuts are applied when the lower half of the [[Manual: Comments|Comments tab]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Toggle Between Lists || <kbd>Tab</kbd> || Toggles between the sample and instrument list.
|-
| Open Item in Editor || <kbd>Enter</kbd> || Switches to the sample or instrument editor to edit the currently selected item.
|-
| Rename Item || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Brings up an edit box for renaming the selected sample or instrument.
|-
|}

== Plugin Editor ==

These shortcuts are applied when a [[Manual: Plugin Window|plugin window]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Plugin Preset || <kbd>Numpad-</kbd> || Selects the previous plugin preset / patch.
|-
| Next Plugin Preset || <kbd>Numpad+</kbd> || Selects the following plugin preset / patch.
|-
| Plugin Preset Backward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad-</kbd> || Jumps back 10 entries in the preset list.
|-
| Plugin Preset Forward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad+</kbd> || Jumps forward 10 entries in the preset list.
|-
| Randomize Plugin Parameters || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>D</kbd> || Give random values to all parameters of the current plugin.
|-
| Toggle Parameter Recording || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the parameter recording function, which allows you to record parameter changes from plugin window into the pattern.
|-
| Record MIDI Out to Pattern Editor || || Toggles the MIDI Out recording function, which allows you to route the plugin’s MIDI output to the pattern, sample or instrument editor.
|-
| Pass Key Presses to Plugin || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Toggles the Pass Keys function, which sends all keyboard input to the currently open plugin window (e.g. for entering a serial number in the plugin GUI).
|-
| Bypass Plugin || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Toggles plugin’s bypass property to control whether audio is routed through the plugin or not.
|}

== Tree View ==

These shortcuts are applied when the [[Manual:_Tree_View|Tree View]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Switch between Upper / Lower Tree View || <kbd>Tab</kbd> || Switches focus between the upper and lower panel of the Tree View.
|-
| Open / View Item || <kbd>Enter</kbd> || Opens / views / previews the selected item (same action as double-click).
|-
| Play Item || <kbd>Space</kbd> || Previews the selected item if it is a sample, instrument or file.
|-
| Insert Item || <kbd>Insert</kbd> || Inserts an empty item (e.g. sample or instrument slot) after the currently selected item.
|-
| Duplicate Item || <kbd>Shift</kbd>+<kbd>Insert</kbd> || Duplicates the currently selected item (e.g. sample or instrument slot).
|-
| Delete Item || <kbd>Delete</kbd> || Deletes the currently selected item.
|-
| Delete Item Permanently || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Delete Item”, but if the selected item is a file, it will not be moved to the recycling bin.
|-
| Rename Item / Send To Editor || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items belonging to an open module (e.g. patterns, samples, instruments, ...): The selected item is renamed. For items in the instrument library: The item is sent to the last active sample or instrument editor and replaces the currently selected sample or instrument.
|-
| Send To Editor (Insert New) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items in the instrument library: The item is sent to the last active sample or instrument editor and is loaded into a new sample or instrument slot.
|-
| Go to Parent Folder || <kbd>Backspace</kbd> || Changes the instrument library folder to the current location′s parent folder.
|-
| Find in Instrument Library || <kbd>Ctrl</kbd>+<kbd>F</kbd>|| Opens the search filter to quickly locate files and folders in the instrument library.
|-
| Sort Instrument Library By Name || || Items in the instrument library are sorted by their file name.
|-
| Sort Instrument Library By Date || || Items in the instrument library are sorted by their last file modification date.
|-
| Sort Instrument Library By Size || || Items in the instrument library are sorted by their file size.
|}

[[Category:Manual|Keyboard Actions]]

Manual: Keyboard Actions

2025-06-24T20:28:47Z

Saga Musix: Expand/Shrink Pattern

This is a list of all customisable keyboard actions in OpenMPT. They can be configured in the [[Manual: Setup/Keyboard|Keyboard Setup dialog]].

Default key combinations listed in the tables below assume a US keyboard layout. Generally, alphanumeric keys in shortcuts will stay the same in other keyboard layouts (so <kbd>Ctrl</kbd>+<kbd>Z</kbd> does not turn into <kbd>Ctrl</kbd>+<kbd>Y</kbd> on a German layout), with the exception of note entry keys, which are set up based on their position on the keyboard instead (so on a French keyboard, <kbd>A</kbd>, <kbd>Q</kbd> and <kbd>W</kbd> are used for playing a C across three octaves even though the table below says <kbd>Q</kbd>, <kbd>A</kbd> and <kbd>Z</kbd>). Non-alphanumeric keys generally vary a lot between keyboard layouts, so there might not be a direct mapping to your keyboard layout — the key might have a completely different label or not exist at all. You can always review the ''actual'' key combinations used by OpenMPT on your setup by reviewing them in the Keyboard setup dialog.

'''Note''': Keyboard shortcuts that clash with the default text editing shortcuts of the operating system (e.g. <kbd>Ctrl</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>+<kbd>Z</kbd>, etc.) are ignored when the input focus is within a text field.

== Global Keys ==

Global keyboard shortcuts work on most parts of OpenMPT as long as one of the program’s windows is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| File/New || <kbd>Ctrl</kbd>+<kbd>N</kbd> || Creates a new song. The currently edited song is not closed, as OpenMPT can have multiple documents open at the same time.
|-
| File/Open || <kbd>Ctrl</kbd>+<kbd>O</kbd> || Opens one or more existing songs.
|-
| File/Append Module || || [[Manual: Module Merging|Appends]] (merges) the song data (samples, instruments, plugins, patterns and sequences) of one or more existing songs to the currently active song.
|-
| File/Close || <kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes the current song. You are prompted to save the song if it has been modified.
|-
| File/Close All || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes all open songs. You are prompted to save modified songs.
|-
| File/Save || <kbd>Ctrl</kbd>+<kbd>S</kbd> || Saves the song to disk.
|-
| File/Save As || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>S</kbd> || Allows you to save the file with a new name or in another folder.
|-
| File/Save Copy || || Allows you to save a copy of the file. The next Save action will update the file at its original location again.
|-
| File/Save As Template || || Creates a template from the current song.
|-
| File/Open Template || || Opens a file picker in the template module folder.
|-
| File/Stream Export || || Exports the current track into a lossless or lossy [[Manual: Saving and exporting#Stream Export|streaming file]].
|-
| File/Export as MIDI || || Exports the current track into the .mid format. See the section on [[Manual: Saving and exporting#MIDI Export|MIDI export]] for a detailed explanation of how this file is exported.
|-
| File/Export OPL Register Dump || || Exports the current track into one of several OPL register dump formats. See the section on [[Manual: Saving and exporting#OPL Export|OPL export]] for a detailed explanation of how this file is exported.
|-
| File/Compatibility Export || || Exports the current track without any [[Manual: Saving and exporting#Compatibility Export|file format hacks]] to its original format.
|-
| File/Import MIDI Library || || Imports the MIDI Instrument Library of your choosing. The MIDI Library can be accessed from the [[Manual: Tree View#MIDI Library|Tree View]].
|-
| File/Add Sound Bank || || Imports a sound bank of your choosing. Sound banks can be accessed from the [[Manual: Tree View#Sound Banks|Tree View]].
|-
| Previous Document || || Goes to the previous module file that is open (these are visible in the Windows Menu).
|-
| Next Document || || Goes to the next module file that is open (these are visible in the Windows Menu).
|-
| Play Song / Pause Song || <kbd>F5</kbd> || Toggles the playback of the current track. The playback cursor is not reset when using this toggle; that is, it plays from where the cursor left off when it was last pressed.
|-
| Play Song / Stop Song || || Toggles the playback of the current track. The playback cursor is reset to the start of the song.
|-
| Pause Song || <kbd>F8</kbd> || Only stops the playback of the current track but does not reset the playback pointer.
|-
| Stop Song || <kbd>Escape</kbd> || Stops the playback of the current track and resets the playback cursor to the start of the song.
|-
| Play Song from Start || <kbd>F6</kbd> || Resets the playback cursor to the very first row and begins playback from there.
|-
| Play Song from Cursor / Pause || || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there if playback is currently stopped, otherwise it pauses playback. Playback will continue until the end of the track.
|-
| Play Song from Cursor || <kbd>Ctrl</kbd>+<kbd>F6</kbd> || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there. Playback will continue until the end of the track.
|-
| Play Song from Pattern Start / Pause || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there if playback is currently stopped, otherwise it pauses playback.
|-
| Play Song from Pattern Start || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there.
|-
| Play Pattern from Start || <kbd>F7</kbd> || Loops the current pattern, starting at the first row of the pattern.
|-
| Play Pattern from Cursor || <kbd>Ctrl</kbd>+<kbd>F7</kbd> || Loops the current pattern, starting at the row where the editing cursor is currently placed.
|-
| Toggle Loop Song || || Enables or disables the song loop status.
|-
| Panic || || Stops all sample, OPL and plugin instrument voices.
|-
| Estimate Song Length || || Estimates the playback length of the entire track.
|-
| Show Approx. Real BPM || || Estimates the beats per minute of the song, based on the current tempo and the number of ticks per row, plus the Tempo Mode in the Song Properties dialog.
|-
| Toggle MIDI Record || <kbd>F9</kbd> || Toggles the MIDI Record option.
|-
| Increase Tempo || || Increases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo || || Decreases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Tempo (Fine) || || Increases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo (Fine) || || Decreases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Ticks per Row || || Increases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Decrease Ticks per Row || || Decreases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Undo || <kbd>Ctrl</kbd>+<kbd>Z</kbd> || Rescinds the last edit in the pattern or sample editor.
|-
| Redo || <kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd> || Reapplies the last undone action.
|-
| Cut || <kbd>Ctrl</kbd>+<kbd>X</kbd> || Copies the selected pattern, sample or instrument data into the clipboard, then removes it from the selection it occupies.
|-
| Copy || <kbd>Ctrl</kbd>+<kbd>C</kbd> || Copies the selected pattern, sample or instrument data into the clipboard.
|-
| Paste || <kbd>Ctrl</kbd>+<kbd>V</kbd>, <kbd>Shift</kbd>+<kbd>Insert</kbd> || Pastes data from the clipboard. In the pattern editor, it is pasted at the location of the cursor, overwriting any pattern data that falls within the paste area. With sample data, clipboard contents replace the '''whole''' sample.
|-
| Mix Paste || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>V</kbd> || Mixes clipboard contents with existing data. In the pattern editor, clipboard contents are pasted in the same row at the same column of the current (visible) pattern where the cursor is located, except where there is already any data in any corresponding field of the paste area. In the sample editor, the source and clipboard sample waveforms are mixed together.
|-
| Mix Paste (IT Style) || || For detailed differences between Mix Paste and Mix Paste (IT Style), consult the [[Manual: Patterns#Paste Modes|Pattern Editor help]]. The two commands are identical when used in the sample editor.
|-
| Paste Flood || <kbd>Shift</kbd>+<kbd>V</kbd> || Clipboard contents are pasted from the cursor, repeating the data paste until every row in the pattern has been filled and pasting over any data in its path.
|-
| Push Forward Paste (Insert) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>V</kbd> || Patterns: Clipboard contents are inserted at the row of the cursor, and pushing all data below that row further down the pattern. Any data of the affected channels pushed beyond the pattern’s last row is deleted. Samples: The sample data from the clipboard replaces the current selection. If there is no selection, the sample is inserted at the last selected position.
|-
| Select All || <kbd>Ctrl</kbd>+<kbd>5</kbd> || Selects all pattern or sample data.
|-
| Find / Replace || <kbd>Ctrl</kbd>+<kbd>F</kbd> || Opens the Find/Replace dialog, which allows you to search for and/or replace given pattern data. Find starts from the cursor location.
|-
| Find Next || <kbd>F3</kbd> || Applies the current Find settings and searches for the next data that matches it, starting from the current cursor location.
|-
| View General || <kbd>Alt</kbd>+<kbd>G</kbd> || Opens the [[Manual: General|General Tab]] of the currently focussed module.
|-
| View Pattern || <kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Patterns|Pattern Tab]].
|-
| View Samples || <kbd>Alt</kbd>+<kbd>S</kbd> || Opens the [[Manual: Samples|Sample Tab]].
|-
| View Instruments || <kbd>Alt</kbd>+<kbd>N</kbd> || Opens the [[Manual: Instruments|Instrument Tab]].
|-
| View Comments || <kbd>Alt</kbd>+<kbd>C</kbd>, <kbd>Shift</kbd>+<kbd>F9</kbd> || Opens the [[Manual: Comments|Comments Tab]].
|-
| Toggle Main Toolbar || || Shows / hides the [[Manual: Main Toolbar|Main Toolbar]].
|-
| Toggle Tree View || <kbd>Ctrl</kbd>+<kbd>F2</kbd> || Shows / hides the [[Manual: Tree View|Tree View]].
|-
| View Options || <kbd>Ctrl</kbd>+<kbd>F1</kbd> || Opens the [[Manual: Setup|Setup dialog]].
|-
| View Channel Manager || || Opens the [[Manual: Channel Manager|Channel Manager]].
|-
| View Plugin Manager || || Opens the [[Manual: Plugin Manager|Plugin Manager dialog]].
|-
| View Song Properties || || Opens the [[Manual: Song Properties|Song Properties dialog]].
|-
| View Global Tempo Swing Settings || || Opens the [[Manual: Tempo Swing Settings|Tempo Swing Settings dialog]] for the song’s global time signature. If modern tempo mode is not enabled yet, the [[Manual: Song Properties|Song Properties dialog]] is opened instead so that it can be enabled.
|-
| View Zxx Macro Configuration || || Opens the [[Manual: Macro Configuration|MIDI Macro Configuration]] dialog.
|-
| View MIDI Mapping || <kbd>Ctrl</kbd>+<kbd>F3</kbd> || Opens the [[Manual: MIDI Mapping|MIDI Mapping dialog]].
|-
| View Edit History || || Opens the [[Manual: Edit History|Edit History]].
|-
| Toggle Between Upper / Lower View || || Switches keyboard focus between the upper and lower half of the currently focussed song view.
|-
| Switch to Instrument Library || <kbd>Alt</kbd>+<kbd>I</kbd> || Sets keyboard focus to the [[Manual: Tree View|Instrument Library]], or switches back to the last used editor window if the tree view already has focus.
|-
| Help || <kbd>F1</kbd> || Opens the manual.
|-
| Open Context Menu || <kbd>▤ Application</kbd>, <kbd>Shift</kbd>+<kbd>F10</kbd> || Opens the context menu for the currently selected item.
|-
| Previous Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad/</kbd>, <kbd>Ctrl</kbd>+<kbd>Up</kbd> || Changes the current instrument to the previous one. In the sample editor, the previous sample is chosen.
|-
| Next Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad*</kbd>, <kbd>Ctrl</kbd>+<kbd>Down</kbd> || Changes the current instrument to the next one. In the sample editor, the next sample is chosen.
|-
| Previous Octave || <kbd>Numpad/</kbd> || Changes the current octave to the next lower octave.
|-
| Next Octave || <kbd>Numpad*</kbd> || Changes the current octave to the next higher octave.
|-
| Previous Order || <kbd>Ctrl</kbd>+<kbd>Left</kbd> || Changes the current pattern to the previous one in the pattern order.
|-
| Next Order || <kbd>Ctrl</kbd>+<kbd>Right</kbd> || Changes the current pattern to the next one in the pattern order.
|-
| Previous Order (Transition at end of current measure) || || Changes the current pattern to the previous one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current measure) || || Changes the current pattern to the next one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current beat) || || Changes the current pattern to the previous one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current beat) || || Changes the current pattern to the next one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current row) || || Changes the current pattern to the previous one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current row) || || Changes the current pattern to the next one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Dummy Shortcut || || Some keyboard shortcuts are created automatically by OpenMPT (e.g. the combinations of pressing the selection key together with navigation keys). If you need to prevent OpenMPT from automatically assigning a specific key combination, you can assign it to this dummy shortcut instead, so it will not be usable by automatically generated shortcuts. This will also prevent the key combination from being used by new default key combinations added by future OpenMPT updates.
|-
|}

== Pattern ==

=== Order List ===

These keyboard shortcuts operate while the cursor focus is in the Order List.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Delete Order || <kbd>Delete</kbd> || Erases the currently selected pattern(s) in the Order List (the pattern itself is not removed, only the reference).
|-
| Insert Order || <kbd>Insert</kbd> || Duplicates the currently selected pattern ''reference''(s) in the Order List.
|-
| Insert Separator || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Inserts a separator item (+++) at the next position.
|-
| Copy Orders || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Copies the currently selected pattern ''references'' in the Order List to the clipboard.
|-
| Edit Pattern || <kbd>Enter</kbd> || Resets the Pattern Editor to show the highlighted pattern.
|-
| Switch to Pattern Editor || <kbd>Tab</kbd> || Moves the cursor focus to the Pattern Editor. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Previous Order || <kbd>Left</kbd>, <kbd>Up</kbd> || Selects the previous pattern in the Order List.
|-
| Next Order || <kbd>Right</kbd>, <kbd>Down</kbd> || Selects the following pattern in the Order List.
|-
| First Order || <kbd>Home</kbd> || Selects the first pattern in the Order List.
|-
| Last Order || <kbd>End</kbd> || Selects the final pattern in the Order List.
|-
| Pattern Index Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the respective numeral into the pattern ID box.
|-
| Increase Pattern Index || <kbd>=</kbd>, <kbd>Numpad+</kbd> || Adds one to the pattern number, up to the highest indexed pattern.
|-
| Decrease Pattern Index || <kbd>-</kbd>, <kbd>Numpad-</kbd> || Subtracts one from the pattern number, to a minimum of index 0.
|-
| Separator Index || <kbd>I</kbd> || Adds a separator pattern item (+++) at the current position.
|-
| Stop Index || <kbd>Space</kbd> || Adds a stop pattern item (---) at the current position.
|-
| Lock Playback to Selection || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Song playback is locked to the patterns in the current order selection.
|-
| Unlock Playback || <kbd>Ctrl</kbd>+<kbd>U</kbd> || If playback has been limited to an order selection before, the playback lock can be removed here.
|-
| Queue Pattern (Transition at end of current pattern) || <kbd>Q</kbd> || The selected order list item is queued to be played next, after the current pattern has finished playing.
|-
| Queue Pattern (Transition at end of current measure) || <kbd>Shift</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current measure has finished playing.
|-
| Queue Pattern (Transition at end of current beat) || <kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current beat has finished playing.
|-
| Queue Pattern (Transition at end of current row) || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current row has finished playing.
|-
| Stream Export || || Opens the [[Manual: Saving and exporting#Stream Export|Wave Export dialog]] for the selected patterns.
|-
|}

=== Quick Channel Settings ===

These keyboard shortcuts operate while the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] is open.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Channel || <kbd>Alt</kbd>+<kbd>Left</kbd>, <kbd>Shift</kbd>+<kbd>Backspace</kbd> || Shows the channel settings for the previous channel.
|-
| Next Channel || <kbd>Alt</kbd>+<kbd>Right</kbd>, <kbd>Shift</kbd>+<kbd>Enter</kbd> || Shows the channel settings for the next channel.
|-
| Pick Color from Previous Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Left</kbd> || Assigns the color of the previous channel to the current channel.
|-
| Pick Color from Next Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Right</kbd> || Assigns the color of the next channel to the current channel.
|-
| Switch to Pattern Editor || <kbd>Enter</kbd> || Closes the dialog and returns to the Pattern Editor.
|-
|}

=== General Context ===

These keyboard shortcuts will work if the cursor focus is within any of the columns of the Pattern Editor, except where noted. When navigating (moving the cursor) to before the first row or after the last row in the pattern, the cursor “wraps” to the other side of the same pattern, if the “Cursor Wrap” option is enabled (in the Options section of the [[Manual: Setup/General|General tab]] of the Setup dialog). If navigating beyond the first or last row when the “Continuous Scroll” option is enabled, the cursor will instead move to the previous/next pattern in the order list.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Navigate Down by 1 Row || <kbd>Down</kbd> || Moves the cursor to the next row in the same column.
|-
| Navigate Up by 1 Row || <kbd>Up</kbd> || Moves the cursor to the previous row in the same column.
|-
| Navigate Down by Spacing || <kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor down by the value in the Row Spacing field.
|-
| Navigate Up by Spacing || <kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor up by the value in the Row Spacing field.
|-
| Navigate Left || <kbd>Left</kbd> || Moves the cursor to the previous column in the same row, going to the previous channel′s last column if moving from the first column of the current channel.
|-
| Navigate Right || <kbd>Right</kbd> || Moves the cursor to the next column in the same row, going to the next channel’s first column if moving from the last column of the current channel.
|-
| Navigate to Next Channel || <kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the next channel.
|-
| Navigate to Previous Channel || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the previous channel.
|-
| Jump Down by Measure || <kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Up by Measure || <kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Down by Beat || <kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump Up by Beat || <kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Measure || || Moves the cursor down to the first row of the next measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Up to Measure || || Moves the cursor up to the first row of the previous measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down to the first row of the next beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Snap Up to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up to the first row of the previous beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump to Previous Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column above the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the previous patterns.
|-
| Jump to Next Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column below the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the next patterns.
|-
| Go to First Channel || <kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the same row.
|-
| Go to First Row || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Moves the cursor to the first row of the same channel in the same column.
|-
| Go to First Row of First Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the first row.
|-
| Go to Last Channel || <kbd>End</kbd> || Moves the cursor to the last column of the last channel in the same row.
|-
| Go to Last Row || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Moves the cursor to the last row of the same channel in the same column.
|-
| Go to Last Row of Last Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>End</kbd> || Moves the cursor to the last column of the last channel in the last row.
|-
| Go to note column || || Moves the cursor to the note column of the current pattern cell.
|-
| Go to instrument column || || Moves the cursor to the instrument column of the current pattern cell.
|-
| Go to volume effect column || || Moves the cursor to the volume effect column of the current pattern cell.
|-
| Go to effect comamnd column || || Moves the cursor to the effect command column of the current pattern cell.
|-
| Go to effect parameter column || || Moves the cursor to the effect parameter column of the current pattern cell.
|-
| Previous Pattern || <kbd>Numpad-</kbd> || Displays the previous pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Next Pattern || <kbd>Numpad+</kbd> || Displays the next pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Previous Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>-</kbd> || Cycles to the previous sequence. If the current sequence is the first, the last sequence is selected.
|-
| Next Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>+</kbd> || Cycles to the next sequence. If the current sequence is the last, the first sequence is selected.
|-
| Scroll Left || || Scrolls the pattern editor to the left without changing the cursor position.
|-
| Scroll Right || || Scrolls the pattern editor to the right without changing the cursor position.
|-
| Scroll Up || || Scrolls the pattern editor up without changing the cursor position.
|-
| Scroll Down || || Scrolls the pattern editor down without changing the cursor position.
|-
| Selection Key || <kbd>Shift</kbd> || The modifier key to be used to extend the selection when navigating with keyboard shortcuts.
|-
| Copy Select Key || <kbd>Ctrl</kbd> || The modifier key to be used to copy the selection when dragging with the mouse.
|-
| Select Channel / Select All || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Selects all events of the channel where the cursor is located in the current pattern, or all events in the pattern if the entire channel is already selected.
|-
| Select Column || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Selects the column in which the cursor is located in all rows of the current pattern.
|-
| Select Row || || Completely selects all rows covered by the current selection.
|-
| Select Event || || Completely selects all events covered by the current selection.
|-
| Select Beat || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a beat and ends on the last row of a beat.
|-
| Select Measure || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a measure and ends on the last row of a measure.
|-
| Lose Selection || || Resets the selection rectangle to contain only the cursor position.
|-
| Copy and Lose Selection || || Copies the selected events to the clipboard and unselects them.
|-
| Quick Copy || <kbd>Enter</kbd> || Copies only one event of data (where the cursor is located) to OpenMPT′s “Quick” clipboard; the standard clipboard is not erased. Each column pair has its own Quick clipboard.
|-
| Quick Paste || <kbd>Space</kbd> || Pastes the data in OpenMPT′s “Quick” clipboard to the location of the cursor. The data last saved in that column’s clipboard will be pasted in the cursor′s corresponding column.
|-
| Cut to Pattern Channel Clipboard || || Copies and clears the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Cut to Pattern Clipboard || || Copies and clears the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Copy to Pattern Channel Clipboard || || Copies the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Copy to Pattern Clipboard || || Copies the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Paste from Pattern Channel Clipboard || || Replaces the contents of the channel the cursor is located in with the contents of the pattern channel clipboard.
|-
| Paste from Pattern Clipboard || || Replaces the contents of the current pattern with the contents of the pattern clipboard.
|-
| Toggle Clipboard Manager || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Toggles the visibility of the pattern clipboard manager.
|-
| Cycle to Previous Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Left</kbd> || Makes the previous internal clipboard the current clipboard.
|-
| Cycle to Next Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Right</kbd> || Makes the next internal clipboard the current clipboard.
|-
| Clear Row || || Deletes all event data in the same row in the current channel.
|-
| Clear Field || <kbd>Delete</kbd> || Deletes the selected pattern data, or just the data under the current cursor position if no selection has been made.
|-
| Clear Field (IT Style) || <kbd>Shift</kbd>+<kbd>.</kbd> || Same as “Clear field”, but also clears the instrument number if a note event is selected.
|-
| Clear Row and Step || <kbd>Ctrl</kbd>+<kbd>Delete</kbd> || Same as “Clear row”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step || || Same as “Clear field”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step (IT Style) || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Clear field (IT Style)”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Delete Row(s) || <kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; the data is moved up to replace the cleared data, and empty rows are added at the end of the affected channels.
|-
| Delete Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; the data is moved up to replace the cleared data, and empty rows are added at the end of the pattern.
|-
| Delete Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; this also affect all following patterns as no empty rows are inserted.
|-
| Delete Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; this also affect all following patterns as no empty rows are inserted.
|-
| Insert Row(s) || <kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last row of those channels is deleted.
|-
| Insert Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last row of all channels is deleted.
|-
| Insert Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Insert Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Mute Current Channel || <kbd>F10</kbd> || Toggles the sound output (mute) for the channel(s) covered by the current selection.
|-
| Solo Current Channel || <kbd>Ctrl</kbd>+<kbd>F10</kbd> || Toggles the sound output (mute) for all channels except the channel(s) covered by the current selection.
|-
| Unmute All Channels || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F10</kbd> || Unmutes the sound output for all channels.
|-
| (Un)mute Channel on Pattern Transition || || Toggles the sound output (mute) for the channel(s) covered by the current selection, but the change takes place when the current pattern is finished playing.
|-
| Unmute All Channels on Pattern Transition || || Unmutes the sound output for all channels when the current pattern is finished playing.
|-
| Solo Channel on Pattern Transition || || Toggles the sound output (mute) for all channels except the one where the cursor is located, but the change takes place when the current pattern is finished playing.
|-
| Channel Record Select || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Toggles the channel(s) covered by the current selection to belong to the primary record group.
|-
| Channel Split Record Select || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Toggles the channel(s) covered by the current selection to belong to the [[Manual: Keyboard Split|split record]] group.
|-
| Reset Channel || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Stops all note processing, and resets all channel variables to their defaults (volume, panning, etc.) on the selected channel(s).
|-
| Transpose Channel || || Changes the pitch of all notes on the selected channel in all patterns by a selectable amount of semitones.
|-
| Duplicate Channel || || Adds a new channel to the module and carries over all note data from the channel containing the edit cursor to this new channel.
|-
| Add Channel Before Current || || Adds a new empty channel before the channel containing the edit cursor.
|-
| Add Channel After Current || || Adds a new empty channel after the channel containing the edit cursor.
|-
| Remove Current || || Removes the channel containing the edit cursor. If the channel contains any data on any pattern, a confirmation prompt is shown.
|-
| Move Channels to Left || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the left by one channel.
|-
| Move Channels to Right || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the right by one channel.
|-
| Quick Channel Settings || || Opens the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] for the channel where the cursor is located.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the note number of the currently selected notes.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the note number of the currently selected notes.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the octave number of the currently selected notes.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the octave number of the currently selected notes.
|-
| Transpose Custom || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Lowers or raises the selected notes by an arbitrary amount of semitones.
|-
| Transpose Custom (Quick) || || Applies a previously chosen custom transpose amount. If no amount has been chosen before, the behaviour of this shortcut is identical to Transpose Custom.
|-
| Data Entry +1 || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry -1 || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry Up (Coarse) || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Data Entry Down (Coarse) || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Insert New Pattern || || Inserts a new blank pattern after the current pattern, displays it, and moves the cursor to the same position in it. Also functions when cursor focus is in the Order list.
|-
| Duplicate Pattern || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Inserts a new pattern with the current pattern′s contents.
|-
| Split Pattern || || Splits the current pattern at the cursor location.
|-
| Amplify Selection || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens a dialog to change the note volume commands of the selected volume data.
|-
| Interpolate Note || || Transitions smoothly (using all available notes) between notes in the selection, filling in (and replacing if necessary) all rows with new note data.
|-
| Interpolate Instrument || || Transitions smoothly (using all available instrument numbers) between instrument numbers in the selection, filling in all rows with new instrument data.
|-
| Interpolate Volume || <kbd>Ctrl</kbd>+<kbd>J</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new volume effects. The first and last rows of the selection must contain the same volume effect, or one of the two rows might be empty.
|-
| Interpolate Effect || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new effect data. The first and last rows of the selection must contain the same effect, or one of the two rows might be empty. Different effects within the selection are not overwritten.
|-
| Apply Current Instrument || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Applies the current instrument to all cells in the selection that contain note data.
|-
| Apply Current Instrument to Existing Only || || Applies the current instrument to all cells in the selection that contain an instrument numbers. Notes without instrument numbers are not updated.
|-
| Grow Selection || <kbd>Alt</kbd>+<kbd>E</kbd> || “Expands” the selection by doubling the number of the selected rows, and evenly spacing out the event data within it. The expansion will replace event data below it in the same channels as the selection.
|-
| Shrink Selection || <kbd>Alt</kbd>+<kbd>D</kbd> || “Shrinks” the selection by deleting every other row of the selection. However, if only part of any row is selected, the data corresponding to the deleted selected data is also deleted.
|-
| Expand Pattern || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>E</kbd> || “Expands” the entire pattern by doubling the number of the rows, and evenly spacing out the event data within it.
|-
| Shrink Pattern || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>D</kbd> || “Shrinks” the entire pattern by removing every other row.
|-
| Toggle Follow Song || <kbd>F11</kbd> || Toggles the “Follow Song” function.
|-
| Toggle Loop Pattern || <kbd>Shift</kbd>+<kbd>F11</kbd> || Toggles the Loop Pattern feature.
|-
| Play Row || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Process and play only the events in the current row where the cursor is located.
|-
| Go to Row/Channel/… || <kbd>Ctrl</kbd>+<kbd>G</kbd> || Opens the [[Manual: Go To|Go To]] dialog to allow you to jump to a different position in the module.
|-
| Pick Up Nearest Instrument Number || || Seeks for the nearest instrument number in the pattern channel the cursor currently is in. If an instrument number is found, it is set as the currently active instrument.
|-
| Enable Recording || <kbd>Ctrl</kbd>+<kbd>Space</kbd> || Toggles the Event Record feature. When enabled, patterns may be edited.
|-
| Toggle Metronome || <kbd>Alt</kbd>+<kbd>M</kbd> || Toggles the [[Manual: Metronome Settings|Metronome]].
|-
| Set Edit Step on Note Entry || <kbd>Alt</kbd> || The modifier key(s) that, when pressed with digits 0-9, allows you to change the Edit Step amount without using the mouse or moving the cursor focus out of the editor.
|-
| Increase Edit Step || || Increases the Edit Step by one row.
|-
| Decrease Edit Step || || Decreases the Edit Step by one row.
|-
| Switch to Order List || <kbd>Ctrl</kbd>+<kbd>Tab</kbd> || Toggles the cursor focus between the pattern editor and the current pattern in the Pattern Order list. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Toggle PC Event/Instrument Plugin Editor || <kbd>Ctrl</kbd>+<kbd>/</kbd> || Opens the editor for the plugin of the selected Parameter Control Event or instrument number.
|-
| Toggle Channel’s Plugin Editor || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the editor for the current channel′s assigned plugin.
|-
| Show Note Properties || <kbd>▤ Application</kbd> || Opens the [[Manual: Note Properties|Note Properties]] dialog, where you can assign any event data to the current row of the current channel.
|-
| Show Pattern Properties || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Pattern Properties|Pattern Properties]] dialog.
|-
| Split Keyboard Settings Dialog || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Keyboard Split|Keyboard Split]] dialog.
|-
| Open Effect Visualizer || <kbd>Alt</kbd>+<kbd>B</kbd> || Opens the [[Manual: Parameter Editor|Parameter Editor]] dialog.
|-
| Show Chord Editor || || opens the [[Manual: Chord Editor|Chord Editor]] dialog.
|-
| Show Context (Right-Click) Menu || || Opens the edit context menu at the cursor location without using the mouse.
|-
| Show Channel Context (Right-Click) Menu || || Opens the channel context menu at the cursor location without using the mouse.
|-
| Show Channel Plugin Context (Right-Click) Menu || || Opens the plugin context menu of the channel at the cursor location without using the mouse.
|-
| Show Playback Time at Current Row || <kbd>Ctrl</kbd>+<kbd>P</kbd> || Shows the estimated time within the track at the start of the current row.
|-
| Lock Playback to Rows || || If a selection is made, playback is locked to the selected rows. Otherwise, a previous playback lock is removed.
|-
| Quantize Settings || <kbd>Alt</kbd>+<kbd>Q</kbd> || Opens the record quantization settings.
|-
| Toggle row playback when navigating || || Toggles the state of the "play whole row when navigating" feature. The new state of the feature is announced in the status bar.
|-
| Toggle Overflow Paste || || When enabled, pasting will continue to the next pattern if the data overflows the current pattern.
|-
| Toggle Note Off Record (PC Keyboard) || || Toggles the recording of Note Off events from the PC keyboard in the pattern editor (also configurable from the [[Manual: Setup/General#Record note off|General setup]] page).
|-
| Toggle Note Off Record (MIDI) || || Toggles the recording of Note Off events from MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Apply Octave Transpose to incoming MIDI Notes || || Toggles application of the base octave transposition to notes received via MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Continue Song when MIDI Note is received || || Toggles whether pattern playback continues when a note is received via MIDI (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Respond to Play / Continue / Stop Song MIDI messages || || Toggles whether pattern playback starts / stops / continues when the corresponding MIDI commands are received (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Velocity || || Toggles whether MIDI velocity is recorded (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Pitch Bend || || Toggles whether MIDI pitch bends are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI CCs || || Toggles whether MIDI CC events are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Instrument Column Visibility || || Shows or hides the instrument column.
|-
| Toggle Volume Column Visibility || || Shows or hides the volume column.
|-
| Toggle Effect Column Visibility || || Shows or hides the effect column.
|}

=== Note Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the note column (the first column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Base Octave [note] || <kbd>Q</kbd>, <kbd>W</kbd>, ... || Enters a note in the octave indicated in the Octave field.
|-
| Base Octave +1 [note] || <kbd>A</kbd>, <kbd>S</kbd>, ... || Enters a note in the next higher octave indicated in the Octave field.
|-
| Base Octave +2 [note] || <kbd>Z</kbd>, <kbd>X</kbd>, ... || Enters a note two octaves higher than the one indicated in the Octave field.
|-
| Base Octave +3 [note] || || Enters a note three octaves higher than the one indicated in the Octave field.
|-
| Base Octave +4 [note] || || Enters a note four octaves higher than the one indicated in the Octave field.
|-
| Set Octave [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Sets the selected note’s octave.
|-
| Chord Modifier || <kbd>Shift</kbd> || The modifier key(s) that calls a chord rather than a note. The chords are set and assigned in the [[Manual: Chord Editor|Chord Editor]].
|-
| Note Cut || <kbd>`</kbd> || Enters a Note Cut command (^^). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>1</kbd>.
|-
| Note Off || <kbd>=</kbd> || Enters a Note Off command (==). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>Backspace</kbd>.
|-
| Note Fade || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a Note Fade command (~~). Note: The default shortcut is position-independent and is bound to the key that is usually lef of <kbd>Backspace</kbd>.
|-
| Parameter Control || <kbd>Shift</kbd>+<kbd>-</kbd> || Enters an absolute [[Manual:_Parameter_Control_Events|Parameter Control event]] (PC). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
| Parameter Control (Smooth) || <kbd>-</kbd> || Enters a smooth sliding Parameter Control event (PCs). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
|}

=== Instrument Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the instrument column (the second column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Instrument Digit [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the instrument field, moving the existing digits to the left.
|-
|}

=== Volume Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the volume column (the third column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Volume Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left.
|-
| Set Volume Digit [A - F] || || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left. By default, volume column parameters are shown in decimal and these shortcuts are not assigned. You can use them after enabling the [[Manual: Hidden Settings#.5BPattern Editor.5D|Pattern Editor.VolumeColumnInHex]] hidden setting.
|-
| Volume Command - Volume || <kbd>V</kbd> || Enters a note volume (vxx) command into the pattern.
|-
| Volume Command - Panning || <kbd>P</kbd> || Enters a panning command (pxx) into the pattern.
|-
| Volume Command - Volume Slide Up || <kbd>C</kbd> || Enters volume slide up (cxx) into the pattern.
|-
| Volume Command - Volume Slide Down || <kbd>D</kbd> || Enters a volume slide down (dxx) into the pattern.
|-
| Volume Command - Fine Volume Slide Up || <kbd>A</kbd> || Enters a fine volume slide up (axx) into the pattern.
|-
| Volume Command - Fine Volume Slide Down || <kbd>B</kbd> || Enters a fine volume slide down (bxx) into the pattern.
|-
| Volume Command - Vibrato Speed || <kbd>U</kbd> || Enters a vibrato speed command (uxx) into the pattern.
|-
| Volume Command - Vibrato Depth || <kbd>H</kbd> || Enters a vibrato depth command (hxx) into the pattern.
|-
| Volume Command - XM Pan Slide Left || <kbd>L</kbd> || Enters a pan slide to the left (lxx) into the pattern.
|-
| Volume Command - XM Pan Slide Right || <kbd>R</kbd> || Enters a pan slide to the right (rxx) into the pattern.
|-
| Volume Command - Tone Portamento || <kbd>G</kbd> || Enters a tone portamento command (gxx) into the pattern.
|-
| Volume Command - Portamento Up || <kbd>F</kbd> || Enters a pitch bend up command (fxx) into the pattern.
|-
| Volume Command - Portamento Down || <kbd>E</kbd> || Enters a pitch bend down command (exx) into the pattern.
|-
| Volume Command - Offset || <kbd>O</kbd> || Enters a coarse sample offset command (oxx) into the pattern.
|-
|}

=== Effect Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect column (the fourth column). Alphanumeric effect letters (0-9, A-Z) are currently not editable — they are automatically assigned to the respective keys on your keyboard.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Smooth MIDI Macro Slide || <kbd>\</kbd> || Enters a Smooth MIDI Macro Slide (\xx) into the pattern.
|-
| Combined Note Delay and Note Cut || <kbd>;</kbd>, <kbd>Shift</kbd>+<kbd>;</kbd> || Enters a Delay-Cut (:xy) command into the pattern.
|-
| Parameter Extension Command || <kbd>/</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Parameter Extension Command]] (#xx) into the pattern.
|-
| Finetune || <kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Finetune Command]] (+xx) into the pattern.
|-
| Finetune (Smooth) || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Smooth Finetune Command]] (*xx) into the pattern.
|-
|}

=== Effect Parameter Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect parameter column (the fifth column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Effect Parameter Digit [0 – F] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd>, <kbd>A</kbd>-<kbd>F</kbd> || Enters the digit into the rightmost place in the effect parameter field, moving the existing digits to the left.
|-
|}

== Sample Editor ==

These shortcuts are applied when the [[Manual: Samples|Samples Tab]] is active.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Trim Sample around Loop Points || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Trims the sample to the selection, if there is one. Otherwise, if loop points are specified, all sample data outside of these start/end times are deleted.
|-
| Trim to Loop End || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>T</kbd> || If loop points are specified, all sample data past the loop end is deleted.
|-
| Silence Sample Selection || <kbd>Backspace</kbd> || All of the sample data within the selected area is set to zero, effectively placing silence in that span.
|-
| Normalize Sample || <kbd>Shift</kbd>+<kbd>N</kbd> || Applies Normalisation to the sample.
|-
| Amplify Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens the [[Manual: Amplify|Amplify]] dialog, allowing you to alter the volume of the sample and apply Fade In or Fade Out (from / to silence).
|-
| Reverse Sample || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>R</kbd> || Puts the selected sample data in reverse order, so it is being played backwards.
|-
| Delete Sample Selection || <kbd>Delete</kbd> || Deletes the sample data within the selection, moving the remaining data together.
|-
| Toggle Sample Drawing || || Turns sample drawing mode on or off.
|-
| Add Silence / Create Sample || || Opens the dialog for adding silence, resizing samples and initializing FM instruments.
|-
| Configure Sample Grid || || Opens the dialog for setting the sample grid properties.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the data-to-display ratio, effectively zooming in to show more graphic detail of the sample data.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the data-to-display ratio, effectively zooming out to show less graphic detail of the sample data.
|-
| Zoom into Selection || <kbd>Space</kbd> || Zooms so much into the sample data that the current selection covers as much of the sample display as possible. If no selection has been made, auto-zoom is enabled.
|-
| Zoom into Sample Start || <kbd>1</kbd> || Zooms into the sample and ensures that the sample start is visible in the view.
|-
| Zoom into Sample End || <kbd>2</kbd> || Zooms into the sample and ensures that the sample end is visible in the view.
|-
| Center Loop Start in View || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Ensures that the normal sample loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Loop End in View || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Ensures that the normal sample loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop Start in View || <kbd>Ctrl</kbd>+<kbd>3</kbd> || Ensures that the sample sustain loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop End in View || <kbd>Ctrl</kbd>+<kbd>4</kbd> || Ensures that the sample sustain loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Convert Ping-Pong Loop to Unidirectional || || Turns a bidi-looped sample loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Convert Ping-Pong Sustain Loop to Unidirectional || || Turns a bidi-looped sustain loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Convert to 8-bit / 16-bit || <kbd>Ctrl</kbd>+<kbd>8</kbd> || Changes the sample’s bit depth between 8-bit and 16-bit.
|-
| Convert to Mono (Mix) || <kbd>Shift</kbd>+<kbd>M</kbd> || Mixes the left and right channels of a stereo sample equally together.
|-
| Convert to Mono (Left Channel) || <kbd>Shift</kbd>+<kbd>L</kbd> || Only keeps the left channel of a stereo sample.
|-
| Convert to Mono (Right Channel) || <kbd>Shift</kbd>+<kbd>R</kbd> || Only keeps the right channel of a stereo sample.
|-
| Convert to Mono (Split Sample) || <kbd>Shift</kbd>+<kbd>S</kbd> || Create two sample slots for this sample, one containing only the left channel and the other containing just the right channel. If the sample is referenced by an instrument, this instrument is duplicated as well for the right channel.
|-
| Change Stereo Separation || <kbd>Shift</kbd>+<kbd>P</kbd> || Adjusts the stereo separation of the sample by a given amount, either widening or narrowing the stereo width.
|-
| Upsample || <kbd>Shift</kbd>+<kbd>F</kbd>|| Doubles the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Downsample || <kbd>Shift</kbd>+<kbd>G</kbd>|| Halves the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Resample || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Changes the sample’s middle-C frequency to a new arbitrary frequency.
|-
| Invert Sample Phase || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Inverts the sample’s phase, i.e. it is mirrored along the time axis.
|-
| Signed / Unsigned Conversion || <kbd>Ctrl</kbd>+<kbd>U</kbd> || Re-interprets the sample data as a signed or unsigned sample.
|-
| Remove DC Offset || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Removes an unwanted static DC Offset from the waveform, i.e. it is centered around the time axis.
|-
| Quick Fade || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Applies a fade-in for the selected sample data if the selection includes the beginning of the sample, or applies a fade-out if the selection includes the end of the sample. If neither the beginning or end of the waveform is part of the selection, the Amplify dialog is shown.
|-
| Crossfade Sample Loop || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Opens the Crossfade Loop dialog to crossfade the sample loop’s end with the loop start, to create seamless loop transitions.
|-
| Tune Sample to Given Note || || Opens the [[Manual: Sample Tuner|Sample Tuner]] dialog, where the sample can be tuned to a given note.
|-
| Load Sample || <kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. This command also works in the Instrument Tab, importing an instrument to the current Instrument slot.
|-
| Load Raw Sample || <kbd>Shift</kbd>+<kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. The [[Manual: Raw Sample Import|Raw Sample Import]] is shown, ignoring the sample format even if it is known to OpenMPT.
|-
| Save Sample || || Opens the Save File dialog to allow you to save the sample as a Wave Audio or Raw file into a folder of your choice. This command also works in the Instrument Tab, saving the instrument and its accompanying samples as an .iti, .xi or .sfz file.
|-
| New Sample || || Creates a blank sample in the next unused slot. This command also works in the Instrument Tab.
|-
| Duplicate Sample || || Duplicates the current sample slot into the next unused slot.
|-
| Initialize OPL Instrument || || Configures the current sample slot to be a synthesized OPL instrument and recalls the default instrument parameters.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises the middle-C frequency by one semitone.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers the middle-C frequency by one semitone.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises (doubles) the middle-C frequency by one octave.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers (halves) the middle-C frequency by one octave.
|-
| Increment Finetune || <kbd>Shift</kbd>+<kbd>Up</kbd> || Raises the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Decrement Finetune || <kbd>Shift</kbd>+<kbd>Down</kbd> || Lowers the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Toggle Follow Sample Play Cursor|| <kbd>Shift</kbd>+<kbd>F</kbd> || Cycles through all three [[Manual: Setup/Samples#Automatic Scrolling when_Zoomed-In|sample playback cursor follow modes]]. The new follow mode is announced in the status bar.
|-
| Preview / Set Sample Cue [1 - 9] || <kbd>Shift</kbd>+<kbd>1</kbd>-<kbd>9</kbd> || Previews the sample at middle-C, starting from the chosen cue point. If the cue point is unset and the sample is currently being previewed, the cue point is set to the current play position.
|-
| Slice at Cue Points || || Creates new samples from the current sample by splitting the sample at its cue points.
|-
|}

== Instrument Editor ==

These shortcuts are applied when the [[Manual: Instruments#Sample Map|Sample Map]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Duplicate Instrument || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Creates a new instrument slot using ''all'' the same instrument attributes as the currently displayed instrument.
|-
| Edit Sample Map || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Sample Map|Sample Map]] dialog.
|-
| Edit Current Sample || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the Samples page of the currently selected sample slot.
|-
| Map All Notes to Selected Note || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected note to all notes.
|-
| Map All Notes to Selected Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected sample slot to all notes.
|-
| Reset Note Mapping || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Resets the note assignments, so that each note maps to itself (C-5 → C-5, D-5 → D-5, and so on).
|-
| Remove All Samples || || Removes any sample associations from the instrument.
|-
| Transpose +1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one semitone.
|-
| Transpose -1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one semitone.
|-
| Transpose +1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one octave.
|-
| Transpose -1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one octave.
|-
|}

=== Envelope Editor ===

These shortcuts are applied when the [[Manual: Instruments#Envelope Editor|envelope editor]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Load Envelope || || Replaces the currently active envelope with an envelope from disk.
|-
| Save Envelope || || Stores the currently active envelope to disk.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the detail of the Envelope Window, showing a smaller excerpt of the envelope.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the detail of the Envelope Window, showing a bigger excerpt of the envelope.
|-
| Scale Envelope Points || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Scale Envelope Points|Scale Envelope Points]] dialog.
|-
| Switch to Volume Envelope || <kbd>Shift</kbd>+<kbd>M</kbd> || Selects the Volume Envelope for editing.
|-
| Switch to Panning Envelope || <kbd>Shift</kbd>+<kbd>P</kbd> || Selects the Panning Envelope for editing.
|-
| Switch to Pitch / Filter Envelope || <kbd>Shift</kbd>+<kbd>I</kbd> || Selects the Pitch / Filter Envelope for editing.
|-
| Toggle Volume Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd> || Enables or disables the Volume Envelope.
|-
| Toggle Panning Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> || Enables or disables the Panning Envelope.
|-
| Toggle Pitch Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> || Enables or disables the Pitch Envelope.
|-
| Toggle Filter Envelope || <kbd>Shift</kbd>+<kbd>F</kbd> || Enables or disables the Filter Envelope.
|-
| Toggle Envelope Loop || <kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Loop.
|-
| Select Envelope Loop Start || <kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope loop start.
|-
| Select Envelope Loop End || <kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope loop end.
|-
| Toggle Envelope Sustain Loop || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Sustain Loop.
|-
| Select Envelope Sustain Start || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope sustain start.
|-
| Select Envelope Sustain End || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope sustain end.
|-
| Toggle Envelope Carry || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Enables or disables the Envelope Carry.
|-
| Select Previous Envelope Point || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the selection to the previous envelope point.
|-
| Select Next Envelope Point || <kbd>Tab</kbd> || Moves the selection to the following envelope point.
|-
| Move Envelope Point Left || <kbd>Left</kbd> || Moves the selected envelope point left one tick.
|-
| Move Envelope Point Left (Coarse) || <kbd>Shift</kbd>+<kbd>Left</kbd> || Moves the selected envelope point left one beat.
|-
| Move Envelope Point Right || <kbd>Right</kbd> || Moves the selected envelope point right one tick.
|-
| Move Envelope Point Right (Coarse) || <kbd>Shift</kbd>+<kbd>Right</kbd> || Moves the selected envelope point right one beat.
|-
| Move Envelope Point Up || <kbd>Up</kbd> || Moves the selected envelope point up one unit.
|-
| Move Envelope Point Up (Coarse) || <kbd>PageUp</kbd> || Moves the selected envelope point up 8 units.
|-
| Move Envelope Point Down || <kbd>Down</kbd> || Moves the selected envelope point down one unit.
|-
| Move Envelope Point Down (Coarse) || <kbd>PageDown</kbd> || Moves the selected envelope point down 8 units.
|-
| Insert Envelope Point || <kbd>Insert</kbd> || Inserts an envelope point after the selected point.
|-
| Remove Envelope Point || <kbd>Delete</kbd>, <kbd>Backspace</kbd> || Deletes the selected envelope point.
|-
| Set Loop Start || <kbd>Home</kbd> || Sets the selected envelope point as the Envelope Loop start point.
|-
| Set Loop End || <kbd>End</kbd> || Sets the selected envelope point as the Envelope Loop end point.
|-
| Set Sustain Loop Start || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Sets the selected envelope point as the Sustain Loop start point.
|-
| Set Sustain Loop End || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Sets the selected envelope point as the Sustain Loop end point.
|-
| Toggle Release Node || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the selected envelope point as the start point for the Release Envelope.
|-
|}

== Comments [Bottom] ==

These shortcuts are applied when the lower half of the [[Manual: Comments|Comments tab]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Toggle Between Lists || <kbd>Tab</kbd> || Toggles between the sample and instrument list.
|-
| Open Item in Editor || <kbd>Enter</kbd> || Switches to the sample or instrument editor to edit the currently selected item.
|-
| Rename Item || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Brings up an edit box for renaming the selected sample or instrument.
|-
|}

== Plugin Editor ==

These shortcuts are applied when a [[Manual: Plugin Window|plugin window]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Plugin Preset || <kbd>Numpad-</kbd> || Selects the previous plugin preset / patch.
|-
| Next Plugin Preset || <kbd>Numpad+</kbd> || Selects the following plugin preset / patch.
|-
| Plugin Preset Backward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad-</kbd> || Jumps back 10 entries in the preset list.
|-
| Plugin Preset Forward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad+</kbd> || Jumps forward 10 entries in the preset list.
|-
| Randomize Plugin Parameters || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>D</kbd> || Give random values to all parameters of the current plugin.
|-
| Toggle Parameter Recording || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the parameter recording function, which allows you to record parameter changes from plugin window into the pattern.
|-
| Record MIDI Out to Pattern Editor || || Toggles the MIDI Out recording function, which allows you to route the plugin’s MIDI output to the pattern, sample or instrument editor.
|-
| Pass Key Presses to Plugin || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Toggles the Pass Keys function, which sends all keyboard input to the currently open plugin window (e.g. for entering a serial number in the plugin GUI).
|-
| Bypass Plugin || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Toggles plugin’s bypass property to control whether audio is routed through the plugin or not.
|}

== Tree View ==

These shortcuts are applied when the [[Manual:_Tree_View|Tree View]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Switch between Upper / Lower Tree View || <kbd>Tab</kbd> || Switches focus between the upper and lower panel of the Tree View.
|-
| Open / View Item || <kbd>Enter</kbd> || Opens / views / previews the selected item (same action as double-click).
|-
| Play Item || <kbd>Space</kbd> || Previews the selected item if it is a sample, instrument or file.
|-
| Insert Item || <kbd>Insert</kbd> || Inserts an empty item (e.g. sample or instrument slot) after the currently selected item.
|-
| Duplicate Item || <kbd>Shift</kbd>+<kbd>Insert</kbd> || Duplicates the currently selected item (e.g. sample or instrument slot).
|-
| Delete Item || <kbd>Delete</kbd> || Deletes the currently selected item.
|-
| Delete Item Permanently || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Delete Item”, but if the selected item is a file, it will not be moved to the recycling bin.
|-
| Rename Item / Send To Editor || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items belonging to an open module (e.g. patterns, samples, instruments, ...): The selected item is renamed. For items in the instrument library: The item is sent to the last active sample or instrument editor and replaces the currently selected sample or instrument.
|-
| Send To Editor (Insert New) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items in the instrument library: The item is sent to the last active sample or instrument editor and is loaded into a new sample or instrument slot.
|-
| Go to Parent Folder || <kbd>Backspace</kbd> || Changes the instrument library folder to the current location′s parent folder.
|-
| Find in Instrument Library || <kbd>Ctrl</kbd>+<kbd>F</kbd>|| Opens the search filter to quickly locate files and folders in the instrument library.
|-
| Sort Instrument Library By Name || || Items in the instrument library are sorted by their file name.
|-
| Sort Instrument Library By Date || || Items in the instrument library are sorted by their last file modification date.
|-
| Sort Instrument Library By Size || || Items in the instrument library are sorted by their file size.
|}

[[Category:Manual|Keyboard Actions]]

Manual: Menus

2025-06-15T21:38:47Z

Saga Musix: /* View */

In all menu screenshots, the keyboard shortcuts are shown but may be different from your own. You can configure these in the [[Manual:_Setup/Keyboard|Keyboard setup]].

[[Image: File Menu.png|thumb|250px|File Menu]]

=== File ===

* '''New''': Creates a new song. You can select the module type from the sub menu. When using the shortcut for a new module, OpenMPT uses the default track settings as specified in the [[Manual: Setup/General#Defaults|general settings]].
* '''Open''': Loads one or more songs you want to open and adds them to the Recent Files list. OpenMPT can open a variety of file formats, listed in the [[Manual: Module formats|Module formats]] section.
* '''Open Template''': Provides a list of modules that have previously been saved as templates.
* '''Append Module''': [[Manual: Module Merging|Appends]] (merges) the song data (samples, instruments, plugins, patterns and sequences) of one or more existing songs to the currently active song.
* '''Close''': Closes the currently active song. If changes were made (shown by an asterisk in OpenMPT’s title bar), you will be prompted if you wish to save the changes.
* '''Close All''': Closes all open songs. You will be prompted to save any modified songs.
* '''Save''': Saves the file in its current directory with its current name. If the file is new and was never saved, this command is the same as the “Save As” menu item.
* '''Save As''': Opens a dialog where you can specify a location you wish to store the file to.
* '''Save Copy''': Opens a dialog where you can save a copy of the current module to. The next Save action will save the file at its original location again.
* '''Save as Template''': Saves the currently open module as a template module.
* '''Compatibility Export''': Exports the track to a “pure” version of the track format. See the section on [[Manual: Saving and exporting#Compatibility Export|Compatibility Export]] for more details. The track itself is not modified.
* '''Stream Export''': Exports the track to a lossless (WAV, FLAC, AU, RAW) or lossy (Opus, Ogg Vorbis, MP3) audio file.
* '''Export as MIDI''': Exports the track to a .mid sequencer file.
* '''Import MIDI Library''': Shows the Open File dialog so you can load a new default MIDI library, which will overwrite your current MIDI library in the [[Manual: Tree View#MIDI Library|Tree View]].
* '''Add Sound Bank''': Shows the Open File dialog so you can append another [[Manual: Tree View#Sound Banks|sound bank]] folder into the Tree View.
* '''Recent Files List''': Lists the last 10 files that were opened in OpenMPT. The shortcut keys are the digits <kbd>1</kbd> to <kbd>0</kbd>.
* '''Exit''': Executes the Close command on all files (see above), saves all settings and quits ModPlug Tracker.

[[Image: Player Menu.png|thumb|250px|Player Menu]]

=== Player ===

* '''Pause / Resume''': If playing, the active song is paused. All audio processing is stopped; when resuming playback from Pause, playback is continued from the position where it was paused.
* '''Play from Start''': Resets the playback position to the beginning of the first pattern in the Order List, and begins playback.
* '''Stop''': Stops all audio processing and resets the playback position.
* '''Pause''': Pauses the song by stopping audio processing, but ''not'' resetting the playback position.
* '''MIDI Record''': Allows MIDI messages to be received from the device specified in the [[Manual: Setup/MIDI|MIDI setup]]. This device can then be used to enter notes and other MIDI data in the pattern, sample and instrument editors. See the section on [[Manual: Setup/MIDI|MIDI Setup]], [[Manual: MIDI Mapping|MIDI Mapping]], or [[Manual: MIDI Reference#OpenMPT Setup|MIDI in OpenMPT]] for more details.
* '''Estimate Song Length''': Displays an estimate of the song length. When working with multiple sequences, only the current sequence is considered in the calculation.
* '''Approximate Real BPM''': Displays an estimate of the actual tempo in terms of Beats per Minute (BPM), based on the current tempo, ticks per row (speed) and rows per beat settings according to the chosen [[Manual: Song Properties#Tempo Mode|tempo mode]].

[[Image: Edit Menu.png|thumb|250px|Edit Menu]]

=== Edit ===

* '''Undo''': Withdraws the last edit action taken. There is a limit to the number of Undo steps — 100,000 for Pattern edits and 100,000 for edits of '''each''' sample or instrument. For samples, you can also limit the amount of memory used by the Undo buffer in the [[Manual: Setup/Samples|Sample Editor settings]].
* '''Redo''': Reapplies the last undone action.
* '''Cut''': Copies the selection to the clipboard and then erases all data from the selected area.
* '''Copy''': Copies the selection to the clipboard.
* '''Paste''': Transfers a copy of the clipboard contents where the cursor is located, overwriting any data within the bounds of the pasted data. For pattern data, the clipboard content will be pasted in the same cell as the cursor location, even if the cursor is not in the first column of the event. For sample data, pasting replaces the complete samples. To paste ''into'' an existing sample, use the '''Paste Special''' menu.
* '''Paste Special''': This sub menu contains alternate forms of pasting data into patterns or samples, as described in the [[Manual: Patterns#Paste Modes|Pattern Editor manual]] and [[Manual: Samples#Sample Display Context Menu|Sample Editor manual]] respectively.
* '''Select All''': Selects all data in the location of the input focus (the Pattern Editor or the Sample Display). The cursor remains in the same location.
* '''Cleanup''': Opens the [[Manual: Cleanup Manager|Cleanup Manager dialog]], which allows you to remove, reset, or re-arrange track elements such as patterns and samples.
* '''Automatic Sample Trimmer''': Trims samples to the maximum length that is played in the module. Muted and unused samples are not trimmed.
* '''Find''': Opens the Find & Replace dialog, where you can search for data and replace it if necessary.
* '''Find Next''': Finds the next occurrence of data according to your previous filters in the Find dialog.
* '''Go To''': Opens the [[Manual: Go To|Go To]] dialog where you can choose to navigate to another pattern location.
* '''Split Keyboard Settings''': Opens the [[Manual: Keyboard Split|Keyboard Split]] dialog.

[[Image: View Menu.png|thumb|250px|View Menu]]

=== View ===

* '''General Tab''': Displays the [[Manual: General|General Page]] of the currently active module.
* '''Patterns Tab''': Displays the [[Manual: Patterns|Patterns]] Page.
* '''Samples Tab''': Displays the [[Manual: Samples|Samples]] Page.
* '''Instruments Tab''': Displays the [[Manual: Instruments|Instruments]] Page.
* '''Comments Tab''': Displays the [[Manual: Comments|Comments]] Page.
* '''Toolbars''':
** '''Show Main Toolbar''': Toggles the display of the Main Toolbar, remembering its position.
** '''Show Tree View''': Toggles the display of the [[Manual: Tree View|Folder Tree View]].
** '''Tree View on Left''': Toggling this option moves the [[Manual: Tree View|Folder Tree View]] to the left or right side of the window.
** '''Main Toolbar items''':
*** '''File Icons''': Toggles the display of the New / Open / Save File icons in the main toolbar.
*** '''Edit Icons''': Toggles the display of the Cut / Copy / Paste icons in the main toolbar.
*** '''Play / Record Icons''': Toggles the display of the MIDI Record / Stop / Play Pause / Play From Start icons in the main toolbar.
*** '''Base Octave''': Toggles the display of the Base Octave readout in the main toolbar.
*** '''Tempo''': Toggles the display of the Tempo readout in the main toolbar.
*** '''Ticks / Row''': Toggles the display of the Ticks / Row (Speed) readout in the main toolbar.
*** '''Rows Per Beat''': Toggles the display of the Rows Per Beat readout in the main toolbar.
*** '''Global Volume''': Toggles the display of the Global Volume readout in the main toolbar.
*** '''Misc Icons''': Toggles the display of the Setup / Panic / Update Available icons in the main toolbar.
*** '''VU Meters''': Toggles the display of the VU Meters in the main toolbar.
* '''Setup''': Shows the [[Manual: Setup|Setup Options]] dialog at the last open page.
* '''Plugin Manager''': Shows the [[Manual: Plugin Manager|Plugin Manager]] dialog.
* '''Channel Manager''': Shows the [[Manual: Channel Manager|Channel Manager]] dialog.
* '''Clipboard Manager''': Shows the [[Manual: Clipboard Manager|Clipboard Manager]] dialog.
* '''Song Properties''': Shows the [[Manual: Song Properties|Song Properties]] dialog.
* '''Zxx Macro Configuration''': Shows the [[Manual: Macro Configuration|MIDI Macro Configuration]] dialog.
* '''MIDI Mapping Options''': Shows the [[Manual: MIDI Mapping|MIDI Mapping]] dialog.
* '''Edit History''': Shows the [[Manual: Edit History|Edit History]] dialog.
* '''Find OpenMPT Hacks''': Lists the non-standard (non-compatible) modifications in the current track introduced by ModPlug Tracker. This helps to show what needs to be changed so that other trackers or players can play the file correctly.

When changing the visibility of main toolbar items, at least one icon group must remain visible. Once you try to hide the last visible icon group, trying to do so will have no effect.

[[Image: Window Menu.png|thumb|250px|Window Menu]]

=== Window ===

* '''New Window''': Opens an alternate window of the current track using the same page display.
* '''Cascade Windows''': Resizes and “cascades” all open windows (by superimposing one over the other diagonally) so that any window can be brought to the front with a mouseclick on that window.
* '''Tile Windows Horizontal''': Resizes all open windows so that horizontally they equal the width of OpenMPT’s window, and vertically they share an equal amount of space between the Menu Bar and the Status Bar.
* '''Tile Windows Vertical''': Resizes all open windows so that vertically they equal the height of OpenMPT’s window, and horizontally they share an equal amount of space between the Folder Tree and the right side of OpenMPT’s window.
* '''Arrange Icons''': All minimized child windows are moved back to the lower-left corner of the main window, where they are located by default.
* '''Split''': Allows a page to be split horizontally. Selecting this menu item centers the mouse cursor in the screen and “grabs” the divider so you can reposition it.
* '''Current Open Files List''': Shows all open tracks in the order they were loaded. The one with the check mark is the “current” track to which all the relevant menu items will be applied.

[[Image: Help Menu.png|thumb|250px|Help Menu]]

=== Help ===

* '''Help''': Opens the help file.
* '''Report a Bug''': Opens the OpenMPT Issue Tracker in your default Internet browser, where you can report a bug (obviously this only works if your computer is online).
* '''Example Modules''': Shows a list of example tunes that are shipped with OpenMPT.
* '''Show Settings Folder''': Opens the folder containing all the configuration files.
* '''OpenMPT Website''': Opens the OpenMPT front page (openmpt.org) in your default Internet browser.
* '''Web Resources''': Opens a list of interesting web resources related to OpenMPT in your default Internet browser.
* '''Check for Updates''': Manually runs the [[Manual: Setup/Update|online update check]].
* '''About OpenMPT''': Shows OpenMPT’s About window that displays the credits for OpenMPT, links to its website and various system information helpful for debugging.

[[Category:Manual|Menus]]
[[de:Handbuch: Hauptfenster/Menuepunkte]]

File:View Menu.png

2025-06-15T21:35:50Z

Saga Musix: Saga Musix uploaded a new version of File:View Menu.png

Manual: Compatible Playback

2025-06-12T19:42:28Z

Saga Musix: /* IT compatibility settings */

== Why a compatible playback mode? ==

[[Image:Compatible Mode.png|thumb|300px|More compatible playback of modules can be enabled in the [[Manual: Song Properties#Miscellaneous Flags|Song Properties]]. When you see this warning icon, it might be a good idea to review the compatibility settings.]]

Playback accuracy has always been a problem with tracked music. While the tracker interface with its effect letters and such is simple and fast to use, the internal algorithms used to process effects are not always as simple as they might appear on-screen. For example, due to a little typo, an effect might behave erratically under certain conditions in its original tracker application.

When another tracker (like OpenMPT) decides to support a certain third-party format (for example the XM format of Fasttracker 2), it should faithfully reproduce the meaning of every effect letter and all other behaviour. Sadly, this has not always been the case with (Open)MPT. In the past, users of other trackers have often complained that OpenMPT does not behave like other trackers and thus replays their music (that has been written in another tracker like Fasttracker 2) incorrectly.

Often, making OpenMPT “emulate” those original behaviours, or indeed “quirks”, is the matter of changing a single line of code. However, the same feature that has previously been playing wrong in (Open)MPT may of course, after having fixed it, sound “wrong” in any modules composed with (Open)MPT that made use of this feature. Thus, the programmers of OpenMPT found it necessary to add a “Compatible Playback” option (to be found in the [[Manual: Song Properties#Miscellaneous Flags|Song Properties]]) to switch between OpenMPT’s and other tracker’s behaviour. That way, people do not have to fear that their modules made with older versions of OpenMPT suddenly sound wrong after upgrading, and people who want to listen to their tunes made with another application can also happily listen to them without problems.

== What should I do when composing a track in OpenMPT? ==

That depends on your intentions and goals. When using OpenMPT’s own MPTM format, you do not need to care about compatibility settings. You do not need to enable any compatible playback settings — it does not hurt to do so, but some commands behave in more logical or consistent way when some compatibility settings are disabled.

However, if you are composing IT and XM modules, you most likely want to spread them on the internet and share them with friends. In that case, it is important to set all compatibility settings to their defaults, because many people are using other players (such as XMPlay, Schism Tracker, MilkyTracker or indeed Impulse Tracker and Fasttracker 2), and all of those try to “emulate” Impulse Tracker and Fasttracker 2 as precisely as possible - they do not want to emulate OpenMPT’s own “quirks”. Thus, if you compose a track in those formats, you are absolutely recommended to enable the most compatible playback by clicking the '''Set Defaults''' button in the compatibility section of the [[Manual: Song Properties#Miscellaneous Flags|Song Properties]] dialog - you do not want to get a bad review on your music because it sounds “totally horrible” in XMPlay, just because you forgot to turn on compatible playback, do you?

You should take Impulse Tracker (for IT files) or Fasttracker 2 (for XM files) as a reference when composing your tracks, or at least XMPlay (a very accurate player for both file formats) if you cannot get the original trackers to run. Upcoming OpenMPT updates will bring further improvements to the compatible playback mode, so if something in OpenMPT sounds different from Impulse Tracker / Fasttracker 2, do not hesitate to report it on our [https://bugs.openmpt.org/ Issue Tracker] and it will most likely sound correct in the next version of OpenMPT - when enabling the respective compatibility setting, that is.

It is advised to use [[Manual: Saving and exporting#Compatibility Export|Compatibility Export]] together with this feature.

== Upgrading from an old OpenMPT version ==

When loading a module made with an earlier version of OpenMPT, only the compatibility settings that apply to this old version are enabled; newer settings will not be enabled automatically. This way, playback will be as close as possible to the version the module was last saved with.

If you resume your work on a module made with an earlier version, it is recommended to switch to the default compatibility settings in the Song Properties dialog — as long as your module still sounds identical afterwards, of course. If it does not, you may want to go through all compatibility settings and review what changes they introduce, and if applicable modify the module so that it will also sound correct after enabling these compatibility settings.

== Playback Compatibility Settings ==

[[Image:Playback Compatibility Settings.png|thumb|300px|Playback Compatibility Settings dialog]]

The Playback Compatibility Settings dialog allows you to edit the detailed compatibility settings. Below is a list of all possible compatibility settings that can be toggled in this dialog.

=== Common compatibility settings ===

The following compatibility settings apply to all formats. Some of them may only be visible in legacy modules saved with old OpenMPT versions.

Greyed out checkboxes indicate the emulation of ''really'' old OpenMPT bugs. After disabling those checkboxes, they will remain unavailable.

* '''OpenMPT 1.17 compatible random variation behaviour for instruments''' Random volume and panning variation behaves like in early OpenMPT versions.
* '''Plugin volume MIDI CC bug emulation''' Swaps the controller and parameter byte of the MIDI channel volume CC when choosing “MIDI volume” as an instrument’s volume command handling, effectively breaking the MIDI command.
* '''Old Pitch Wheel behaviour for instrument plugins''' Enables the counterintuitive MIDI pitch wheel behaviour found in earlier OpenMPT versions where sample and plugin portamento did not match.
* '''Execute regular portamento slides at speed 1''' Only fine and extra-fine portamentos are supposed to do something at a speed of one tick per row. This setting is automatically enabled for modules made with very old versions of OpenMPT.
* '''Compute note frequency in Hertz rather than periods''' For best accuracy of high-pitched notes, all note slides etc. are computed in Hertz rather than tracker periods.
* '''Clamp tempo to 32-255 range''' Tempo slides cannot exceed a tempo of 255.
* '''Global volume slide memory is per-channel''' If disabled, there is only one effect memory for global volume slide commands.
* '''Panning commands override surround and random pan variation''' If disabled, surround and random pan variation effects are not interrupted by panning commands.
* '''Note delays next to a row delay are repeated on every row repetition''' Delayed notes that are on the same row as a row delay are retriggered on every row repetition.
* '''Old volume envelope release node scaling behaviour''' This option is only available when importing modules saved with OpenMPT 1.27 or earlier that make use of the volume envelope release node. With this setting enabled, the volume envelope after the release node is added to the volume at release time, while the new behaviour causes this part of the envelope to be relative to the volume at release time.
* '''Reset VST volume on note-off''' Previous versions of OpenMPT sent bogus volume commands or dry / wet ratio settings on plugin note-offs. This setting retains this behaviour.
* '''Send OPL key-off when triggering notes''' Note-off events are sent for OPL instruments also when two notes are played on the same channel without interruption.
* '''Use old imprecise ping-pong loop end calculation''' In previous versions of OpenMPT, the loop length could be noticeably off for very short ping-pong loops and thus cause those samples to be slightly detuned. This setting retains this behaviour.
* '''Assume initial plugin MIDI program and bank number is 1''' In previous versions of OpenMPT, if an instrument was set to use MIDI program 1 or bank 1, this program or bank change was not set to plugins (unless another instrument previously explicitly selected a different program or bank for this plugin). Importing such a legacy module will enable this compatibility setting to restore the old behaviour, otherwise it is not available.
* '''MIDI notes can be sent to channel plugins''' MIDI notes can be sent to channel plugins in addition to instrument plugins. Only available when importing modules made with OpenMPT 1.25 or older.
* '''Report inaccurate PPQ position to VST plugins (like OpenMPT 1.31 and older)''' When importing a module made with OpenMPT 1.31 or older that contains any VST plugins, this setting is enabled automatically to report the song PPQ position to plugins the same incomplete, broken way as those old versions did.
* '''Plugin notes with New Note Action set to Continue are affected by note-offs (like OpenMPT 1.31 and older)''' When importing a module made with OpenMPT 1.31 or older that contains any VST plugins, this setting is enabled automatically to use the same buggy New Note Action behaviour for plugins as found in those old versions.

=== MPTM compatibility settings ===

The following settings address behaviour changes that were made to make the MPTM format more intuitive:

* '''Full control over OPL notes after note-off''' Allows OPL notes to be controlled (volume, panning, pitch, etc.) after the note has been released.
* '''New Note Action / Duplicate Note Action set to Note Off and Note Fade affect OPL notes like samples''' Previously, New Note Action / Duplicate Note Action types Note Off and Note Fade would both simply release OPL notes. With this setting enabled, Note Fade fades the note the same way as with samples, and with Note Off the post-sustain part of the volume envelope is applied as well.
* '''Do not reset OPL channel status at end of envelopes''' This setting is only available in files made with OpenMPT 1.28. It re-enables the old end-of-envelope behaviour that was inconsistent with sample channels.

In addition, all the following compatibility settings for the IT format also apply to MPTM files:

=== IT compatibility settings ===

Impulse Tracker’s playback routine is relatively bug-free and logical.
OpenMPT’s IT playback is already relatively good even with compatible mode being disabled, however some small (and not-so-small) details are not handled correctly. Sometimes they can cause quite drastic differences in playback.

The following compatibility settings are only available in IT and MPTM modules.

* '''Retrigger instrument envelopes on instrument change''' An instrument number with no note next to it plays the new instrument and plays its envelopes from start.
* '''Volume column portamento never does fine portamento''' A fine portamento followed by e00 and f00 is not continued as a fine portamento. Instead, its parameter is treated as if it was a normal portamento.
* '''IT arpeggio algorithm''' Handles arpeggio slightly differently than OpenMPT does by default.
* '''Out-of-range delay commands queue new instrument''' A note next to a delay command that exceeds the current row’s length is not played, but its instrument number will be used for the next note (if it has no instrument number).
* '''Gxx shares memory with Exx and Fxx''' All portamento commands use the same memory.
* '''After finishing a pattern loop, set the pattern loop target to the next row''' A lone SBx effect with no corresponding SB0 will restart its loop one row after the previous loop, if there was one in the same pattern.
* '''Nested pattern loop behaviour''' If there are several pattern loops running concurrently, execute them like IT and FT2 do.
* '''Do not reset ping pong direction with instrument numbers''' An instrument number does not cause a ping-pong loop to change its direction.
* '''IT envelope reset behaviour''' The rules for when to restart envelopes are changed to Impulse Tracker’s WAV writer behaviour.
* '''Forget the previous note after cutting it''' An instrument number after a note cut cannot restart the previously playing note.
* '''More IT-like Vibrato, Tremolo and Panbrello handling''' These effects will use Impulse Tracker’s waveforms and retrigger behaviour.
* '''Ixx behaves like in IT''' Tremor reset and tick counting behaviour is more like in IT.
* '''Qxx behaves like in IT''' Retrigger tick counting is more like in IT.
* '''Properly update C-5 frequency when changing note in multisampled instrument''' When playing a multisampled instrument with no instrument numbers in the pattern, the middle-C frequency is still updated properly.
* '''Clear portamento target after it has been reached''' Once the portamento target has been reached, any subsequent Tone Portamento effects will do nothing.
* '''Do not reset loop count on pattern break''' If a pattern loop is interrupted by a pattern break, the loop count is remembered for subsequent loops.
* '''Offset after sample end is treated like in IT''' With “Old Effects” enabled, the offset is clamped to the sample end (so when there is no sample loop, the note will not sound). Otherwise, the sample plays from start.
* '''Volume and panning random variation work more like in IT''' Among the biggest differences, volume random variation is a percentage of the instrument’s global volume, not of its note volume.
* '''NNA is reset on every note change, not every instrument change''' When using S7x effects to change an instrument’s NNA behaviour, the original value is reset with the next note rather than the next instrument number.
* '''SCx really stops the sample and does not just mute it''' A subsequent volume effect cannot pick up a note that was previously stopped using the SCx command.
* '''IT-style envelope position advance + enable/disable behaviour''' When disabling envelopes, the last value of the envelope keeps being applied.
* '''More compatible instrument change + portamento''' Resets the volume envelope even on notes with Tone Portamento. A sample change during a Tone Portamento with “Compatible Gxx” enabled does not cause the new sample to be played.
* '''Do not repeat last sample point in ping pong loop, like IT’s software mixer''' Not noticeable unless you use ping-pong-looped chip samples. If disabled, OpenMPT sounds more like IT’s Gravis Ultrasound driver.
* '''Use triggered note rather than translated note for PPS and DNA note check''' When modifying the note-to-note mapping of an instrument, the Pitch-Pan-Separation and Duplicate Note Action are based on the note found in the pattern rather than the “translated” note.
* '''SAx does not apply an offset effect to a note next to it''' High Offset commands next to a note do not instantly apply an offset effect, they only affect subsequent Offset commands.
* '''User IT’s filter coefficients (unless extended filter range is used) and behaviour''' Higher resonance than OpenMPT’s original filter implementation, and slightly different rules when to enable and disable filters.
* '''Panning modulation is disabled on surround channels''' Panning random variation, panbrello and panning envelopes are ignored on surround channels, unless OpenMPT’s “Quad Surround” panning mode (S9B command) is enabled.
* '''Do not retrigger already stopped channels''' A sample is not retriggered if it already stopped playing. Unfortunately, this also affects retriggering very short samples (such as Hi-Hats), so it is advised to put a silent loop at the end of such samples if they need to be retriggered.
* '''Do not apply any portamento if no previous note is playing''' Applying Tone Portamento on a channel where a note was previously stopped will not slide from this stopped note to the new note but rather play the new note directly at its target frequency.
* '''Reset note-off on portamento if there is an instrument number in Compatible Gxx mode''' Only reset the “Note Off” status of a note with Tone Portamento if “Compatible Gxx” is enabled.
* '''Volume column effects share their memory with the effect column''' Volume slides in the volume column have no own effect memory but share it with their effect column counterparts. This setting also ensures that fine volume slides in the volume column are only applied on the very first tick of a row, and not on multiples of the first tick if there is a Pattern Delay command.
* '''Portamento with sample swap plays the new sample from the beginning''' When swapping samples during a Tone Portamento, they are played from the start rather than being continued at the play position of the old sample.
* '''Ignore instrument note map entries with no note completely''' When triggering a note that is mapped to nothing at all in an instrument’s sample map, it should not even trigger New Note Actions and such.
* '''IT-style first tick handling''' If there is a note delay, fine volume slides next to it will be executed on the tick that matches the delay rather than the “true” first tick of the row.
* '''IT-style sample&hold panbrello waveform''' Setting the panbrello waveform to “random” will cause the speed parameter of the Panbrello command to hold the current random value for the given number of ticks.
* '''New notes reset portamento target in IT''' A previous portamento target is not remembered after a note change with no Tone Portamento.
* '''Do not reset panbrello effect until next note or panning effect''' After executing Panbrello, its panning offset remains on the following rows until a new note or other panning effect is encountered. If disabled, the panning offset is reset immediately.
* '''Sample and instrument panning is only applied on note change, not instrument change''' An instrument number does not re-apply the sample’s or instrument’s default panning, only a new note does.
* '''Bxx on the same row as SBx terminates the loop in IT''' Pattern loops that also have a Position Jump on the last row are never executed.
* '''Instrument number with note-off recalls default volume''' An instrument number next to a Note-Off note will apply the sample’s default volume.
* '''Lone instrument number after portamento within multi-sampled instrument sets the target sample's settings''' A tone portamento between two notes of the same instrument that are assigned to different samples does not switch to new samples; however, a lone instrument number after such a tone portamento will apply the sample settings (volume and panning) of the target sample while continuing to play the first sample. Additionally, this setting resets the portamento on a stopped note if it is picked up using a lone instrument number.
* '''Broken release node after sustain end behaviour''' From OpenMPT 1.23 to OpenMPT 1.27, a release node past the sustain loop end did not work correctly if the “IT-style envelope position advance + enable/disable behaviour” compatibility setting was enabled as well. If such a module is loaded, this option is enabled automatically. Otherwise, it is not available.
* '''Instrument number with note-off retriggers envelopes with Old Effects enabled'''
* '''Instruments / samples with forced panning do not override channel panning for following instruments / samples''' The panning options of samples and instruments do not override channel panning for any following notes.
* '''Bxx right of SBx terminates the loop in IT''' If a Bxx command is found right of the terminating SBx command of a pattern loop, the pattern loop is never executed.
* '''Duplicate Sample Check requires same instrument, Duplicate Note Check uses pattern notes for comparison''' If an instrument has its duplicate check type set to ''Sample'', then these checks are carried out only if the old and new instrument match. If an instrument has its duplicate check type set to ''Note'', the old and new pattern note are compared, regardless of how they are transposed in the instrument.
* '''Pitch / Pan Separation can be overridden by panning commands''' Rather than applying Pitch / Pan Separation as an offset on top of all other panning, this setting causes it to behave more like an implicit panning command that is overridden if a real panning command is encountered in the pattern data.
* '''Ignore tone portamento for instrument plugins''' If enabled, tone portamento commands do not slide from one instrument plugin note to the next, but instead keep the old note playing while also triggering the new note simultaneously.
* '''Reset filter on portamento if new note plays a different sample''' In sample mode, when doing a tone portmento between two differetn samples, the filter may be deactivated in the same way as it can be deactivated when triggering a new note (i.e. when the previous note was playing with filter cutoff fully open and resonance at 0).
* '''Initial Last Note Memory of each channel is C-0 instead of No Note''' When this setting is active, a lone instrument number with no previous note on the same channel will trigger a C-0 note instead of not doing anything.
* '''Portamento after note-off does not re-enable sample sustain loop''' When using tone portamento after a note-off event, the sample sustain loop is not re-enabled.
* '''Ignore pattern cell completely when trying to play unmapped instrument note''' Any effects in a pattern cell are ignored if that pattern cell contains a note or instrument that points to an unmapped entry in the instrument’s sample map.
* '''Offset command with instrument number recalls offset with last note''' If there is no note, but an instrument number and offset effect, the previous note is used to apply the offset effect to.
* '''Parameters of conflicting volume and effect column portamento commands may overwrite each other''' This setting emulates the strange interactions between different portamento commands when they are encountered in both the volume and effect column at the same time.
* '''Note-Off status does not influence Envelope Carry behaviour''' Previously, instrument envelopes restarted after a note-off even if Envelope Carry was enabled. With this setting enabled, they reset only if there is an instrument number without a note.
* '''Note Cut (SCx) resets note pitch and interacts with tone portamento + row delay'''' This setting enables two quirks: When a lone instrument number picks up a note cancelled by an SCx command, any previous portamento effects are undone and the original note pitch is restored. A combination of SCx with a note and tone portamento also ignores the SCx command, unless there is also a pattern delay effect on the same row.

=== XM compatibility settings ===

Fasttracker 2 has a '''very quirky''' playback routine which makes even common pattern effects (and combinations thereof) behave totally unpredictable.
These idiosyncrasies are not handled very well (or not at all) when compatible playback is disabled, so you are '''absolutely advised''' to use the default compatible playback settings for XM Files.
Many people listen to those files with MilkyTracker and XMPlay, and those two programs emulate Fasttracker 2’s quirks rather well - and so does OpenMPT’s compatible playback mode.

The following compatibility settings are only available in XM modules.

* '''Use smooth Fasttracker 2 volume ramping''' Enables extra smooth sample ramping, like Fasttracker 2 did it. When enabled, percussive instruments (e.g. Bass Drums) will sound very muffled, as most of their attack will be lost.
* '''Reset note-off on portamento if there is an instrument number''' Resets the “Note Off” status of a note with Tone Portamento.
* '''FT2 arpeggio algorithm''' FT2 has a very buggy arpeggio command that, among other things, plays arpeggios backwards (second parameter’s note comes first).
* '''Rxx behaves like in FT2''' The Retrigger command also has very erratic behaviour in FT2, which is emulated by this setting.
* '''Vibrato depth in volume column does not actually execute the vibrato effect''' The uxx command only sets the vibrato speed for subsequent vibrato commands, but does not actually play a vibrato.
* '''Do not play portamento-ed note if no previous note is playing''' If there is no playing note, a new note with a Tone Portamento command next to it will not sound.
* '''FT2-style Kxx handling''' Key Off is another weird command in FT2 and behaves differently with volume commands and instrument numbers next to it.
* '''Volume-column pan slides are finer''' lxx and rxx are as fine as fine panning slides in Impulse Tracker.
* '''Offset past sample end stops the note''' Notes with offset commands beyond the sample length are never triggered.
* '''Do not allow ModPlug extensions to X command''' Only X1x and X2x commands will work, X5x and higher do not.
* '''Retrigger envelopes if there is a note delay with no note''' A note delay with no note next to it will still retrigger instrument envelopes.
* '''Lxx only sets the pan envelope position if the volume envelope's sustain flag is set'''
* '''Portamento with instrument number applies volume settings of new sample, but not the new sample itself'''
* '''No volume column memory''' Volume column slides do not have a parameter memory.
* '''Next pattern starts on the same row as the last E60 command''' After a pattern loop has been executed, the next pattern will start from the row where the loop started rather than from the first row. To avoid this, put a Pattern Break command at the end of the pattern.
* '''Keep processing faded channels for later portamento pickup''' After a channel has been faded out, a Tone Portamento can still pick up this silent note.
* '''Reload sample settings even if a note-off is placed next to an instrument number''' Even an instrument number next to a Note-Off note will apply the sample’s default volume and panning.
* '''Portamento with note delay next to it is ignored''' Tone Portamentos only work on notes with no note delays.
* '''Ignore out-of-range transposed notes''' A note, after applying the sample’s transpose amount, may not leave a certain range of notes. If it does, it is ignored.
* '''Bxx or Dxx on the same row as E6x terminates the loop''' Pattern loops that also have a Position Jump or Pattern Break effect on the last row are never executed.
* '''Portamento target is not reset with new notes''' Applying a Tone Portamento after a new note with no portamento has been triggered will slide back to the last note with portamento.
* '''Sustain point at end of envelope loop stops the loop after release''' If the sustain point is at the loop end and the sustain point has been released, do not loop anymore.
* '''Txx behaves like in FT2''' Tremor is another somewhat idiosyncratic command in FT2.
* '''Do not trigger notes with out-of-range note delay''' If the note delay is greater than the ticks per row (ignoring any pattern delays), it is ignored.
* '''Use FT2's broken period handling''' When sliding a note too deep, it will wrap around at some point and become a very high note.
* '''Panning command with delayed note-off is ignored''' If there is a Note Delay and Note-Off, a panning command next to them is ignored.
* '''FT2-style volume column handling if there is a note delay''' If there is a note delay, volume column effects are ''not'' executed on the first tick and, if there is an instrument number, on the delayed tick.
* '''Round sample finetune to multiples of 8''' FT2 has a finetune ranging from -128 to 127, but a finetune change only be heard at every multiple of 8.
* '''Fade instrument on note-off when there is no volume envelope; instrument numbers reset note-off status.''' Instruments with no instrument envelope are instantly muted when a note-off is encountered. If this note-off is not delayed (i.e. there is no EDx effect next to it), the instrument is also faded out, which is only relevant if a volume effect is encountered after the note-off. Additionally, instrument numbers after a note-off reset the note-off status, so the sustain status of the envelope is reset.
* '''Emulate FT2/ProTracker tremolo ramp down / triangle waveform''' The “ramp down” tremolo waveform (E71) is very buggy and even influenced by vibrato in FT2.
* '''Portamento Up and Down have separate effect memory''' 1xx and 2xx do not share effect memory.
* '''If the sustain point of the panning envelope is reached before key-off, it is never released'''
* '''Delayed instrument-less notes should not recall volume and panning''' From OpenMPT 1.19 to 1.27, notes with a note delay but no instrument number accidentally recalled the sample’s default volume and panning settings, which should only happen if there is an instrument number.
* '''Tone Portamento direction resets after reaching portamento target from below''' After a tone portamento has reached its target note, FT2 will act as if the tone portamento should always decrease the frequency of the note, so if the note’s frequency is decreased (e.g. with 2xx) afterwards and another Tone Portamento effect is encountered, it will directly jump back to the target note.
* '''Ignore tone portamento and fine pitch slides for instrument plugins''' If enabled, tone portamento commands do not slide from one instrument plugin note to the next, but instead keep the old note playing while also triggering the new note simultaneously. Additionally, fine and extra-fine pitch slides are not applied to instrument plugins.
* '''Key-off before auto-vibrato sweep-in is complete resets auto-vibrato depth''' After a note-off / key-off event, sample auto-vibrato only continues to play if it already reached its full depth before the note-off / key-off event.
* '''Offset effect memory is only updated when the command is next to a note''' The effect memory of the Offset command (9xx) is only updated when the command is placed next to a note.

=== S3M compatibility settings ===

The following compatibility settings are only available in S3M modules. They are not saved in S3M files, but OpenMPT tries to guess the most appropriate settings when loading such files.

S3M files made with OpenMPT always use all compatibility settings. However, when loading S3M files made with less compatible trackers (such as Impulse Tracker), compatible playback settings are disabled automatically as required. Re-saving such a file in OpenMPT will re-enable them.

* '''Do not reset panbrello effect until next note or panning effect''' After executing Panbrello, its panning offset remains on the following rows until a new note or other panning effect is encountered. If disabled, the panning offset is reset immediately.
* '''Offset past sample end stops the note''' Notes with offset commands beyond the sample length are never triggered.
* '''Do not process any effects on muted S3M channels''' Any effect commands (even tempo and global volume commands) on muted channels are completely ignored. Many trackers and players still apply these commands on muted channels.
* '''Most effects share the same memory''' Most effects in Scream Tracker 3 share a single effect memory (the only exception being vibrato and tone portamento effects). Many trackers and players implement effect-specific memory instead.
* '''Portamento with instrument number applies volume settings of new sample, but not the new sample itself (GUS)''' The default volume of the sample number next to a Tone Portamento command is applied, but no sample swap happens. This emulates the Gravis Ultrasound driver in Scream Tracker 3. Disable this option to emulate Sound Blaster playback instead.
* '''Do not remember vibrato type in effect memory''' Do not distinguish between vibrato types in effect memory, so that e.g. U1F followed by H00 causes the second effect to play a H1F vibrato. Effectively, this also means that Kxx will never play a fine vibrato.
* '''Stop note when reaching the format's maximum note frequency''' Only available when importing modules made with old ModPlug Tracker versions or BeRoTracker, notes stop playing when their pitch exceeds the S3M frequency limits after a portamento slide. Otherwise, the poratmento slide stops at the frequency limit.
* '''Portamento immediately following an arpeggio effect continues at the last arpeggiated note''' If a portamento up or portamento down effect immediately follows an arpeggio effect, it starts sliding from the last arpeggiated note, and not from the channel frequency as it was before the arpeggio.
* '''Notes without instrument use the previous note's sample offset''' Similarly to the MOD format, this setting causes notes without an instrument number to use the same sample offset as the previous note.
* '''Notes cannot be retriggered after they have been cut''' The Qxy command (with no note next to it) will not retrigger notes after the previous note has been forcefully cut.
* '''Enable on-the-fly sample swapping (SoundBlaster driver)''' The Sound Blaster driver in Scream Tracker 3 supports MOD-like sample swapping by just providing a new sample number without a note. As OpenMPT mostly follows Gravis Ultrasound playback for S3M modules, this setting is disabled by default.
* '''Retrigger effect (Qxy) affects OPL notes''' If disabled, only the note volume is affected by the Qxy effect (like in Scream Tracker 3). Otherwise, OPL notes are restarted like sample notes. This setting is only available for files made with OpenMPT 1.28, which did not use the same retrigger behaviour as Scream Tracker 3.
* '''Apply lower frequency limit''' This stops notes from sliding down lower than Scream Tracker 3 supports.
* '''OPL notes with Tone Portamento are delayed until the next row''' Tone Portamento is not available for OPL notes, instead the new note starts playing on the next row without any portamento.
* '''Ignore combined fine slides (Kxy / Lxy)''' Fine volume slides are not possible with commands K and L, like in Scream Tracker 3.

=== MOD compatibility settings ===

The following compatibility settings are only available in MOD modules. They are not saved in MOD files, but OpenMPT tries to guess the most appropriate settings when loading such files.

* '''VBlank timing''' F20 and above sets speed instead of tempo.
* '''ProTracker one-shot loops''' If (and only if) a sample’s loop starts at 0, the sample is first played in its ''entire'' length. Afterwards, only the loop section of the sample is repeated.
* '''Ignore panning commands''' 8xx and E8x commands will do nothing.
* '''Enable on-the-fly sample swapping''' Instrument numbers with no note next to them cause the playing sample to be exchanged by the newly specified sample. The effect takes place as soon as the currently played sample reaches its loop end.
* '''Emulate FT2/ProTracker tremolo ramp down / triangle waveform''' The “ramp down” tremolo waveform (E71) is very buggy and even influenced by vibrato in ProTracker.
* '''Out-of-range note delay is played on next row''' A note that is played with a note delay greater than the current ticks per row is postponed to the first tick of the next row, unless the next row already plays another note. The postponed note is played with an instant portamento from a previously playing note rather than being played from start.
* '''Tempo changes are handled on second tick instead of first''' F20 and above are only applied after the first tick of the row. At a speed of one tick per row, the change happens on the next row.

=== Miscellaneous compatibility settings ===

The following compatibility settings belong to neither of the aforementioned formats; they may be set when importing files from other formats and are not available otherwise.

* '''Beating OPL oscillators''' Only available when importing C67 files, this option slightly detunes OPL instruments based on the channel they are played on to create a fatter sound.
* '''OPL key-off sets note frequency to 0 Hz''' Only available when importing FMT files, this options sets the note pitch to 0 Hz to cut notes in addition to releasing the note-on flag.
* '''Offset commands work without a note next to them''' Offset commands can change the playback position of the sample without a note next to them. This behaviour is for example supported in the DMF, MDL and PLM formats.
* '''New note without instrument number does not play looped samples from the start''' Looped samples continue to play when a new note has no instrument number next to it, as if there was an instant tone portamento effect.

[[Category:Manual|Compatible Playback]]

Development: Test Cases/IT

2025-06-12T19:39:38Z

Saga Musix: SCx-Reset.it

{{Testsuite Introduction|format=IT|tracker=Impulse Tracker}}

{{Testcase|format=it|name=Autovibrato-Reset.it|pass=???}}
The autovibrato sweep is not reset when using portamento.

{{Testcase|format=it|name=Bidi-Loops.it|pass=793}}
In Impulse Tracker’s software mixer, ping-pong loops are shortened by one sample. This does not happen with the GUS hardware driver, but I assume that the software drivers were more popular due to the limitations of the GUS, so OpenMPT emulates this behaviour.

{{Testcase|format=it|name=BidiPrecision.it|pass=15871}}
An extension to [[#Bidi-Loops.it|Bidi-Loops.it]], this test verifies that the loop length of ping-pong loops is precise. The test is not required to stay absolutely silent, but the two channels may not phase, i.e. the sound should be a static buzz.

{{Testcase|format=it|name=CarryNNA.it|pass=1503 + 22849}}
This is a very interesting test case, because it actually sounds different when using Impulse Tracker’s WAV writer and Sound Blaster (and probably other drivers) output (the Sound Blaster 16 MMX driver also follows the behaviour of the WAV writer, to make things even more confusing).
The main difference is that the Sound Blaster driver will only consider the envelope carry flag if the New Note Action is not “Note Cut”. The WAV writer does not check for the NNA and will always apply the carry flag if it’s set. OpenMPT goes after the WAV writer, while e.g. XMPlay used the Sound Blaster behaviour for the volume and panning envelope, but the WAV writer’s behaviour for the filter envelope (because of a bug report some years ago) up until 2016. Obviously it is hard to consider which of the two behaviours is correct, so I would just say that both are. :) However, the WAV writer behaviour definitely is more useful (not being able to use Envelope Carry despite it being enabled is quite misleading), I strongly encourage everyone to implement this behaviour.

The reason for the difference is most likely that the non-MMX Sound Blaster driver does not volume-ramp cut notes, while the MMX driver and WAV writer do. The volume ramping requires a NNA channel to be set up, which is a precondition for the envelope carry code to work.

{{Testcase|format=it|name=cut-carry.it|pass=1165}}
Envelopes that have the carry flag set cannot be “picked up” / continued after the note has been cut.

{{Testcase|format=it|name=dct_smp_note_test.it|pass=12819}}
Instrument Duplicate Check Type “Sample” should only be carried out if the old and new instrument match (like all other check types). 
Instrument Duplicate Check Type “Note” should compare the old and new pattern note, not translated notes according to the instrument’s mapping. 

{{Testcase|format=it|name=DNA-NoInstr.it|pass=6311}}
OpenMPT previously did not properly check for the correct sample slot or sample map entry in DNA and NNA checks if no instrument number was provided. This testcase should remain silent when played correctly, i.e. both the first and second note on channel 1 should sound until the end of the pattern.

{{Testcase|format=it|name=DoubleSlide.it|pass=21807}}
Impulse Tracker generally initializes effect parameters, effect working memory and similar stuff once per row, before the effects actually run. When using (tone) portamento commands simulatenously in the effect column and volume column, this can lead to surprising results, and in order to emulate them correctly, it is crucial to implement the effect memory initialization in the exact same order as Impulse Tracker does:

# Evaluate effect column Gxx parameter
# Evaluate volume column gx parameter
# Evaluate volume column ex / fx parameter
# Evaluate effect column Exx / Fxx parameter

If played correctly, The left and right channel of this module should sound identical. The last few rows should stay silent.

{{Testcase|format=it|name=DoubleSlideCompatGxx.it|pass=21807}}
A variation of of [[#DoubleSlide.it|DoubleSlide.it]] with the Compatible Gxx flag turned on. The same rules as above apply, but since portamento up / down and tone portamento memory is not linked, there are some natural differences in handling.

{{Testcase|format=it|name=empty_sample_offset.it|pass=6343}}
In instrument mode, if an offset effect is found next to a note that maps to an invalid sample slot, the offset and illegal note should be ignored completely. Note that this behaviour is different from sample mode, where a previously playing sample will be stopped.

{{Testcase|format=it|name=emptyslot.it|pass=1671}}
I think, Impulse Tracker treats instruments like an additional layer of abstraction and first replaces the note and instrument in the pattern by the sample and note assignments from the sample map table before further evaluating the pattern. That would explain why for example the empty sample map slots do nothing in this module.

{{Testcase|format=it|name=env-flt-max.it|pass=1090 (?)}}
If resonance is not applied, the filter envelope’s maximum value does not ''enable'' any filtering. However, it also does not ''disable'' any filtering when returning from a non-maximum point. This pretty much works like Zxx commands.

{{Testcase|format=it|name=EnvLoopEscape.it|pass=4009}}
I created [[#EnvOffLength.it|EnvOffLength.it]] without realizing that it is essentially the same bug as this one.

{{Testcase|format=it|name=EnvLoops.it|pass=1213}}
In this test, all possible combinations of the envelope sustain point and envelope loops are tested, and you can see their behaviour on note-off.
If the sustain point is at the loop end and the sustain loop has been released, don't loop anymore.
Probably the most important thing for this test is that in Impulse Tracker (and Fasttracker 2), envelope position is incremented before the point is evaluated, not afterwards, so when no ticks have been processed yet, the envelope position should be invalid.

{{Testcase|format=it|name=EnvOffLength.it|pass=4009}}
If an envelope sustain loop happens to end on exactly the same tick as a note-off event occurs, the envelope is not yet released. It will be released whenever the loop end is being hit again.

{{Testcase|format=it|name=EnvReset.it|pass=1481}}
Impulse Tracker resets envelopes under some more or less weird conditions. This tests some of them.

{{Testcase|format=it|name=extreme-filter-test-1.it|pass=1090}}
If resonant filters are rendered with integer arithmetic, they may produce scratching noises in some edge cases. You should not hear any scratches or other weird noises when playing this example.

{{Testcase|format=it|name=extreme-filter-test-2.it|pass=1090}}
Same as the above test case. xmp breaks this module’s output even more than older versions of OpenMPT.

{{Testcase|format=it|name=Fade-Porta.it|pass=1144}}
After a note has been stopped in some way (for example through fade-out or note cut), tone portamento effects on the following note are ignored, i.e. there is no portamento from the stopped note to the new note.

{{Testcase|format=it|name=filter-7F.it|pass=1090 (?)}}
A small test case that demonstrates that full cutoff should not enable the filter if no resonance is applied. Resonance is only ever applied if the cutoff is not full or the resonance is not zero.

{{Testcase|format=it|name=FilterEnvReset.it|pass=1132}}
A cutoff value of 0 should not be reset to full cutoff when triggering a note just because the filter envelope is enabled. This bug is probably very specific to OpenMPT, because it gets rid of some unneccessary code.

{{Testcase|format=it|name=FilterPortaSmpChange.it|pass=18417}}
Normally Impulse Tracker does not disable the filter on portamento if cutoff was previously at 127 and resonance at 0, but in sample mode that is not the case when the new note plays a different sample.

{{Testcase|format=it|name=FilterPortaSmpChange-InsMode.it|pass=?}}
Complementary test for [[#FilterPortaSmpChange.it|FilterPortaSmpChange.it]] in instrument mode. Here the cutoff should never be reset on portamento.

{{Testcase|format=it|name=filter-nna.it|pass=1169}}
This test is just there to be sure that the filter-reset.it and filter-reset-carry.it test cases do not break NNA background channels.

{{Testcase|format=it|name=filter-reset.it|pass=1165}}
As mentioned already, filtering is only ever done in IT if either cutoff is not full or if resonance is set. When a Z7F command is found next to a note and no portamento is applied, it ''disables'' the filter, however in other cases this should not happen.

{{Testcase|format=it|name=filter-reset-carry.it|pass=1165}}
I think this is also just an extenion to the previous test case, to make sure that it does not break anything else.

{{Testcase|format=it|name=filter-reset-envelope.it|pass=16016}}
This test checks that the filter is reset correctly for delayed filtered notes, and also acts as a regression test for [[#filter-reset.it|filter-reset.it]], because the first implementation for this test broke the other test. The output should stay silent (small pops are okay).

{{Testcase|format=it|name=FilterResetPatDelay.it|pass=16137}}
An extension of [[#filter-reset-envelope.it|filter-reset-envelope.it]], this verifies the filter reset behaviour on rows with a Pattern Delay. The filter reset logic should only be applied on rows that are actually retriggering the note: If there is no note delay, the note is retriggered only on the first tick. If there is a note delay, the note is retriggered on every repetition of that row (see [[#PatternDelay-NoteDelay.it|PatternDelay-NoteDelay.it]]).

{{Testcase|format=it|name=FineVolColSlide.it|pass=2400}}
Unlike fine volume slides in the effect column, fine volume slides in the volume column are only ever executed on the first tick — not on multiples of the first tick if there is a pattern delay. Thus, the left and right channel of this example should always have the same volume.

{{Testcase|format=it|name=flt-env-carry.it|pass=693 (?)}}
Envelope carry on the filter envelope. I think this is just a general test on how envelope carry is applied. It is possible that Impulse Tracker’s MMX drivers will play this in a different way from the WAV writer.

{{Testcase|format=it|name=fltmacro.it|pass=???}}
This test uses a custom macro configuration that uses the instrument volume to control the filter cutoff. A correctly implemented MIDI Macro system should pass this test.

{{Testcase|format=it|name=freqreset-noins.it|pass=325}}
When using multisample instruments, even notes with no instrument number next to them can change the sample (based on the active instrument’s sample map). When switching between samples, you must not forget to update the C-5 frequency of the playing sample as well.

{{Testcase|format=it|name=GlobalVolFirstTick.it|pass=6362}}
Set Global Volume (Vxx) should be applied on the first tick (and multiples in case of pattern delays). If played correctly, the first and second row of this module should sound more or less identical, i.e. each row should play 16 fading notes.

{{Testcase|format=it|name=globalvol-invalid.it|pass=290}}
Out-of-range global volume commands (V81...VFF) should not change the current global volume. This test module should remain completely silent.

{{Testcase|format=it|name=GlobalVolume-Macro.it}}
Global volume, channel volume and various other parameters are taken into account when interpreting the 'u' and 'v' letters in MIDI macros. However, this feature seems to be quirky, and I have decided not to support these quirks in OpenMPT, as I do not think that anyone used this feature in Impulse Tracker very much and I would want it to work in a sane way when using it to control instrument plugins in OpenMPT. The quirks are:
* Channel and global volume seem to be applied one row after they have been set. This does not seem to be the whole truth, though, as looking at pattern 0, row 9, you should hear that IT applies the M40 channel volume change on row 10.
* Instrument / sample volume also seems to be applied one row late when using the 'u' macro, but not the 'v' macro (compare first and second pattern, row 15 - 22 each).
There are also some problems with volume swing which might be fixed later.

{{Testcase|format=it|name=gxsmp.it|pass=1671}}
Another test case with an empty sample map slot which is simply ignored by Impulse Tracker.

{{Testcase|format=it|name=gxsmp2.it|pass=1671}}
Going one step further by also changing the sample next to that portamento.

{{Testcase|format=it|name=gxxtest.it|pass=4330}}
And another similar test.

{{Testcase|format=it|name=InitialNoteMemory.it|pass=18838}}
The initial "last note" memory of each channel in Impulse Tracker is initialized to C-0. So the first lone instrument number without any note next to it will play a C-0 of that instrument.

{{Testcase|format=it|name=InitialNoteMemoryInstrMode.it|pass=18838}}
A variation of [[#InitialNoteMemory.it|InitialNoteMemory.it]], but in instrument mode. The lowest note of instrument 1 has no sample association, which will also cause subsequent notes without instrument number to not play.

{{Testcase|format=it|name=ins-flt-porta-reset.it|pass=???}}
Instrument filter settings should not be applied if there is a portamento effect.

{{Testcase|format=it|name=ins-oc.it|pass=11293 + 22849}}
Instrument number resets envelope behaviour test with Old Effects enabled, Compatible Gxx enabled: Always reset envelopes.

Note: Some output drivers play the instruments with Envelope Carry enabled differently in Impulse Tracker (see [[#CarryNNA.it|CarryNNA.it]] for an explanation why this happens). A previous version of this test reflected the behaviour of those drivers, but technically for the wrong reason (they relied on a bug / misunderstanding of the Carry feature in OpenMPT). As this OpenMPT bug was fixed, the test case was adjusted to follow the WAV writer / SB16 MMX driver behaviour.

{{Testcase|format=it|name=ins-ox.it|pass=11293 + 22849}}
Instrument number resets envelope behaviour test with Old Effects enabled, Compatible Gxx disabled: Reset envelopes if there is no tone portamento.

Note: Some output drivers play the instruments with Envelope Carry enabled differently in Impulse Tracker (see [[#CarryNNA.it|CarryNNA.it]] for an explanation why this happens). A previous version of this test reflected the behaviour of those drivers, but technically for the wrong reason (they relied on a bug / misunderstanding of the Carry feature in OpenMPT). As this OpenMPT bug was fixed, the test case was adjusted to follow the WAV writer / SB16 MMX driver behaviour.

{{Testcase|format=it|name=ins-xc.it|pass=11293 + 22849}}
Instrument number resets envelope behaviour test with Old Effects disabled, Compatible Gxx enabled: Reset envelopes if there is a tone portamento.

Note: Some output drivers play the instruments with Envelope Carry enabled differently in Impulse Tracker (see [[#CarryNNA.it|CarryNNA.it]] for an explanation why this happens). A previous version of this test reflected the behaviour of those drivers, but technically for the wrong reason (they relied on a bug / misunderstanding of the Carry feature in OpenMPT). As this OpenMPT bug was fixed, the test case was adjusted to follow the WAV writer / SB16 MMX driver behaviour.

{{Testcase|format=it|name=ins-xx.it|pass=0}}
Instrument number resets envelope behaviour test with Old Effects disabled, Compatible Gxx disabled: Never reset envelopes.

{{Testcase|format=it|name=InstrAfterMultisamplePorta.it|pass=7465}}
A lone instrument number should only reset sample properties to those of the corresponding sample in instrument mode. Example:
C#5 01 ... <-- sample 1
C-5 .. g02 <-- sample 2
... 01 ... <-- still sample 1, but with properties of sample 2
In the above example, no sample change happens on the second row. In the third row, sample 1 keeps playing but with the volume and panning properties of sample 2.

{{Testcase|format=it|name=InstrumentNumberChange.it|pass=1902}}
While Impulse Tracker cuts playing samples if it encounters an invalid sample number in sample mode, the same does not happen if we are in instrument mode.

{{Testcase|format=it|name=JxxTicks.it|pass=1537}}
Impulse Tracker’s arpeggio logic is pretty sane compared to some other trackers, but one detail should be kept in mind: Pattern Delays reset the tick counter, but it keeps incrementing with Fine Pattern Delays. The arpeggio sequence thus resets every (ticks per row + fine pattern delay) ticks.

{{Testcase|format=it|name=LinearSlides.it|pass=4330}}
Impulse Tracker internally uses actual frequency values, while Fasttracker 2 still uses exponentially scaled fine Amiga periods. When doing fine slides, errors from using periods instead of frequency can add up very quickly, and thus the two channel's frequency in this test will converge noticeably.

{{Testcase|format=it|name=LoopBreak.it|pass=5413}}
A pattern break (Cxx) on the same row as the end of a pattern loop (SBx) repeats the pattern loop x times and then jumps to the desired row. However, a position jump (Bxx) on the same row as the end of a pattern loop prevents the loop from being executed if it is right of the SBx effect. In this test, the left and right channel of the module should produce the same click patterns.

{{Testcase|format=it|name=LoopStartAfterPatternEnd.it|pass=7791}}
Since the start row of a pattern loop is not reset on pattern transitions, it is possible to use a loop start past the end of the current pattern when using a pattern loop without explicit start command (SB0). In this case, playback should continue in the next pattern. In the example, this happens because the loop start is set to one row after the loop end after properly terminating the loop in pattern 0.

{{Testcase|format=it|name=LxxWith0Portamento-Amiga.it|pass=r22552}}
A strange edge case when using Lxx (Volume Slide + Tone Portamento) while the tone portamento effect memory is 0: The tone portamento comamnd is not initialized properly in this case, causing it always to assume that it's trying to execute a portamento down. If the current note is below the note to which the tone portamento would lead, this causes the note to immediately jump to the target note. If the current note is above the target note, nothing happens.

{{Testcase|format=it|name=LxxWith0Portamento-Linear.it|pass=r22552}}
Same as [[#LxxWith0Portamento-Amiga.it|LxxWith0Portamento-Amiga.it]], but with linear slides. The difference is that when the current note is above the target note, the frequency is decremented by 1 Hz on every tick (linear slides always slide by at least 1 Hz).

{{Testcase|format=it|name=macro-lastnote.it|pass=947 (?)}}
A test of the MIDI macro letter “n”. This letter will always send the MIDI note value of the last triggered note, note cuts and similar “notes” are not considered. This module should remain silent as both channels should receive exactly the same cutoff values.

{{Testcase|format=it|name=MacroExtendedParam.it|pass=16715}}
Even fixed macros (Z80-ZFF) can contain the letter “z”, which inserts the raw command parameter into the macro (i.e. a value in [80, FF[). In this file, macro ZF0 is used to insert byte F0 into the string. This way, two MIDI messages to set both the filter cutoff and resonance to 60h are created, which are the same filter settings as used in instrument 2, so the module should stay silent.

{{Testcase|format=it|name=MultiZxx.it|pass=947 (?)}}
A MIDI macro can contain more than one MIDI message. In this case, the Z90 macro sets both the filter cutoff frequency and resonance, so if only the first MIDI message is considered in this macro, the module will no longer stay silent at row 8.

{{Testcase|format=it|name=NoMap.it|pass=1671}}
Yet another sample map test case. Why are there so many of them? They are all fixed by the same code...

{{Testcase|format=it|name=NoMapEffects.it|pass=20790 + 20820}}
Empty instrument note map slots are truly one of the most mysterious parts of Impulse Tracker’s reply routines. This particular test started out to verify that a currently playing instrument’s envelopes are not reset by sample-less note map slots, but it quickly evolved into a complete nightmare. In this test you see many global effects, and not a single one of them does anything. They do not jump around in the pattern, they do not modify the tempo. Anything in a cell where a sample-less note map slot is hit is ignored completely. This also affects the first row of the module due to [[#InitialNoteMemory.it|InitialNoteMemory.it]] - this mechanism also takes previously triggered notes into account. Only on row 3 it does not apply, because Note Off / Note Cut / Note Fade invalidate the previously triggered note.

All in all, this absolutely crazy test case should play identically on the left and right channel.

{{Testcase|format=it|name=NoSlide.it|pass=???}}
This seems to be just a fancy test of portamento from a stopped note, but in this case an empty sample slot assigned to the same instrument was played before.

{{Testcase|format=it|name=NoteFade-SmpMode.it|pass=317}}
A “note fade” note (any invalid note) should not do anything in sample mode. The sample should not be stopped.

{{Testcase|format=it|name=NoteFade-InsMode.it|pass=317}}
A “note fade” note (any invalid note) should fade out the instrument using its fadeout value.

{{Testcase|format=it|name=noteoff2.it|pass=??? + 5829}}
The sample changes on rows 4 and 20, but not on rows 8 and 24. However, the new sample′s default volume is loaded.

{{Testcase|format=it|name=noteoff3.it|pass=12284}}
This is the same as noteoff2.it, but with old effects enabled. In this case, the sample should never fade out.

{{Testcase|format=it|name=NoteOffInstr.it|pass=5829}}
Any kind of Note Cut (SCx or ^^^) should stop the sample and not set its volume to 0. A subsequent volume command cannot continue the sample, but a note, even without an instrument number can do so. When played back correctly, the module should stay silent.

{{Testcase|format=it|name=Off-Porta.it|pass=1344}}
When "Compatible Gxx" is disabled, the key-off flag should only be removed when triggering new notes, but not when continuing a note using a portamento command.

{{Testcase|format=it|name=Off-Porta-CompatGxx.it|pass=0 (temporarily broken in rev. 1344)}}
When "Compatible Gxx" is enabled, the key-off flag should also be removed when continuing a note using a portamento command (row 2, 4, 6). This test case was written to discover a code regression when fixing [[#Off-Porta.it|Off-Porta.it]]).

{{Testcase|format=it|name=OffsetWithInstr.it|pass=20863}}
An offset effect can be triggered if only an instrument number and no note is next to it, if the last triggered note was not a note cut, note off or note fade.

{{Testcase|format=it|name=PanbrelloHold.it|pass=4712}}
The panbrello offset should not only be added on the same row as the panbrello effect appears on, but also on all follow-up rows, until a panning command or a new note is encountered. This test case should remain mostly silent.

{{Testcase|format=it|name=PanReset.it|pass=4713}}
Contrary to XM, the default instrument and sample panning should only be reset when a '''note''' is encountered, not when an '''instrument number''' (without note) is encountered. The two channels of this module should be panned identically.

{{Testcase|format=it|name=PanResetInstr.it|pass=11856}}
Instruments and samples with a defined panning should not override the channel panning for following notes. That is, if a different instrument with no panning set follows an instrument that has panning set, the first instrument’s panning should not be applied to the second instrument, but rather the channel panning as it was set before playing the first instrument (or if the channel panning was changed while that instrument was playing, the new channel panning applies as well).
If played correctly, this test case should remain silent.

{{Testcase|format=it|name=PatternDelay-NoteDelay.it|pass=1240}}
Delayed notes (using SDx) that are on the same row as a Row Delay effect are retriggered on every repetition. Notes ''without'' a note delay are ''not'' retriggered.

{{Testcase|format=it|name=PatternDelays.it|pass=1224}}
Tick delays (S6x) are added up, but when there are multiple row delays (SEx), only the first one is considered. The tricky part here is that Impulse Tracker even ignores all row delays next to a SE0 row delay. I suggest to do the following:
* Initialize a <tt>row delay</tt> variable with <tt>0</tt>.
* Go through all channels. If there is a row delay on the current row and <tt>row delay</tt> is 0, set <tt>row delay = parameter + 1</tt>.
* Calculate the complete row length: <tt>row length = (speed + tick delay) * max(1, row delay)</tt>

{{Testcase|format=it|name=PatternDelaysRetrig.it|pass=1221}}
Rows on which a row delay (SEx) effect is placed have multiple “first ticks”, i.e. you should set your “first tick flag” on every tick that is a multiple of <tt>speed + tick delay</tt>. In this test module, the note pitch is changed multiple times per row, depending on the row and tick delay values.
 Note: This test case broke in r3520 and was fixed again in r4895.

{{Testcase|format=it|name=PitchPanReset.it|pass=15870}}
Pitch/Pan Separation can be overriden by panning commands, and should not be affected by Note Off or Note Fade notes.

{{Testcase|format=it|name=PortaCutCompat.it|pass=9139}}
A follow-up test to [[#PortaSampleCompat.it|PortaSampleCompat.it]] and [[#PortaInsNumCompat.it|PortaInsNumCompat.it]] to verify that the behaviour described in these tests is not used when currently no note is playing. Both channels should sound identical.

{{Testcase|format=it|name=PortaInsNum.it|pass=1671}}
Portamento with funny sample maps. Without compatible Gxx, portamento between different samples should play the new sample.

{{Testcase|format=it|name=PortaInsNumCompat.it|pass=2842}}
Portamento with funny sample maps, in compatible Gxx mode. With compatible Gxx, portamento between different samples should keep playing the old sample.

{{Testcase|format=it|name=PortaJustStoppedNote.it|pass=6193}}
[[#Fade-Porta.it|Fade-Porta.it]] already tests the general case of portamento picking up a stopped note (portamento should just be ignored in this case), but there is an edge case when the note just stopped on the previous tick. In this case, OpenMPT did previously behave differently and still execute the portamento effect.

{{Testcase|format=it|name=porta-offset.it|pass=0}}
Unlike Fasttracker 2, Impulse Tracker does not ignore offset commands next to portamentos and executes them both. Even ModPlug Tracker 1.16 gets this test right.

{{Testcase|format=it|name=PortaReset.it|pass=4181}}
Impulse Tracker completely resets the tone portamento target on every new non-portamento note, i.e. a follow-up Gxx effect should not slide back to the previously triggered note.

{{Testcase|format=it|name=PortaResetAfterRetrigger.it|pass=7465}}
After a note has stopped playing, a lone instrument number can restart the note. In this case, portamento and other properties should be reset.

{{Testcase|format=it|name=PortaSample.it|pass=1671}}
Impulse Tracker executes the portamento when switching to instrument two on the second row when compatible Gxx is disabled.

{{Testcase|format=it|name=PortaSampleCompat.it|pass=2842}}
Impulse Tracker executes the portamento and doesn't switch to the new sample on the second row when compatible Gxx is enabled.

{{Testcase|format=it|name=RandomPan.it|pass=2545}}
Pan swing should not be overridden by effects such as instrument panning or panning envelopes. Previously, pan swing was overridden in OpenMPT if the instrument also had a panning envelope. In this file, pan swing should be applied to every note.

{{Testcase|format=it|name=RandomWaveform.it|pass=3670}}
When selecting the random waveform for panbrello, the “speed” nibble indicates for how many ticks the random value will be held. This behaviour is ''not'' used for vibrato / tremolo.

{{Testcase|format=it|name=ResetEnvNoteOffOldFx.it|pass=11276 - 11283}}
In Old Effects mode, an instrument number next to a note-off does not just recall the default volume and panning, but also resets the envelopes.

If the instrument is different from the currently playing instrument, the new instrument's envelope and default sample settings (default volume, panning, but not global volume) are loaded, but the old sample waveform keeps playing.

When played correctly, the left and right audio channel should sound identical. On the last note, the tracker channels swap their stereo position.

{{Testcase|format=it|name=ResetEnvNoteOffOldFx2.it|pass=11284}}
An extension of ResetEnvNoteOffOldFx.it which also tests instrument note-off and sample sustain loop behaviour: While the sample sustain loop should be released, the instrument should not be faded out.

{{Testcase|format=it|name=retrig.it|pass=364}}
A combination of the retrigger effect and instrument envelopes. Not sure how this works.

{{Testcase|format=it|name=retrig-short.it|pass=1140}}
Impulse Tracker does not retrigger notes that are shorter than the duration of a tick. One might argue that this is a bug in Impulse Tracker, but OpenMPT emulates it anyway.

{{Testcase|format=it|name=s7xinsnum.it|pass=1062}}
Changing the NNA action through the S7x command only affects the current note - The NNA action is reset on every ''note change'', and not on every ''instrument change''.

{{Testcase|format=it|name=s77.it|pass=561 (preliminary), 1112}}
The S77 / S79 / S7B commands pause the instrument envelopes, they do not turn them off. S78 / S7A / S7C should resume the envelope at exactly the position where it was paused. In this test, it is again very important that the envelope position is incremented ''before'' the point is evaluated, not ''afterwards'' (see [[#EnvLoops.it|EnvLoops.it]]).

{{Testcase|format=it|name=SampleNumberChange.it|pass=0}}
Contrary to [[#InstrumentNumberChange.it|InstrumentNumberChange.it]], even ModPlug Tracker 1.16 passes it.

{{Testcase|format=it|name=SampleSustainAfterPorta.it|pass=20760}}
When a sample’s sustain loop was released, and a new note from a different sample is played with tone portamento applied, the second sample’s sustain loop also stays released.

{{Testcase|format=it|name=SampleSustainAfterPortaCompatGxx.it|pass=20760}}
Same as [[#SampleSustainAfterPorta.it|SampleSustainAfterPorta.it]], but with Compatible Gxx turned on.

{{Testcase|format=it|name=SampleSustainAfterPortaInstrMode.it|pass=20760}}
Same as [[#SampleSustainAfterPorta.it|SampleSustainAfterPorta.it]], but in instrument mode. Here a difference in the behaviour can be observed when doing a second switch after the initial note-off: The first time, the sustain loop remains disabled, but for the subsequent note, the sustain loop is used again. This does not happen in sample mode.

{{Testcase|format=it|name=sbx-priority.it|pass=12171}}
This is an extension of [[#LoopBreak.it|LoopBreak.it]]. A position jump (Bxx) on the same row as the end of a pattern loop prevents the loop from being executed if it is right of the SBx effect, but if the position jump is left of the SBx effect, the loop should be prioritized. In this test, the left and right channel of the module should produce the same beep patterns.

{{Testcase|format=it|name=scx.it|pass=1109}}
The SCx command cuts notes just like a normal note cut (^^^), it does not simply mute them. However, there is a difference when placing a lone instrument number after a note that was cut with SCx and one cut with ^^^, as it can be seen in this test case.

{{Testcase|format=it|name=SCx-Reset.it|pass=23476}}
When a lone instrument number after a SCx command picks up the previous note, it resets its pitch to the original note, undoing any portamento effects - the same as if there was a note next to the instrument number.

If there is a note and a tone portamento next to an SCx command, the Note Cut is not executed - unless there is also a row delay effect and we are on the second repetition of the row.

When played correctly, this test should remain silent.

{{Testcase|format=it|name=SlideDelay.it|pass=3520}}
If there's a note delay, slide and vibrato commands in the volume column next to it should not start before the delay has finished.
So if there's a fine volume slide next to a SD5 effect should start on the 6th (one-based) tick. If this was a normal volume or pitch slide and the speed was 6 ticks per row, it would never execute, as the first non-zero tick would be the seventh tick.

{{Testcase|format=it|name=SmpInsPanSurround.it|pass=1259}}
Sample and instrument panning override the channel surround status, i.e. surround is turned off by samples or instruments with panning enabled.

{{Testcase|format=it|name=surround-pan.it|pass=1134}}
Pan swing, panbrello, panning envelopes, etc. should have no effect on surround channels.

{{Testcase|format=it|name=StoppedInstrSwap.it|pass=5829}}
An instrument number with no note or next to a ^^^ should always be remembered for the next instrument-less note, even if sample playback is stopped.

{{Testcase|format=it|name=SusAfterLoop.it|pass=1085}}
When a sample sustain loop, which is placed partly or completely behind a “normal” sample loop is exited (through a note-off event), and the current sample playback position is past the normal loop’s end, it is adjusted to <tt>loop start + ((current position - loop start) % loop length)</tt>.

{{Testcase|format=it|name=SwapNNA.it|pass=10239}}
Related to [[#s7xinsnum.it|s7xinsnum.it]], the NNA action should be reset when doing an instrument swap with portamento.

{{Testcase|format=it|name=swaptest.it|pass=???}}
A test focussing on finding the correct sample playback position when switching samples “on the fly” (using instrument numbers without notes next to them). The module should remain silent when being played.

{{Testcase|format=it|name=swing1.it|pass=1046 (?)}}
Probably a very MPT-specific bug, as OpenMPT was adding the volume swing to the current volume, so even after setting the volume to 0, it was possible that you could hear the sample playing.

{{Testcase|format=it|name=swing2.it|pass=1046 (?)}}
This module should remain completely silent, as the random variation is multiplied with the sample volume.

{{Testcase|format=it|name=swing3.it|pass=1046 (?)}}
Of course you are not supposed to produce the same sequence of random number to fulfil this test case. I think this was just a test to explore which volume variables are actually affected by volume swing, and how it is applied.

{{Testcase|format=it|name=swing4.it|pass=1046 (?)}}
Same as above.

{{Testcase|format=it|name=swing5.it|pass=1046 (?)}}
Same as above.

{{Testcase|format=it|name=tickdelay.it|pass=4948}}
This test detects whether out-of-range note delays are handled properly. If the SDx parameter is greater than the row length (''including'' tick delay, but ''excluding'' row delay), any note and volume effects next to it are supposed to ignored (interestingly, the instrument number is saved, but not instantly used). The first two rows test tick delay behaviour (OpenMPT passes this test since revision 1306), the third row tests row delay behaviour.

{{Testcase|format=it|name=tremolo.it|pass=345 (?)}}
A test for checking if tremolo tables are implemented correctly.

{{Testcase|format=it|name=vibrato.it|pass=1189}}
A test for checking if vibrato tables are implemented correctly when old FX are disabled.

{{Testcase|format=it|name=VibratoDouble.it|pass=7804}}
Vibrato in the volume column should be applied separately from vibrato in the effect column. The two commands will add up when occuring at the same time. However, since there is only one vibrato effect memory for both commands, the volume column’s vibrato parameter has precedence if it is not 0.

{{Testcase|format=it|name=vibrato-oldfx.it|pass=1189}}
A test for checking if vibrato tables are implemented correctly when old FX are enabled. Vibrato is played backwards in this mode!

{{Testcase|format=it|name=VibratoSweep0.it|pass=7134}}
Auto-vibrato should not be processed at all if the rate (speed) is 0. This is relevant for vibrato waveforms that do not start at zero, i.e. all except sine.

{{Testcase|format=it|name=VolColMemory.it|pass=1545}}
Volume column commands a, b, c and d (volume slide) share one effect memory, but it should not be shared with Dxy in the effect column. Furthermore, there is '''no''' unified effect memory across different kinds of volume column effects (that's how OpenMPT used to handle it up to revision 1544).

{{Testcase|format=it|name=vol-env-carry.it|pass=1781}}
Similar to flt-env-carry.it. This test case temporarily broke in revision 1481 and was fixed in revision 1781.

{{Testcase|format=it|name=Volume-Macro-Letters.it|pass=1465}}
This test demonstrates how Zxx macros are parsed in Impulse Tracker:
* Macros are evaluated only on the first tick.
* They appear to be parsed after note / instrument information has been read from the pattern, but before any other effects (excluding "Set Volume").
* 'u' and 'v' macros seem to emit at least a value of 1, not 0 - v00 corresponds to Z01.
I am not quite sure why the first row with notes on it emits a filter value of 1, and I am not even completely sure why OpenMPT gets this right.
If interpreted correctly, the module should stay silent (minus slight filter artefacts, of course - but they should be nearly inaudible).

{{Testcase|format=it|name=weirdloop.it|pass=0}}
A nice broken pattern loop. The voice should say “1 4 2 1 4 2” and then repeat forever “3 4 2”. Theoretically, this would even work in ModPlug Tracker 1.16, if it did not reset the Cxx target on song loop.

{{Testcase|format=it|name=ZxxSecrets.it|pass=9855}}
Impulse Tracker supports three MIDI macro characters which are not documented in MIDI.TXT:
* <tt>h</tt>: Host channel, i.e. the pattern channel in which the Zxx command is encountered (0-based).
* <tt>o</tt>: The last used sample offset value. The high offset (SAx) is not taken into account. Note that offsets above 80h are not clamped, i.e. they generate MIDI command bytes (e.g. O90 would cause a note-on command to be emitted).
* <tt>m</tt>: This command sends the current MIDI note if the channel is a MIDI channel, but on sample channels the current loop direction (forward = 0, backward = 1) of the sample is stored in the same memory location, so the macro evaluates to that instead of a note number.

In addition, the MIDI messages FA (start song), FC (stop song) and FF (reset) reset the resonant filter parameters (cutoff = 127, resonance = 0) for all channels, but do not immediately update the filter coefficients.

{{Testcase Summary}}

[[Category:Development|Test Cases/IT]]
[[Category:IT Format|Test Cases]]

Manual: Keyboard Actions

2025-06-07T13:42:58Z

Saga Musix: /* Global Keys */

This is a list of all customisable keyboard actions in OpenMPT. They can be configured in the [[Manual: Setup/Keyboard|Keyboard Setup dialog]].

Default key combinations listed in the tables below assume a US keyboard layout. Generally, alphanumeric keys in shortcuts will stay the same in other keyboard layouts (so <kbd>Ctrl</kbd>+<kbd>Z</kbd> does not turn into <kbd>Ctrl</kbd>+<kbd>Y</kbd> on a German layout), with the exception of note entry keys, which are set up based on their position on the keyboard instead (so on a French keyboard, <kbd>A</kbd>, <kbd>Q</kbd> and <kbd>W</kbd> are used for playing a C across three octaves even though the table below says <kbd>Q</kbd>, <kbd>A</kbd> and <kbd>Z</kbd>). Non-alphanumeric keys generally vary a lot between keyboard layouts, so there might not be a direct mapping to your keyboard layout — the key might have a completely different label or not exist at all. You can always review the ''actual'' key combinations used by OpenMPT on your setup by reviewing them in the Keyboard setup dialog.

'''Note''': Keyboard shortcuts that clash with the default text editing shortcuts of the operating system (e.g. <kbd>Ctrl</kbd>+<kbd>C</kbd>, <kbd>Ctrl</kbd>+<kbd>Z</kbd>, etc.) are ignored when the input focus is within a text field.

== Global Keys ==

Global keyboard shortcuts work on most parts of OpenMPT as long as one of the program’s windows is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| File/New || <kbd>Ctrl</kbd>+<kbd>N</kbd> || Creates a new song. The currently edited song is not closed, as OpenMPT can have multiple documents open at the same time.
|-
| File/Open || <kbd>Ctrl</kbd>+<kbd>O</kbd> || Opens one or more existing songs.
|-
| File/Append Module || || [[Manual: Module Merging|Appends]] (merges) the song data (samples, instruments, plugins, patterns and sequences) of one or more existing songs to the currently active song.
|-
| File/Close || <kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes the current song. You are prompted to save the song if it has been modified.
|-
| File/Close All || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>W</kbd> || Closes all open songs. You are prompted to save modified songs.
|-
| File/Save || <kbd>Ctrl</kbd>+<kbd>S</kbd> || Saves the song to disk.
|-
| File/Save As || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>S</kbd> || Allows you to save the file with a new name or in another folder.
|-
| File/Save Copy || || Allows you to save a copy of the file. The next Save action will update the file at its original location again.
|-
| File/Save As Template || || Creates a template from the current song.
|-
| File/Open Template || || Opens a file picker in the template module folder.
|-
| File/Stream Export || || Exports the current track into a lossless or lossy [[Manual: Saving and exporting#Stream Export|streaming file]].
|-
| File/Export as MIDI || || Exports the current track into the .mid format. See the section on [[Manual: Saving and exporting#MIDI Export|MIDI export]] for a detailed explanation of how this file is exported.
|-
| File/Export OPL Register Dump || || Exports the current track into one of several OPL register dump formats. See the section on [[Manual: Saving and exporting#OPL Export|OPL export]] for a detailed explanation of how this file is exported.
|-
| File/Compatibility Export || || Exports the current track without any [[Manual: Saving and exporting#Compatibility Export|file format hacks]] to its original format.
|-
| File/Import MIDI Library || || Imports the MIDI Instrument Library of your choosing. The MIDI Library can be accessed from the [[Manual: Tree View#MIDI Library|Tree View]].
|-
| File/Add Sound Bank || || Imports a sound bank of your choosing. Sound banks can be accessed from the [[Manual: Tree View#Sound Banks|Tree View]].
|-
| Previous Document || || Goes to the previous module file that is open (these are visible in the Windows Menu).
|-
| Next Document || || Goes to the next module file that is open (these are visible in the Windows Menu).
|-
| Play Song / Pause Song || <kbd>F5</kbd> || Toggles the playback of the current track. The playback cursor is not reset when using this toggle; that is, it plays from where the cursor left off when it was last pressed.
|-
| Play Song / Stop Song || || Toggles the playback of the current track. The playback cursor is reset to the start of the song.
|-
| Pause Song || <kbd>F8</kbd> || Only stops the playback of the current track but does not reset the playback pointer.
|-
| Stop Song || <kbd>Escape</kbd> || Stops the playback of the current track and resets the playback cursor to the start of the song.
|-
| Play Song from Start || <kbd>F6</kbd> || Resets the playback cursor to the very first row and begins playback from there.
|-
| Play Song from Cursor / Pause || || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there if playback is currently stopped, otherwise it pauses playback. Playback will continue until the end of the track.
|-
| Play Song from Cursor || <kbd>Ctrl</kbd>+<kbd>F6</kbd> || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there. Playback will continue until the end of the track.
|-
| Play Song from Pattern Start / Pause || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there if playback is currently stopped, otherwise it pauses playback.
|-
| Play Song from Pattern Start || || Resets the playback cursor to the first row of the currently edited pattern and begins playback from there.
|-
| Play Pattern from Start || <kbd>F7</kbd> || Loops the current pattern, starting at the first row of the pattern.
|-
| Play Pattern from Cursor || <kbd>Ctrl</kbd>+<kbd>F7</kbd> || Loops the current pattern, starting at the row where the editing cursor is currently placed.
|-
| Toggle Loop Song || || Enables or disables the song loop status.
|-
| Panic || || Stops all sample, OPL and plugin instrument voices.
|-
| Estimate Song Length || || Estimates the playback length of the entire track.
|-
| Show Approx. Real BPM || || Estimates the beats per minute of the song, based on the current tempo and the number of ticks per row, plus the Tempo Mode in the Song Properties dialog.
|-
| Toggle MIDI Record || <kbd>F9</kbd> || Toggles the MIDI Record option.
|-
| Increase Tempo || || Increases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo || || Decreases the tempo of the currently playing module by 1 BPM. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Tempo (Fine) || || Increases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Decrease Tempo (Fine) || || Decreases the tempo of the currently playing module by 0.1 BPM if the module format supports fractional tempos. This does not modify the initial tempo setting of the song, just current playback and can be overridden by tempo pattern commands.
|-
| Increase Ticks per Row || || Increases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Decrease Ticks per Row || || Decreases the speed of the currently playing module by 1 tick per row. This does not modify the initial Ticks per Row setting of the song, just current playback and can be overridden by speed pattern commands.
|-
| Undo || <kbd>Ctrl</kbd>+<kbd>Z</kbd> || Rescinds the last edit in the pattern or sample editor.
|-
| Redo || <kbd>Ctrl</kbd>+<kbd>Y</kbd>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Z</kbd> || Reapplies the last undone action.
|-
| Cut || <kbd>Ctrl</kbd>+<kbd>X</kbd> || Copies the selected pattern, sample or instrument data into the clipboard, then removes it from the selection it occupies.
|-
| Copy || <kbd>Ctrl</kbd>+<kbd>C</kbd> || Copies the selected pattern, sample or instrument data into the clipboard.
|-
| Paste || <kbd>Ctrl</kbd>+<kbd>V</kbd>, <kbd>Shift</kbd>+<kbd>Insert</kbd> || Pastes data from the clipboard. In the pattern editor, it is pasted at the location of the cursor, overwriting any pattern data that falls within the paste area. With sample data, clipboard contents replace the '''whole''' sample.
|-
| Mix Paste || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>V</kbd> || Mixes clipboard contents with existing data. In the pattern editor, clipboard contents are pasted in the same row at the same column of the current (visible) pattern where the cursor is located, except where there is already any data in any corresponding field of the paste area. In the sample editor, the source and clipboard sample waveforms are mixed together.
|-
| Mix Paste (IT Style) || || For detailed differences between Mix Paste and Mix Paste (IT Style), consult the [[Manual: Patterns#Paste Modes|Pattern Editor help]]. The two commands are identical when used in the sample editor.
|-
| Paste Flood || <kbd>Shift</kbd>+<kbd>V</kbd> || Clipboard contents are pasted from the cursor, repeating the data paste until every row in the pattern has been filled and pasting over any data in its path.
|-
| Push Forward Paste (Insert) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>V</kbd> || Patterns: Clipboard contents are inserted at the row of the cursor, and pushing all data below that row further down the pattern. Any data of the affected channels pushed beyond the pattern’s last row is deleted. Samples: The sample data from the clipboard replaces the current selection. If there is no selection, the sample is inserted at the last selected position.
|-
| Select All || <kbd>Ctrl</kbd>+<kbd>5</kbd> || Selects all pattern or sample data.
|-
| Find / Replace || <kbd>Ctrl</kbd>+<kbd>F</kbd> || Opens the Find/Replace dialog, which allows you to search for and/or replace given pattern data. Find starts from the cursor location.
|-
| Find Next || <kbd>F3</kbd> || Applies the current Find settings and searches for the next data that matches it, starting from the current cursor location.
|-
| View General || <kbd>Alt</kbd>+<kbd>G</kbd> || Opens the [[Manual: General|General Tab]] of the currently focussed module.
|-
| View Pattern || <kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Patterns|Pattern Tab]].
|-
| View Samples || <kbd>Alt</kbd>+<kbd>S</kbd> || Opens the [[Manual: Samples|Sample Tab]].
|-
| View Instruments || <kbd>Alt</kbd>+<kbd>N</kbd> || Opens the [[Manual: Instruments|Instrument Tab]].
|-
| View Comments || <kbd>Alt</kbd>+<kbd>C</kbd>, <kbd>Shift</kbd>+<kbd>F9</kbd> || Opens the [[Manual: Comments|Comments Tab]].
|-
| Toggle Main Toolbar || || Shows / hides the [[Manual: Main Toolbar|Main Toolbar]].
|-
| Toggle Tree View || <kbd>Ctrl</kbd>+<kbd>F2</kbd> || Shows / hides the [[Manual: Tree View|Tree View]].
|-
| View Options || <kbd>Ctrl</kbd>+<kbd>F1</kbd> || Opens the [[Manual: Setup|Setup dialog]].
|-
| View Channel Manager || || Opens the [[Manual: Channel Manager|Channel Manager]].
|-
| View Plugin Manager || || Opens the [[Manual: Plugin Manager|Plugin Manager dialog]].
|-
| View Song Properties || || Opens the [[Manual: Song Properties|Song Properties dialog]].
|-
| View Global Tempo Swing Settings || || Opens the [[Manual: Tempo Swing Settings|Tempo Swing Settings dialog]] for the song’s global time signature. If modern tempo mode is not enabled yet, the [[Manual: Song Properties|Song Properties dialog]] is opened instead so that it can be enabled.
|-
| View Zxx Macro Configuration || || Opens the [[Manual: Macro Configuration|MIDI Macro Configuration]] dialog.
|-
| View MIDI Mapping || <kbd>Ctrl</kbd>+<kbd>F3</kbd> || Opens the [[Manual: MIDI Mapping|MIDI Mapping dialog]].
|-
| View Edit History || || Opens the [[Manual: Edit History|Edit History]].
|-
| Toggle Between Upper / Lower View || || Switches keyboard focus between the upper and lower half of the currently focussed song view.
|-
| Switch to Instrument Library || <kbd>Alt</kbd>+<kbd>I</kbd> || Sets keyboard focus to the [[Manual: Tree View|Instrument Library]], or switches back to the last used editor window if the tree view already has focus.
|-
| Help || <kbd>F1</kbd> || Opens the manual.
|-
| Open Context Menu || <kbd>▤ Application</kbd>, <kbd>Shift</kbd>+<kbd>F10</kbd> || Opens the context menu for the currently selected item.
|-
| Previous Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad/</kbd>, <kbd>Ctrl</kbd>+<kbd>Up</kbd> || Changes the current instrument to the previous one. In the sample editor, the previous sample is chosen.
|-
| Next Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad*</kbd>, <kbd>Ctrl</kbd>+<kbd>Down</kbd> || Changes the current instrument to the next one. In the sample editor, the next sample is chosen.
|-
| Previous Octave || <kbd>Numpad/</kbd> || Changes the current octave to the next lower octave.
|-
| Next Octave || <kbd>Numpad*</kbd> || Changes the current octave to the next higher octave.
|-
| Previous Order || <kbd>Ctrl</kbd>+<kbd>Left</kbd> || Changes the current pattern to the previous one in the pattern order.
|-
| Next Order || <kbd>Ctrl</kbd>+<kbd>Right</kbd> || Changes the current pattern to the next one in the pattern order.
|-
| Previous Order (Transition at end of current measure) || || Changes the current pattern to the previous one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current measure) || || Changes the current pattern to the next one in the pattern order once the current measure has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current beat) || || Changes the current pattern to the previous one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current beat) || || Changes the current pattern to the next one in the pattern order once the current beat has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Previous Order (Transition at end of current row) || || Changes the current pattern to the previous one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Previous Order”.
|-
| Next Order (Transition at end of current row) || || Changes the current pattern to the next one in the pattern order once the current row has finished playing. The new pattern continues playing at the same position. If playback is paused, this shortcut is identical to “Next Order”.
|-
| Dummy Shortcut || || Some keyboard shortcuts are created automatically by OpenMPT (e.g. the combinations of pressing the selection key together with navigation keys). If you need to prevent OpenMPT from automatically assigning a specific key combination, you can assign it to this dummy shortcut instead, so it will not be usable by automatically generated shortcuts. This will also prevent the key combination from being used by new default key combinations added by future OpenMPT updates.
|-
|}

== Pattern ==

=== Order List ===

These keyboard shortcuts operate while the cursor focus is in the Order List.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Delete Order || <kbd>Delete</kbd> || Erases the currently selected pattern(s) in the Order List (the pattern itself is not removed, only the reference).
|-
| Insert Order || <kbd>Insert</kbd> || Duplicates the currently selected pattern ''reference''(s) in the Order List.
|-
| Insert Separator || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Inserts a separator item (+++) at the next position.
|-
| Copy Orders || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Copies the currently selected pattern ''references'' in the Order List to the clipboard.
|-
| Edit Pattern || <kbd>Enter</kbd> || Resets the Pattern Editor to show the highlighted pattern.
|-
| Switch to Pattern Editor || <kbd>Tab</kbd> || Moves the cursor focus to the Pattern Editor. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Previous Order || <kbd>Left</kbd>, <kbd>Up</kbd> || Selects the previous pattern in the Order List.
|-
| Next Order || <kbd>Right</kbd>, <kbd>Down</kbd> || Selects the following pattern in the Order List.
|-
| First Order || <kbd>Home</kbd> || Selects the first pattern in the Order List.
|-
| Last Order || <kbd>End</kbd> || Selects the final pattern in the Order List.
|-
| Pattern Index Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the respective numeral into the pattern ID box.
|-
| Increase Pattern Index || <kbd>=</kbd>, <kbd>Numpad+</kbd> || Adds one to the pattern number, up to the highest indexed pattern.
|-
| Decrease Pattern Index || <kbd>-</kbd>, <kbd>Numpad-</kbd> || Subtracts one from the pattern number, to a minimum of index 0.
|-
| Separator Index || <kbd>I</kbd> || Adds a separator pattern item (+++) at the current position.
|-
| Stop Index || <kbd>Space</kbd> || Adds a stop pattern item (---) at the current position.
|-
| Lock Playback to Selection || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Song playback is locked to the patterns in the current order selection.
|-
| Unlock Playback || <kbd>Ctrl</kbd>+<kbd>U</kbd> || If playback has been limited to an order selection before, the playback lock can be removed here.
|-
| Queue Pattern (Transition at end of current pattern) || <kbd>Q</kbd> || The selected order list item is queued to be played next, after the current pattern has finished playing.
|-
| Queue Pattern (Transition at end of current measure) || <kbd>Shift</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current measure has finished playing.
|-
| Queue Pattern (Transition at end of current beat) || <kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current beat has finished playing.
|-
| Queue Pattern (Transition at end of current row) || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Q</kbd> || The selected order list item is queued to be played next, after the current row has finished playing.
|-
| Stream Export || || Opens the [[Manual: Saving and exporting#Stream Export|Wave Export dialog]] for the selected patterns.
|-
|}

=== Quick Channel Settings ===

These keyboard shortcuts operate while the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] is open.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Channel || <kbd>Alt</kbd>+<kbd>Left</kbd>, <kbd>Shift</kbd>+<kbd>Backspace</kbd> || Shows the channel settings for the previous channel.
|-
| Next Channel || <kbd>Alt</kbd>+<kbd>Right</kbd>, <kbd>Shift</kbd>+<kbd>Enter</kbd> || Shows the channel settings for the next channel.
|-
| Pick Color from Previous Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Left</kbd> || Assigns the color of the previous channel to the current channel.
|-
| Pick Color from Next Channel || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>Right</kbd> || Assigns the color of the next channel to the current channel.
|-
| Switch to Pattern Editor || <kbd>Enter</kbd> || Closes the dialog and returns to the Pattern Editor.
|-
|}

=== General Context ===

These keyboard shortcuts will work if the cursor focus is within any of the columns of the Pattern Editor, except where noted. When navigating (moving the cursor) to before the first row or after the last row in the pattern, the cursor “wraps” to the other side of the same pattern, if the “Cursor Wrap” option is enabled (in the Options section of the [[Manual: Setup/General|General tab]] of the Setup dialog). If navigating beyond the first or last row when the “Continuous Scroll” option is enabled, the cursor will instead move to the previous/next pattern in the order list.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Navigate Down by 1 Row || <kbd>Down</kbd> || Moves the cursor to the next row in the same column.
|-
| Navigate Up by 1 Row || <kbd>Up</kbd> || Moves the cursor to the previous row in the same column.
|-
| Navigate Down by Spacing || <kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor down by the value in the Row Spacing field.
|-
| Navigate Up by Spacing || <kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor up by the value in the Row Spacing field.
|-
| Navigate Left || <kbd>Left</kbd> || Moves the cursor to the previous column in the same row, going to the previous channel′s last column if moving from the first column of the current channel.
|-
| Navigate Right || <kbd>Right</kbd> || Moves the cursor to the next column in the same row, going to the next channel’s first column if moving from the last column of the current channel.
|-
| Navigate to Next Channel || <kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the next channel.
|-
| Navigate to Previous Channel || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the cursor to the same column in the same row in the previous channel.
|-
| Jump Down by Measure || <kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Up by Measure || <kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump Down by Beat || <kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump Up by Beat || <kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Measure || || Moves the cursor down to the first row of the next measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Up to Measure || || Moves the cursor up to the first row of the previous measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap Down to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageDown</kbd> || Moves the cursor down to the first row of the next beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Snap Up to Beat || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>PageUp</kbd> || Moves the cursor up to the first row of the previous beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump to Previous Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Up</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column above the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the previous patterns.
|-
| Jump to Next Entry in Column || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Down</kbd> || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column below the current cursor position. When combined with the Selection key, the selection will be extended to the next non-empty cell in the current pattern only. Otherwise, this command continues to search for a non-empty cell in the next patterns.
|-
| Go to First Channel || <kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the same row.
|-
| Go to First Row || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Moves the cursor to the first row of the same channel in the same column.
|-
| Go to First Row of First Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Home</kbd> || Moves the cursor to the first column of the first channel in the first row.
|-
| Go to Last Channel || <kbd>End</kbd> || Moves the cursor to the last column of the last channel in the same row.
|-
| Go to Last Row || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Moves the cursor to the last row of the same channel in the same column.
|-
| Go to Last Row of Last Channel || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>End</kbd> || Moves the cursor to the last column of the last channel in the last row.
|-
| Go to note column || || Moves the cursor to the note column of the current pattern cell.
|-
| Go to instrument column || || Moves the cursor to the instrument column of the current pattern cell.
|-
| Go to volume effect column || || Moves the cursor to the volume effect column of the current pattern cell.
|-
| Go to effect comamnd column || || Moves the cursor to the effect command column of the current pattern cell.
|-
| Go to effect parameter column || || Moves the cursor to the effect parameter column of the current pattern cell.
|-
| Previous Pattern || <kbd>Numpad-</kbd> || Displays the previous pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Next Pattern || <kbd>Numpad+</kbd> || Displays the next pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Previous Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>-</kbd> || Cycles to the previous sequence. If the current sequence is the first, the last sequence is selected.
|-
| Next Sequence || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>+</kbd> || Cycles to the next sequence. If the current sequence is the last, the first sequence is selected.
|-
| Scroll Left || || Scrolls the pattern editor to the left without changing the cursor position.
|-
| Scroll Right || || Scrolls the pattern editor to the right without changing the cursor position.
|-
| Scroll Up || || Scrolls the pattern editor up without changing the cursor position.
|-
| Scroll Down || || Scrolls the pattern editor down without changing the cursor position.
|-
| Selection Key || <kbd>Shift</kbd> || The modifier key to be used to extend the selection when navigating with keyboard shortcuts.
|-
| Copy Select Key || <kbd>Ctrl</kbd> || The modifier key to be used to copy the selection when dragging with the mouse.
|-
| Select Channel / Select All || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Selects all events of the channel where the cursor is located in the current pattern, or all events in the pattern if the entire channel is already selected.
|-
| Select Column || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Selects the column in which the cursor is located in all rows of the current pattern.
|-
| Select Row || || Completely selects all rows covered by the current selection.
|-
| Select Event || || Completely selects all events covered by the current selection.
|-
| Select Beat || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a beat and ends on the last row of a beat.
|-
| Select Measure || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> || Extends the current selection so that it starts on the first row of a measure and ends on the last row of a measure.
|-
| Lose Selection || || Resets the selection rectangle to contain only the cursor position.
|-
| Copy and Lose Selection || || Copies the selected events to the clipboard and unselects them.
|-
| Quick Copy || <kbd>Enter</kbd> || Copies only one event of data (where the cursor is located) to OpenMPT′s “Quick” clipboard; the standard clipboard is not erased. Each column pair has its own Quick clipboard.
|-
| Quick Paste || <kbd>Space</kbd> || Pastes the data in OpenMPT′s “Quick” clipboard to the location of the cursor. The data last saved in that column’s clipboard will be pasted in the cursor′s corresponding column.
|-
| Cut to Pattern Channel Clipboard || || Copies and clears the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Cut to Pattern Clipboard || || Copies and clears the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Copy to Pattern Channel Clipboard || || Copies the entire channel the cursor is located in. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Channel Clipboard” command.
|-
| Copy to Pattern Clipboard || || Copies the entire current pattern. The content is copied is into a separate clipboard that can only be pasted using the “Paste from Pattern Clipboard” command.
|-
| Paste from Pattern Channel Clipboard || || Replaces the contents of the channel the cursor is located in with the contents of the pattern channel clipboard.
|-
| Paste from Pattern Clipboard || || Replaces the contents of the current pattern with the contents of the pattern clipboard.
|-
| Toggle Clipboard Manager || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Toggles the visibility of the pattern clipboard manager.
|-
| Cycle to Previous Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Left</kbd> || Makes the previous internal clipboard the current clipboard.
|-
| Cycle to Next Clipboard || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Right</kbd> || Makes the next internal clipboard the current clipboard.
|-
| Clear Row || || Deletes all event data in the same row in the current channel.
|-
| Clear Field || <kbd>Delete</kbd> || Deletes the selected pattern data, or just the data under the current cursor position if no selection has been made.
|-
| Clear Field (IT Style) || <kbd>Shift</kbd>+<kbd>.</kbd> || Same as “Clear field”, but also clears the instrument number if a note event is selected.
|-
| Clear Row and Step || <kbd>Ctrl</kbd>+<kbd>Delete</kbd> || Same as “Clear row”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step || || Same as “Clear field”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear Field and Step (IT Style) || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Clear field (IT Style)”, but also moves the cursor by the number of rows in the Row Spacing field.
|-
| Delete Row(s) || <kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; the data is moved up to replace the cleared data, and empty rows are added at the end of the affected channels.
|-
| Delete Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; the data is moved up to replace the cleared data, and empty rows are added at the end of the pattern.
|-
| Delete Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; this also affect all following patterns as no empty rows are inserted.
|-
| Delete Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Backspace</kbd> || Deletes the same amount of rows as the selection, on all channels; this also affect all following patterns as no empty rows are inserted.
|-
| Insert Row(s) || <kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last row of those channels is deleted.
|-
| Insert Row(s) (All Channels) || <kbd>Ctrl</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last row of all channels is deleted.
|-
| Insert Row(s) (Global) || <kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in the selected channel down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Insert Row(s) (All Channels, Global) || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Insert</kbd> || Moves event data in the current and following rows in all channels down by the amount of selected rows. Event data in the last rows is pushed to the next pattern(s), where the same action is repeated.
|-
| Mute Current Channel || <kbd>F10</kbd> || Toggles the sound output (mute) for the channel(s) covered by the current selection.
|-
| Solo Current Channel || <kbd>Ctrl</kbd>+<kbd>F10</kbd> || Toggles the sound output (mute) for all channels except the channel(s) covered by the current selection.
|-
| Unmute All Channels || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>F10</kbd> || Unmutes the sound output for all channels.
|-
| (Un)mute Channel on Pattern Transition || || Toggles the sound output (mute) for the channel(s) covered by the current selection, but the change takes place when the current pattern is finished playing.
|-
| Unmute All Channels on Pattern Transition || || Unmutes the sound output for all channels when the current pattern is finished playing.
|-
| Solo Channel on Pattern Transition || || Toggles the sound output (mute) for all channels except the one where the cursor is located, but the change takes place when the current pattern is finished playing.
|-
| Channel Record Select || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Toggles the channel(s) covered by the current selection to belong to the primary record group.
|-
| Channel Split Record Select || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Toggles the channel(s) covered by the current selection to belong to the [[Manual: Keyboard Split|split record]] group.
|-
| Reset Channel || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Stops all note processing, and resets all channel variables to their defaults (volume, panning, etc.) on the selected channel(s).
|-
| Transpose Channel || || Changes the pitch of all notes on the selected channel in all patterns by a selectable amount of semitones.
|-
| Duplicate Channel || || Adds a new channel to the module and carries over all note data from the channel containing the edit cursor to this new channel.
|-
| Add Channel Before Current || || Adds a new empty channel before the channel containing the edit cursor.
|-
| Add Channel After Current || || Adds a new empty channel after the channel containing the edit cursor.
|-
| Remove Current || || Removes the channel containing the edit cursor. If the channel contains any data on any pattern, a confirmation prompt is shown.
|-
| Move Channels to Left || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the left by one channel.
|-
| Move Channels to Right || || Moves the channels covered by the current selection (if there is none, just the channel where the edit cursor is located) to the right by one channel.
|-
| Quick Channel Settings || || Opens the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]] for the channel where the cursor is located.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the note number of the currently selected notes.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the note number of the currently selected notes.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises by one the octave number of the currently selected notes.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers by one the octave number of the currently selected notes.
|-
| Transpose Custom || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Lowers or raises the selected notes by an arbitrary amount of semitones.
|-
| Transpose Custom (Quick) || || Applies a previously chosen custom transpose amount. If no amount has been chosen before, the behaviour of this shortcut is identical to Transpose Custom.
|-
| Data Entry +1 || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry -1 || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one.
|-
| Data Entry Up (Coarse) || || Increases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Data Entry Down (Coarse) || || Decreases the data (notes, instruments, effect parameters) in the currently selected pattern cells by one octave (notes), 10 (instruments and volume effect parameters) or 16 (effect parameters).
|-
| Insert New Pattern || || Inserts a new blank pattern after the current pattern, displays it, and moves the cursor to the same position in it. Also functions when cursor focus is in the Order list.
|-
| Duplicate Pattern || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Inserts a new pattern with the current pattern′s contents.
|-
| Split Pattern || || Splits the current pattern at the cursor location.
|-
| Amplify Selection || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens a dialog to change the note volume commands of the selected volume data.
|-
| Interpolate Note || || Transitions smoothly (using all available notes) between notes in the selection, filling in (and replacing if necessary) all rows with new note data.
|-
| Interpolate Instrument || || Transitions smoothly (using all available instrument numbers) between instrument numbers in the selection, filling in all rows with new instrument data.
|-
| Interpolate Volume || <kbd>Ctrl</kbd>+<kbd>J</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new volume effects. The first and last rows of the selection must contain the same volume effect, or one of the two rows might be empty.
|-
| Interpolate Effect || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new effect data. The first and last rows of the selection must contain the same effect, or one of the two rows might be empty. Different effects within the selection are not overwritten.
|-
| Apply Current Instrument || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Applies the current instrument to all cells in the selection that contain note data.
|-
| Apply Current Instrument to Existing Only || || Applies the current instrument to all cells in the selection that contain an instrument numbers. Notes without instrument numbers are not updated.
|-
| Grow Selection || <kbd>Alt</kbd>+<kbd>E</kbd> || “Expands” the selection by doubling the number of the selected rows, and evenly spacing out the event data within it. The expansion will replace event data below it in the same channels as the selection.
|-
| Shrink Selection || <kbd>Alt</kbd>+<kbd>D</kbd> || “Shrinks” the selection by deleting every other row of the selection. However, if only part of any row is selected, the data corresponding to the deleted selected data is also deleted.
|-
| Toggle Follow Song || <kbd>F11</kbd> || Toggles the “Follow Song” function.
|-
| Toggle Loop Pattern || <kbd>Shift</kbd>+<kbd>F11</kbd> || Toggles the Loop Pattern feature.
|-
| Play Row || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Process and play only the events in the current row where the cursor is located.
|-
| Go to Row/Channel/… || <kbd>Ctrl</kbd>+<kbd>G</kbd> || Opens the [[Manual: Go To|Go To]] dialog to allow you to jump to a different position in the module.
|-
| Pick Up Nearest Instrument Number || || Seeks for the nearest instrument number in the pattern channel the cursor currently is in. If an instrument number is found, it is set as the currently active instrument.
|-
| Enable Recording || <kbd>Ctrl</kbd>+<kbd>Space</kbd> || Toggles the Event Record feature. When enabled, patterns may be edited.
|-
| Toggle Metronome || <kbd>Alt</kbd>+<kbd>M</kbd> || Toggles the [[Manual: Metronome Settings|Metronome]].
|-
| Set Edit Step on Note Entry || <kbd>Alt</kbd> || The modifier key(s) that, when pressed with digits 0-9, allows you to change the Edit Step amount without using the mouse or moving the cursor focus out of the editor.
|-
| Increase Edit Step || || Increases the Edit Step by one row.
|-
| Decrease Edit Step || || Decreases the Edit Step by one row.
|-
| Switch to Order List || <kbd>Ctrl</kbd>+<kbd>Tab</kbd> || Toggles the cursor focus between the pattern editor and the current pattern in the Pattern Order list. There is also a more general version of this shortcut that works for all other song views as well (“Toggle Between Upper / Lower View”).
|-
| Toggle PC Event/Instrument Plugin Editor || <kbd>Ctrl</kbd>+<kbd>/</kbd> || Opens the editor for the plugin of the selected Parameter Control Event or instrument number.
|-
| Toggle Channel’s Plugin Editor || <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the editor for the current channel′s assigned plugin.
|-
| Show Note Properties || <kbd>▤ Application</kbd> || Opens the [[Manual: Note Properties|Note Properties]] dialog, where you can assign any event data to the current row of the current channel.
|-
| Show Pattern Properties || <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>P</kbd> || Opens the [[Manual: Pattern Properties|Pattern Properties]] dialog.
|-
| Split Keyboard Settings Dialog || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Keyboard Split|Keyboard Split]] dialog.
|-
| Open Effect Visualizer || <kbd>Alt</kbd>+<kbd>B</kbd> || Opens the [[Manual: Parameter Editor|Parameter Editor]] dialog.
|-
| Show Chord Editor || || opens the [[Manual: Chord Editor|Chord Editor]] dialog.
|-
| Show Context (Right-Click) Menu || || Opens the edit context menu at the cursor location without using the mouse.
|-
| Show Channel Context (Right-Click) Menu || || Opens the channel context menu at the cursor location without using the mouse.
|-
| Show Channel Plugin Context (Right-Click) Menu || || Opens the plugin context menu of the channel at the cursor location without using the mouse.
|-
| Show Playback Time at Current Row || <kbd>Ctrl</kbd>+<kbd>P</kbd> || Shows the estimated time within the track at the start of the current row.
|-
| Lock Playback to Rows || || If a selection is made, playback is locked to the selected rows. Otherwise, a previous playback lock is removed.
|-
| Quantize Settings || <kbd>Alt</kbd>+<kbd>Q</kbd> || Opens the record quantization settings.
|-
| Toggle row playback when navigating || || Toggles the state of the "play whole row when navigating" feature. The new state of the feature is announced in the status bar.
|-
| Toggle Overflow Paste || || When enabled, pasting will continue to the next pattern if the data overflows the current pattern.
|-
| Toggle Note Off Record (PC Keyboard) || || Toggles the recording of Note Off events from the PC keyboard in the pattern editor (also configurable from the [[Manual: Setup/General#Record note off|General setup]] page).
|-
| Toggle Note Off Record (MIDI) || || Toggles the recording of Note Off events from MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Apply Octave Transpose to incoming MIDI Notes || || Toggles application of the base octave transposition to notes received via MIDI in the pattern editor (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Continue Song when MIDI Note is received || || Toggles whether pattern playback continues when a note is received via MIDI (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Respond to Play / Continue / Stop Song MIDI messages || || Toggles whether pattern playback starts / stops / continues when the corresponding MIDI commands are received (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Velocity || || Toggles whether MIDI velocity is recorded (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI Pitch Bend || || Toggles whether MIDI pitch bends are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Record MIDI CCs || || Toggles whether MIDI CC events are recorded to patterns (also configurable from the [[Manual: Setup/MIDI#Record Note Off|MIDI setup]] page).
|-
| Toggle Instrument Column Visibility || || Shows or hides the instrument column.
|-
| Toggle Volume Column Visibility || || Shows or hides the volume column.
|-
| Toggle Effect Column Visibility || || Shows or hides the effect column.
|}

=== Note Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the note column (the first column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Base Octave [note] || <kbd>Q</kbd>, <kbd>W</kbd>, ... || Enters a note in the octave indicated in the Octave field.
|-
| Base Octave +1 [note] || <kbd>A</kbd>, <kbd>S</kbd>, ... || Enters a note in the next higher octave indicated in the Octave field.
|-
| Base Octave +2 [note] || <kbd>Z</kbd>, <kbd>X</kbd>, ... || Enters a note two octaves higher than the one indicated in the Octave field.
|-
| Base Octave +3 [note] || || Enters a note three octaves higher than the one indicated in the Octave field.
|-
| Base Octave +4 [note] || || Enters a note four octaves higher than the one indicated in the Octave field.
|-
| Set Octave [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Sets the selected note’s octave.
|-
| Chord Modifier || <kbd>Shift</kbd> || The modifier key(s) that calls a chord rather than a note. The chords are set and assigned in the [[Manual: Chord Editor|Chord Editor]].
|-
| Note Cut || <kbd>`</kbd> || Enters a Note Cut command (^^). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>1</kbd>.
|-
| Note Off || <kbd>=</kbd> || Enters a Note Off command (==). Note: The default shortcut is position-independent and is bound to the key that is usually left of <kbd>Backspace</kbd>.
|-
| Note Fade || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a Note Fade command (~~). Note: The default shortcut is position-independent and is bound to the key that is usually lef of <kbd>Backspace</kbd>.
|-
| Parameter Control || <kbd>Shift</kbd>+<kbd>-</kbd> || Enters an absolute [[Manual:_Parameter_Control_Events|Parameter Control event]] (PC). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
| Parameter Control (Smooth) || <kbd>-</kbd> || Enters a smooth sliding Parameter Control event (PCs). Note: The default shortcut is position-independent and is bound to the key that is usually right of <kbd>0</kbd>.
|-
|}

=== Instrument Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the instrument column (the second column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Instrument Digit [0 – 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the instrument field, moving the existing digits to the left.
|-
|}

=== Volume Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the volume column (the third column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Set Volume Digit [0 - 9] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd> || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left.
|-
| Set Volume Digit [A - F] || || Enters the digit into the rightmost place in the volume parameter field, moving the existing digits to the left. By default, volume column parameters are shown in decimal and these shortcuts are not assigned. You can use them after enabling the [[Manual: Hidden Settings#.5BPattern Editor.5D|Pattern Editor.VolumeColumnInHex]] hidden setting.
|-
| Volume Command - Volume || <kbd>V</kbd> || Enters a note volume (vxx) command into the pattern.
|-
| Volume Command - Panning || <kbd>P</kbd> || Enters a panning command (pxx) into the pattern.
|-
| Volume Command - Volume Slide Up || <kbd>C</kbd> || Enters volume slide up (cxx) into the pattern.
|-
| Volume Command - Volume Slide Down || <kbd>D</kbd> || Enters a volume slide down (dxx) into the pattern.
|-
| Volume Command - Fine Volume Slide Up || <kbd>A</kbd> || Enters a fine volume slide up (axx) into the pattern.
|-
| Volume Command - Fine Volume Slide Down || <kbd>B</kbd> || Enters a fine volume slide down (bxx) into the pattern.
|-
| Volume Command - Vibrato Speed || <kbd>U</kbd> || Enters a vibrato speed command (uxx) into the pattern.
|-
| Volume Command - Vibrato Depth || <kbd>H</kbd> || Enters a vibrato depth command (hxx) into the pattern.
|-
| Volume Command - XM Pan Slide Left || <kbd>L</kbd> || Enters a pan slide to the left (lxx) into the pattern.
|-
| Volume Command - XM Pan Slide Right || <kbd>R</kbd> || Enters a pan slide to the right (rxx) into the pattern.
|-
| Volume Command - Tone Portamento || <kbd>G</kbd> || Enters a tone portamento command (gxx) into the pattern.
|-
| Volume Command - Portamento Up || <kbd>F</kbd> || Enters a pitch bend up command (fxx) into the pattern.
|-
| Volume Command - Portamento Down || <kbd>E</kbd> || Enters a pitch bend down command (exx) into the pattern.
|-
| Volume Command - Offset || <kbd>O</kbd> || Enters a coarse sample offset command (oxx) into the pattern.
|-
|}

=== Effect Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect column (the fourth column). Alphanumeric effect letters (0-9, A-Z) are currently not editable — they are automatically assigned to the respective keys on your keyboard.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Smooth MIDI Macro Slide || <kbd>\</kbd> || Enters a Smooth MIDI Macro Slide (\xx) into the pattern.
|-
| Combined Note Delay and Note Cut || <kbd>;</kbd>, <kbd>Shift</kbd>+<kbd>;</kbd> || Enters a Delay-Cut (:xy) command into the pattern.
|-
| Parameter Extension Command || <kbd>/</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Parameter Extension Command]] (#xx) into the pattern.
|-
| Finetune || <kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Finetune Command]] (+xx) into the pattern.
|-
| Finetune (Smooth) || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a [[Manual: Effect Reference#Effect Column 5|Smooth Finetune Command]] (*xx) into the pattern.
|-
|}

=== Effect Parameter Column ===

These shortcuts are applied when the pattern editor has focus and the cursor is in the effect parameter column (the fifth column).

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Effect Parameter Digit [0 – F] || <kbd>0</kbd>-<kbd>9</kbd>, <kbd>Numpad0</kbd>-<kbd>Numpad9</kbd>, <kbd>A</kbd>-<kbd>F</kbd> || Enters the digit into the rightmost place in the effect parameter field, moving the existing digits to the left.
|-
|}

== Sample Editor ==

These shortcuts are applied when the [[Manual: Samples|Samples Tab]] is active.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Trim Sample around Loop Points || <kbd>Ctrl</kbd>+<kbd>T</kbd> || Trims the sample to the selection, if there is one. Otherwise, if loop points are specified, all sample data outside of these start/end times are deleted.
|-
| Trim to Loop End || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>T</kbd> || If loop points are specified, all sample data past the loop end is deleted.
|-
| Silence Sample Selection || <kbd>Backspace</kbd> || All of the sample data within the selected area is set to zero, effectively placing silence in that span.
|-
| Normalize Sample || <kbd>Shift</kbd>+<kbd>N</kbd> || Applies Normalisation to the sample.
|-
| Amplify Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Opens the [[Manual: Amplify|Amplify]] dialog, allowing you to alter the volume of the sample and apply Fade In or Fade Out (from / to silence).
|-
| Reverse Sample || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>R</kbd> || Puts the selected sample data in reverse order, so it is being played backwards.
|-
| Delete Sample Selection || <kbd>Delete</kbd> || Deletes the sample data within the selection, moving the remaining data together.
|-
| Toggle Sample Drawing || || Turns sample drawing mode on or off.
|-
| Add Silence / Create Sample || || Opens the dialog for adding silence, resizing samples and initializing FM instruments.
|-
| Configure Sample Grid || || Opens the dialog for setting the sample grid properties.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the data-to-display ratio, effectively zooming in to show more graphic detail of the sample data.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the data-to-display ratio, effectively zooming out to show less graphic detail of the sample data.
|-
| Zoom into Selection || <kbd>Space</kbd> || Zooms so much into the sample data that the current selection covers as much of the sample display as possible. If no selection has been made, auto-zoom is enabled.
|-
| Zoom into Sample Start || <kbd>1</kbd> || Zooms into the sample and ensures that the sample start is visible in the view.
|-
| Zoom into Sample End || <kbd>2</kbd> || Zooms into the sample and ensures that the sample end is visible in the view.
|-
| Center Loop Start in View || <kbd>Ctrl</kbd>+<kbd>1</kbd> || Ensures that the normal sample loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Loop End in View || <kbd>Ctrl</kbd>+<kbd>2</kbd> || Ensures that the normal sample loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop Start in View || <kbd>Ctrl</kbd>+<kbd>3</kbd> || Ensures that the sample sustain loop’s start point is centered in the waveform display (if the current zoom level allows it).
|-
| Center Sustain Loop End in View || <kbd>Ctrl</kbd>+<kbd>4</kbd> || Ensures that the sample sustain loop’s end point is centered in the waveform display (if the current zoom level allows it).
|-
| Convert Ping-Pong Loop to Unidirectional || || Turns a bidi-looped sample loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Convert Ping-Pong Sustain Loop to Unidirectional || || Turns a bidi-looped sustain loop into a sample with a regular loop by adding a reversed copy of the sample data.
|-
| Convert to 8-bit / 16-bit || <kbd>Ctrl</kbd>+<kbd>8</kbd> || Changes the sample’s bit depth between 8-bit and 16-bit.
|-
| Convert to Mono (Mix) || <kbd>Shift</kbd>+<kbd>M</kbd> || Mixes the left and right channels of a stereo sample equally together.
|-
| Convert to Mono (Left Channel) || <kbd>Shift</kbd>+<kbd>L</kbd> || Only keeps the left channel of a stereo sample.
|-
| Convert to Mono (Right Channel) || <kbd>Shift</kbd>+<kbd>R</kbd> || Only keeps the right channel of a stereo sample.
|-
| Convert to Mono (Split Sample) || <kbd>Shift</kbd>+<kbd>S</kbd> || Create two sample slots for this sample, one containing only the left channel and the other containing just the right channel. If the sample is referenced by an instrument, this instrument is duplicated as well for the right channel.
|-
| Change Stereo Separation || <kbd>Shift</kbd>+<kbd>P</kbd> || Adjusts the stereo separation of the sample by a given amount, either widening or narrowing the stereo width.
|-
| Upsample || <kbd>Shift</kbd>+<kbd>F</kbd>|| Doubles the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Downsample || <kbd>Shift</kbd>+<kbd>G</kbd>|| Halves the sample’s middle-C frequency using the interpolation filter last chosen in the [[Manual: Resample|Resample dialog]].
|-
| Resample || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Changes the sample’s middle-C frequency to a new arbitrary frequency.
|-
| Invert Sample Phase || <kbd>Ctrl</kbd>+<kbd>I</kbd> || Inverts the sample’s phase, i.e. it is mirrored along the time axis.
|-
| Signed / Unsigned Conversion || <kbd>Ctrl</kbd>+<kbd>U</kbd> || Re-interprets the sample data as a signed or unsigned sample.
|-
| Remove DC Offset || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Removes an unwanted static DC Offset from the waveform, i.e. it is centered around the time axis.
|-
| Quick Fade || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Applies a fade-in for the selected sample data if the selection includes the beginning of the sample, or applies a fade-out if the selection includes the end of the sample. If neither the beginning or end of the waveform is part of the selection, the Amplify dialog is shown.
|-
| Crossfade Sample Loop || <kbd>Ctrl</kbd>+<kbd>L</kbd> || Opens the Crossfade Loop dialog to crossfade the sample loop’s end with the loop start, to create seamless loop transitions.
|-
| Tune Sample to Given Note || || Opens the [[Manual: Sample Tuner|Sample Tuner]] dialog, where the sample can be tuned to a given note.
|-
| Load Sample || <kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. This command also works in the Instrument Tab, importing an instrument to the current Instrument slot.
|-
| Load Raw Sample || <kbd>Shift</kbd>+<kbd>Enter</kbd> || Opens the Open File dialog to allow you to import a sample file into the sample slot. The [[Manual: Raw Sample Import|Raw Sample Import]] is shown, ignoring the sample format even if it is known to OpenMPT.
|-
| Save Sample || || Opens the Save File dialog to allow you to save the sample as a Wave Audio or Raw file into a folder of your choice. This command also works in the Instrument Tab, saving the instrument and its accompanying samples as an .iti, .xi or .sfz file.
|-
| New Sample || || Creates a blank sample in the next unused slot. This command also works in the Instrument Tab.
|-
| Duplicate Sample || || Duplicates the current sample slot into the next unused slot.
|-
| Initialize OPL Instrument || || Configures the current sample slot to be a synthesized OPL instrument and recalls the default instrument parameters.
|-
| Transpose +1 || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises the middle-C frequency by one semitone.
|-
| Transpose -1 || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers the middle-C frequency by one semitone.
|-
| Transpose +1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Raises (doubles) the middle-C frequency by one octave.
|-
| Transpose -1 Octave || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Lowers (halves) the middle-C frequency by one octave.
|-
| Increment Finetune || <kbd>Shift</kbd>+<kbd>Up</kbd> || Raises the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Decrement Finetune || <kbd>Shift</kbd>+<kbd>Down</kbd> || Lowers the middle-C frequency by the configured [[Manual: Setup/Samples#Frequency Finetune Steps|frequency finetune step]], or by one finetune unit in MOD / XM Files.
|-
| Toggle Follow Sample Play Cursor|| <kbd>Shift</kbd>+<kbd>F</kbd> || Cycles through all three [[Manual: Setup/Samples#Automatic Scrolling when_Zoomed-In|sample playback cursor follow modes]]. The new follow mode is announced in the status bar.
|-
| Preview / Set Sample Cue [1 - 9] || <kbd>Shift</kbd>+<kbd>1</kbd>-<kbd>9</kbd> || Previews the sample at middle-C, starting from the chosen cue point. If the cue point is unset and the sample is currently being previewed, the cue point is set to the current play position.
|-
| Slice at Cue Points || || Creates new samples from the current sample by splitting the sample at its cue points.
|-
|}

== Instrument Editor ==

These shortcuts are applied when the [[Manual: Instruments#Sample Map|Sample Map]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Duplicate Instrument || <kbd>Ctrl</kbd>+<kbd>D</kbd> || Creates a new instrument slot using ''all'' the same instrument attributes as the currently displayed instrument.
|-
| Edit Sample Map || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Sample Map|Sample Map]] dialog.
|-
| Edit Current Sample || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the Samples page of the currently selected sample slot.
|-
| Map All Notes to Selected Note || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected note to all notes.
|-
| Map All Notes to Selected Sample || <kbd>Ctrl</kbd>+<kbd>M</kbd> || Sets the currently selected sample slot to all notes.
|-
| Reset Note Mapping || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Resets the note assignments, so that each note maps to itself (C-5 → C-5, D-5 → D-5, and so on).
|-
| Remove All Samples || || Removes any sample associations from the instrument.
|-
| Transpose +1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one semitone.
|-
| Transpose -1 (Note Map) || <kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one semitone.
|-
| Transpose +1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Q</kbd> || Transposes the whole note map up one octave.
|-
| Transpose -1 Octave (Note Map) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>A</kbd> || Transposes the whole note map down one octave.
|-
|}

=== Envelope Editor ===

These shortcuts are applied when the [[Manual: Instruments#Envelope Editor|envelope editor]] on the Instrument Tab is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Load Envelope || || Replaces the currently active envelope with an envelope from disk.
|-
| Save Envelope || || Stores the currently active envelope to disk.
|-
| Zoom In || <kbd>Numpad+</kbd>, <kbd>Ctrl</kbd>+<kbd>+</kbd> || Increases the detail of the Envelope Window, showing a smaller excerpt of the envelope.
|-
| Zoom Out || <kbd>Numpad-</kbd>, <kbd>Ctrl</kbd>+<kbd>-</kbd> || Decreases the detail of the Envelope Window, showing a bigger excerpt of the envelope.
|-
| Scale Envelope Points || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Scale Envelope Points|Scale Envelope Points]] dialog.
|-
| Switch to Volume Envelope || <kbd>Shift</kbd>+<kbd>M</kbd> || Selects the Volume Envelope for editing.
|-
| Switch to Panning Envelope || <kbd>Shift</kbd>+<kbd>P</kbd> || Selects the Panning Envelope for editing.
|-
| Switch to Pitch / Filter Envelope || <kbd>Shift</kbd>+<kbd>I</kbd> || Selects the Pitch / Filter Envelope for editing.
|-
| Toggle Volume Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>M</kbd> || Enables or disables the Volume Envelope.
|-
| Toggle Panning Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> || Enables or disables the Panning Envelope.
|-
| Toggle Pitch Envelope || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> || Enables or disables the Pitch Envelope.
|-
| Toggle Filter Envelope || <kbd>Shift</kbd>+<kbd>F</kbd> || Enables or disables the Filter Envelope.
|-
| Toggle Envelope Loop || <kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Loop.
|-
| Select Envelope Loop Start || <kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope loop start.
|-
| Select Envelope Loop End || <kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope loop end.
|-
| Toggle Envelope Sustain Loop || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> || Enables or disables the Envelope Sustain Loop.
|-
| Select Envelope Sustain Start || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Home</kbd> || Moves the selection to the envelope sustain start.
|-
| Select Envelope Sustain End || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>End</kbd> || Moves the selection to the envelope sustain end.
|-
| Toggle Envelope Carry || <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd> || Enables or disables the Envelope Carry.
|-
| Select Previous Envelope Point || <kbd>Shift</kbd>+<kbd>Tab</kbd> || Moves the selection to the previous envelope point.
|-
| Select Next Envelope Point || <kbd>Tab</kbd> || Moves the selection to the following envelope point.
|-
| Move Envelope Point Left || <kbd>Left</kbd> || Moves the selected envelope point left one tick.
|-
| Move Envelope Point Left (Coarse) || <kbd>Shift</kbd>+<kbd>Left</kbd> || Moves the selected envelope point left one beat.
|-
| Move Envelope Point Right || <kbd>Right</kbd> || Moves the selected envelope point right one tick.
|-
| Move Envelope Point Right (Coarse) || <kbd>Shift</kbd>+<kbd>Right</kbd> || Moves the selected envelope point right one beat.
|-
| Move Envelope Point Up || <kbd>Up</kbd> || Moves the selected envelope point up one unit.
|-
| Move Envelope Point Up (Coarse) || <kbd>PageUp</kbd> || Moves the selected envelope point up 8 units.
|-
| Move Envelope Point Down || <kbd>Down</kbd> || Moves the selected envelope point down one unit.
|-
| Move Envelope Point Down (Coarse) || <kbd>PageDown</kbd> || Moves the selected envelope point down 8 units.
|-
| Insert Envelope Point || <kbd>Insert</kbd> || Inserts an envelope point after the selected point.
|-
| Remove Envelope Point || <kbd>Delete</kbd>, <kbd>Backspace</kbd> || Deletes the selected envelope point.
|-
| Set Loop Start || <kbd>Home</kbd> || Sets the selected envelope point as the Envelope Loop start point.
|-
| Set Loop End || <kbd>End</kbd> || Sets the selected envelope point as the Envelope Loop end point.
|-
| Set Sustain Loop Start || <kbd>Ctrl</kbd>+<kbd>Home</kbd> || Sets the selected envelope point as the Sustain Loop start point.
|-
| Set Sustain Loop End || <kbd>Ctrl</kbd>+<kbd>End</kbd> || Sets the selected envelope point as the Sustain Loop end point.
|-
| Toggle Release Node || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the selected envelope point as the start point for the Release Envelope.
|-
|}

== Comments [Bottom] ==

These shortcuts are applied when the lower half of the [[Manual: Comments|Comments tab]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Toggle Between Lists || <kbd>Tab</kbd> || Toggles between the sample and instrument list.
|-
| Open Item in Editor || <kbd>Enter</kbd> || Switches to the sample or instrument editor to edit the currently selected item.
|-
| Rename Item || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Brings up an edit box for renaming the selected sample or instrument.
|-
|}

== Plugin Editor ==

These shortcuts are applied when a [[Manual: Plugin Window|plugin window]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Previous Plugin Preset || <kbd>Numpad-</kbd> || Selects the previous plugin preset / patch.
|-
| Next Plugin Preset || <kbd>Numpad+</kbd> || Selects the following plugin preset / patch.
|-
| Plugin Preset Backward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad-</kbd> || Jumps back 10 entries in the preset list.
|-
| Plugin Preset Forward Jump || <kbd>Ctrl</kbd>+<kbd>Numpad+</kbd> || Jumps forward 10 entries in the preset list.
|-
| Randomize Plugin Parameters || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>D</kbd> || Give random values to all parameters of the current plugin.
|-
| Toggle Parameter Recording || <kbd>Ctrl</kbd>+<kbd>R</kbd> || Toggles the parameter recording function, which allows you to record parameter changes from plugin window into the pattern.
|-
| Record MIDI Out to Pattern Editor || || Toggles the MIDI Out recording function, which allows you to route the plugin’s MIDI output to the pattern, sample or instrument editor.
|-
| Pass Key Presses to Plugin || <kbd>Ctrl</kbd>+<kbd>K</kbd> || Toggles the Pass Keys function, which sends all keyboard input to the currently open plugin window (e.g. for entering a serial number in the plugin GUI).
|-
| Bypass Plugin || <kbd>Ctrl</kbd>+<kbd>B</kbd> || Toggles plugin’s bypass property to control whether audio is routed through the plugin or not.
|}

== Tree View ==

These shortcuts are applied when the [[Manual:_Tree_View|Tree View]] is focussed.

{| class="wikitable"
|-
! Action !! Default Shortcut !! Description
|-
| Switch between Upper / Lower Tree View || <kbd>Tab</kbd> || Switches focus between the upper and lower panel of the Tree View.
|-
| Open / View Item || <kbd>Enter</kbd> || Opens / views / previews the selected item (same action as double-click).
|-
| Play Item || <kbd>Space</kbd> || Previews the selected item if it is a sample, instrument or file.
|-
| Insert Item || <kbd>Insert</kbd> || Inserts an empty item (e.g. sample or instrument slot) after the currently selected item.
|-
| Duplicate Item || <kbd>Shift</kbd>+<kbd>Insert</kbd> || Duplicates the currently selected item (e.g. sample or instrument slot).
|-
| Delete Item || <kbd>Delete</kbd> || Deletes the currently selected item.
|-
| Delete Item Permanently || <kbd>Shift</kbd>+<kbd>Delete</kbd> || Same as “Delete Item”, but if the selected item is a file, it will not be moved to the recycling bin.
|-
| Rename Item / Send To Editor || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items belonging to an open module (e.g. patterns, samples, instruments, ...): The selected item is renamed. For items in the instrument library: The item is sent to the last active sample or instrument editor and replaces the currently selected sample or instrument.
|-
| Send To Editor (Insert New) || <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Enter</kbd> || For items in the instrument library: The item is sent to the last active sample or instrument editor and is loaded into a new sample or instrument slot.
|-
| Go to Parent Folder || <kbd>Backspace</kbd> || Changes the instrument library folder to the current location′s parent folder.
|-
| Find in Instrument Library || <kbd>Ctrl</kbd>+<kbd>F</kbd>|| Opens the search filter to quickly locate files and folders in the instrument library.
|-
| Sort Instrument Library By Name || || Items in the instrument library are sorted by their file name.
|-
| Sort Instrument Library By Date || || Items in the instrument library are sorted by their last file modification date.
|-
| Sort Instrument Library By Size || || Items in the instrument library are sorted by their file size.
|}

[[Category:Manual|Keyboard Actions]]

Manual: Edit History

2025-06-07T10:18:38Z

Saga Musix:

[[Image:Edit History.png|thumb|400px|Edit History of a loaded IT module]]

You can view this dialog by selecting “Edit History” from the [[Manual: Menus#View|View menu]]. The full edit history is only available for IT and MPTM files, but a more limited history may be available in other formats (e.g. S3M files saved with Impulse Traker). This dialog lists the edit events, displaying the timestamps for each time the file was loaded into the tracker and modified. The first entry is when the track was created (if the history was never cleared). At the bottom of the window is the total time elapsed while the file was open, and the number of times the track was loaded. Clicking on the Clear button will erase all of this data, but the info is lost only if you save the track afterwards.

[[Category:Manual|Edit History]]
[[Category:Windows|Edit History]]

Manual: Edit History

2025-06-07T10:16:58Z

Saga Musix:

[[Image:Edit History.png|thumb|400px|Edit History of a loaded IT module]]

You can view this dialog by selecting “Edit History” from the [[Manual: Menus#View|View menu]], but it is only available for IT and MPTM files. This dialog lists the edit events, displaying the timestamps for each time the file was loaded into the tracker and modified. The first entry is when the track was created (if the history was never cleared). At the bottom of the window is the total time elapsed while the file was open, and the number of times the track was loaded. Clicking on the Clear button will erase all of this data, but the info is lost only if you save the track afterwards.

[[Category:Manual|Edit History]]
[[Category:Windows|Edit History]]

Libopenmpt

2025-06-06T17:53:44Z

Saga Musix: /* Players */

{{DISPLAYTITLE:libopenmpt}}
== libopenmpt ==

https://lib.openmpt.org/

=== Distribution packages ===
(As far as we know. If you know more, add it here.)

* '''Alpine''': https://pkgs.alpinelinux.org/packages?name=libopenmpt&branch=edge&repo=&arch=&maintainer=
* '''Arch''': https://archlinux.org/packages/?q=libopenmpt
* '''Cygwin''': https://cygwin.com/packages/summary/libopenmpt-src.html
* '''Debian''': https://tracker.debian.org/pkg/libopenmpt
* '''Fedora''': https://src.fedoraproject.org/rpms/libopenmpt
* '''Fink''': https://pdb.finkproject.org/pdb/package.php/libopenmpt-bin
* '''FreeBSD''': https://www.freshports.org/audio/libopenmpt/
* '''Gentoo''': https://packages.gentoo.org/packages/media-libs/libopenmpt
* '''Haiku''': https://depot.haiku-os.org/#!/pkg/libopenmpt
* '''Homebrew''': https://formulae.brew.sh/formula/libopenmpt
* '''MacPorts''': https://ports.macports.org/port/libopenmpt/
* '''MSYS2''': https://packages.msys2.org/base/mingw-w64-libopenmpt
* '''NetBSD''': https://cdn.netbsd.org/pub/pkgsrc/current/pkgsrc/audio/libopenmpt/index.html / https://pkgsrc.se/audio/libopenmpt
* '''NixOS''': https://search.nixos.org/packages?show=libopenmpt
* '''OpenBSD''': https://openports.pl/path/audio/libopenmpt
* '''OpenEmbedded''' / '''Yocto''': https://github.com/openembedded/meta-openembedded/tree/master/meta-multimedia/recipes-multimedia/libopenmpt
* '''openSUSE''': https://software.opensuse.org/package/libopenmpt
* '''Slackware''': http://sotirov-bg.net/slackpack/search.cgi?q=libopenmpt&lo=1 libopenmpt
* '''Ubuntu''': https://launchpad.net/ubuntu/+source/libopenmpt

More packages with detailed version information may be found at [https://repology.org/project/libopenmpt/versions Repology].

=== Software using libopenmpt ===
(As far as we know. If you know more, add it here. Please do not confuse libmodplug and libopenmpt when adding new software to this list. libmodplug is a different library.)

==== Players ====
* '''Audacious''' (Linux, macOS, Windows): https://audacious-media-player.org/ (https://github.com/audacious-media-player/audacious-plugins/tree/master/src/openmpt)
* '''Chipmachine Music Player''' (Linux, macOS, Windows): https://sasq64.github.io/chipmachine/
* '''chiptune2.js''' (HTML5+JavaScript): https://github.com/deskjet/chiptune2.js
* '''cmod3''' (cross-platform (JavaScript+node-webkit)): https://github.com/jllodra/cmod3
* '''Cog (kode54 fork)''' (macOS): https://cog.losno.co/
* '''Droidsound''' (Android): https://github.com/droidmjt/Droidsound (note: Droidsound does not come under a free open source license)
* '''foxbox''' (cross-platform Qt5): https://github.com/nilsding/foxbox
* '''HippoPlayer''' (macOS, Windows, Linux): https://github.com/emoon/HippoPlayer
* '''LOMP''' (Windows): https://sourceforge.net/projects/lomp/
* '''modizer''' (iOS): https://github.com/yoyofr/modizer
* '''ModPlug Player (new version)''' (Windows, macOS, Linux): https://github.com/ModPlugPlayer/ModPlugPlayer
* '''modplug-tools''' (Linux/*BSD command-line): https://github.com/alexmyczko/modplug-tools
* '''mpd''': https://github.com/MusicPlayerDaemon/MPD
* '''NXMilk''' (Nintendo Switch): https://github.com/proconsule/NXMilk
* '''openmpt123''' (cross-platform command-line): https://lib.openmpt.org/
* '''Pineapple Tracker Player''': https://github.com/BLumia/pineapple-tracker-player
* '''rePlayer''' (Windows): https://github.com/arnaud-neny/rePlayer
* '''TrackMeister''' (Windows, Linux, macOS): https://github.com/kajott/TrackMeister
* '''WACUP''' (Windows): https://getwacup.com/
* '''Winamp (Desktop Version)''' (Windows): https://www.winamp.com/downloads/
* '''ZXTune''' (Android, Linux, macOS, Windows): https://zxtune.bitbucket.io/

==== Player plugins ====
* '''foobar2000''' (foo_openmpt54): https://www.foobar2000.org/components/view/foo_openmpt54
* '''Kodi''' (audiodecoder.openmpt): https://github.com/notspiff/audiodecoder.openmpt
* '''qmmp''' (qmmp-openmpt): https://github.com/cspiegel/qmmp-openmpt
* '''XMPlay''' (xmp-openmpt): https://lib.openmpt.org/ / https://www.un4seen.com/forum/?topic=15448.0

==== Other end-user tools ====
* '''asciimod''' (command-line tool to dump mod metadata): https://bitbucket.org/seece/asciimod/overview
* '''Mod Library''' (module librarian for Windows): https://github.com/sagamusix/ModLibrary

==== Media framework plugins ====
* '''ffmpeg''' (libopenmpt demuxer): https://ffmpeg.org/ / https://git.ffmpeg.org/gitweb/ffmpeg.git/blob/HEAD:/libavformat/libopenmpt.c / https://github.com/FFmpeg/FFmpeg/blob/master/libavformat/libopenmpt.c
* '''gstreamer''' (openmptdec): https://gstreamer.freedesktop.org / https://cgit.freedesktop.org/gstreamer/gst-plugins-bad/tree/ext/openmpt / https://github.com/GStreamer/gst-plugins-bad/tree/master/ext/openmpt

==== Streaming software ====
* '''demosauce''' (Streaming backend for Demovibes online radio platform): https://gitlab.com/maep/demosauce

==== Audio libraries ====
* '''cl-mixed''' (Common Lisp): https://github.com/Shirakumo/cl-mixed
* '''Cowbell''' (Javascript): https://github.com/demozoo/cowbell
* '''node-chiptune''' (JavaScript / Node.js): https://github.com/Guichaguri/node-chiptune
* '''SoLoud''' (C++, C): https://github.com/jarikomppa/soloud
* '''tyrsound''' (C++, C): https://github.com/fgenesis/tyrsound

==== Game libraries / 3D engines ====
* '''Godot''': https://github.com/piptouque/godot_openmpt

==== Live performance frameworks ====
* '''Modipulate''' (C++): https://github.com/MrEricSir/Modipulate '''Note:''' Modipulate uses a forked and patched version of libopenmpt.

==== Language bindings ====
* '''C''': https://lib.openmpt.org/
* '''C++''': https://lib.openmpt.org/
* '''C# / .NET''': https://github.com/Xpl0itR/LibOpenMPT.NET
* '''D''': http://code.dlang.org/packages/dlibopenmpt
* '''FreeBASIC''': https://lib.openmpt.org/
* '''Lua''': https://github.com/konsumer/lua-openmpt
* '''OCaml''': https://github.com/demovibes/ocaml-openmpt
* '''Ruby''': https://rubygems.org/gems/ffi-openmpt
* '''Rust''': https://crates.io/crates/openmpt-sys / https://crates.io/crates/openmpt

==== Websites ====
* '''keygenmusic.tk''' uses libopenmpt for their online module player: http://keygenmusic.tk/
* '''ModArchive''' uses libopenmpt for their online module player: https://modarchive.org/

==== Games ====
* '''Sonic Robo Blast 2''' uses libopenmpt for playing music: https://github.com/STJr/SRB2 / https://www.srb2.org/

=== libopenmpt-related discussion on other websites ===
* https://github.com/fink/fink-distributions/issues/1202
* https://www.pouet.net/topic.php?which=9733
* https://www.pouet.net/topic.php?which=10287
* https://www.un4seen.com/forum/?topic=15448.0
* https://openmpt.org/libopenmpt-released
* http://www.bitfellas.org/comment.php?comment.news.4523
* https://modarchive.org/forums/index.php?topic=3618.0
* https://trac.videolan.org/vlc/ticket/13055
* http://trac.kodi.tv/ticket/15846
* https://trac.ffmpeg.org/ticket/5623
* http://forums.winamp.com/showthread.php?p=3016650
* http://hcs64.com/mboard/forum.php?showthread=26210&showpage=5
* http://www.freebasic.net/forum/viewtopic.php?t=24123
* https://forums.unrealtournament.com/archive/index.php/t-9229.html
* https://www.pouet.net/topic.php?which=10708
* https://getwacup.com/blog//index.php/2016/03/06/week-6/
* http://www.oldunreal.com/cgi-bin/yabb2/YaBB.pl?num=1421249113/2
* http://forum.renoise.com/index.php/topic/48648-crashes-with-malformed-files/
* https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=849840
* https://redmine.audacious-media-player.org/issues/848
* https://bugs.launchpad.net/mixxx/+bug/1859511

=== assorted links (need further review) ===

Libopenmpt

2025-06-02T20:10:53Z

Saga Musix: /* Players */

{{DISPLAYTITLE:libopenmpt}}
== libopenmpt ==

https://lib.openmpt.org/

=== Distribution packages ===
(As far as we know. If you know more, add it here.)

* '''Alpine''': https://pkgs.alpinelinux.org/packages?name=libopenmpt&branch=edge&repo=&arch=&maintainer=
* '''Arch''': https://archlinux.org/packages/?q=libopenmpt
* '''Cygwin''': https://cygwin.com/packages/summary/libopenmpt-src.html
* '''Debian''': https://tracker.debian.org/pkg/libopenmpt
* '''Fedora''': https://src.fedoraproject.org/rpms/libopenmpt
* '''Fink''': https://pdb.finkproject.org/pdb/package.php/libopenmpt-bin
* '''FreeBSD''': https://www.freshports.org/audio/libopenmpt/
* '''Gentoo''': https://packages.gentoo.org/packages/media-libs/libopenmpt
* '''Haiku''': https://depot.haiku-os.org/#!/pkg/libopenmpt
* '''Homebrew''': https://formulae.brew.sh/formula/libopenmpt
* '''MacPorts''': https://ports.macports.org/port/libopenmpt/
* '''MSYS2''': https://packages.msys2.org/base/mingw-w64-libopenmpt
* '''NetBSD''': https://cdn.netbsd.org/pub/pkgsrc/current/pkgsrc/audio/libopenmpt/index.html / https://pkgsrc.se/audio/libopenmpt
* '''NixOS''': https://search.nixos.org/packages?show=libopenmpt
* '''OpenBSD''': https://openports.pl/path/audio/libopenmpt
* '''OpenEmbedded''' / '''Yocto''': https://github.com/openembedded/meta-openembedded/tree/master/meta-multimedia/recipes-multimedia/libopenmpt
* '''openSUSE''': https://software.opensuse.org/package/libopenmpt
* '''Slackware''': http://sotirov-bg.net/slackpack/search.cgi?q=libopenmpt&lo=1 libopenmpt
* '''Ubuntu''': https://launchpad.net/ubuntu/+source/libopenmpt

More packages with detailed version information may be found at [https://repology.org/project/libopenmpt/versions Repology].

=== Software using libopenmpt ===
(As far as we know. If you know more, add it here. Please do not confuse libmodplug and libopenmpt when adding new software to this list. libmodplug is a different library.)

==== Players ====
* '''Audacious''' (Linux, macOS, Windows): https://audacious-media-player.org/ (https://github.com/audacious-media-player/audacious-plugins/tree/master/src/openmpt)
* '''Chipmachine Music Player''' (Linux, macOS, Windows): https://sasq64.github.io/chipmachine/
* '''chiptune2.js''' (HTML5+JavaScript): https://github.com/deskjet/chiptune2.js
* '''cmod3''' (cross-platform (JavaScript+node-webkit)): https://github.com/jllodra/cmod3
* '''Cog (kode54 fork)''' (macOS): https://cog.losno.co/
* '''Droidsound''' (Android): https://github.com/droidmjt/Droidsound (note: Droidsound does not come under a free open source license)
* '''foxbox''' (cross-platform Qt5): https://github.com/nilsding/foxbox
* '''HippoPlayer''' (macOS, Windows, Linux): https://github.com/emoon/HippoPlayer
* '''modizer''' (iOS): https://github.com/yoyofr/modizer
* '''ModPlug Player (new version)''' (Windows, macOS, Linux): https://github.com/ModPlugPlayer/ModPlugPlayer
* '''modplug-tools''' (Linux/*BSD command-line): https://github.com/alexmyczko/modplug-tools
* '''mpd''': https://github.com/MusicPlayerDaemon/MPD
* '''NXMilk''' (Nintendo Switch): https://github.com/proconsule/NXMilk
* '''openmpt123''' (cross-platform command-line): https://lib.openmpt.org/
* '''Pineapple Tracker Player''': https://github.com/BLumia/pineapple-tracker-player
* '''rePlayer''' (Windows): https://github.com/arnaud-neny/rePlayer
* '''TrackMeister''' (Windows, Linux, macOS): https://github.com/kajott/TrackMeister
* '''WACUP''' (Windows): https://getwacup.com/
* '''Winamp (Desktop Version)''' (Windows): https://www.winamp.com/downloads/
* '''ZXTune''' (Android, Linux, macOS, Windows): https://zxtune.bitbucket.io/

==== Player plugins ====
* '''foobar2000''' (foo_openmpt54): https://www.foobar2000.org/components/view/foo_openmpt54
* '''Kodi''' (audiodecoder.openmpt): https://github.com/notspiff/audiodecoder.openmpt
* '''qmmp''' (qmmp-openmpt): https://github.com/cspiegel/qmmp-openmpt
* '''XMPlay''' (xmp-openmpt): https://lib.openmpt.org/ / https://www.un4seen.com/forum/?topic=15448.0

==== Other end-user tools ====
* '''asciimod''' (command-line tool to dump mod metadata): https://bitbucket.org/seece/asciimod/overview
* '''Mod Library''' (module librarian for Windows): https://github.com/sagamusix/ModLibrary

==== Media framework plugins ====
* '''ffmpeg''' (libopenmpt demuxer): https://ffmpeg.org/ / https://git.ffmpeg.org/gitweb/ffmpeg.git/blob/HEAD:/libavformat/libopenmpt.c / https://github.com/FFmpeg/FFmpeg/blob/master/libavformat/libopenmpt.c
* '''gstreamer''' (openmptdec): https://gstreamer.freedesktop.org / https://cgit.freedesktop.org/gstreamer/gst-plugins-bad/tree/ext/openmpt / https://github.com/GStreamer/gst-plugins-bad/tree/master/ext/openmpt

==== Streaming software ====
* '''demosauce''' (Streaming backend for Demovibes online radio platform): https://gitlab.com/maep/demosauce

==== Audio libraries ====
* '''cl-mixed''' (Common Lisp): https://github.com/Shirakumo/cl-mixed
* '''Cowbell''' (Javascript): https://github.com/demozoo/cowbell
* '''node-chiptune''' (JavaScript / Node.js): https://github.com/Guichaguri/node-chiptune
* '''SoLoud''' (C++, C): https://github.com/jarikomppa/soloud
* '''tyrsound''' (C++, C): https://github.com/fgenesis/tyrsound

==== Game libraries / 3D engines ====
* '''Godot''': https://github.com/piptouque/godot_openmpt

==== Live performance frameworks ====
* '''Modipulate''' (C++): https://github.com/MrEricSir/Modipulate '''Note:''' Modipulate uses a forked and patched version of libopenmpt.

==== Language bindings ====
* '''C''': https://lib.openmpt.org/
* '''C++''': https://lib.openmpt.org/
* '''C# / .NET''': https://github.com/Xpl0itR/LibOpenMPT.NET
* '''D''': http://code.dlang.org/packages/dlibopenmpt
* '''FreeBASIC''': https://lib.openmpt.org/
* '''Lua''': https://github.com/konsumer/lua-openmpt
* '''OCaml''': https://github.com/demovibes/ocaml-openmpt
* '''Ruby''': https://rubygems.org/gems/ffi-openmpt
* '''Rust''': https://crates.io/crates/openmpt-sys / https://crates.io/crates/openmpt

==== Websites ====
* '''keygenmusic.tk''' uses libopenmpt for their online module player: http://keygenmusic.tk/
* '''ModArchive''' uses libopenmpt for their online module player: https://modarchive.org/

==== Games ====
* '''Sonic Robo Blast 2''' uses libopenmpt for playing music: https://github.com/STJr/SRB2 / https://www.srb2.org/

=== libopenmpt-related discussion on other websites ===
* https://github.com/fink/fink-distributions/issues/1202
* https://www.pouet.net/topic.php?which=9733
* https://www.pouet.net/topic.php?which=10287
* https://www.un4seen.com/forum/?topic=15448.0
* https://openmpt.org/libopenmpt-released
* http://www.bitfellas.org/comment.php?comment.news.4523
* https://modarchive.org/forums/index.php?topic=3618.0
* https://trac.videolan.org/vlc/ticket/13055
* http://trac.kodi.tv/ticket/15846
* https://trac.ffmpeg.org/ticket/5623
* http://forums.winamp.com/showthread.php?p=3016650
* http://hcs64.com/mboard/forum.php?showthread=26210&showpage=5
* http://www.freebasic.net/forum/viewtopic.php?t=24123
* https://forums.unrealtournament.com/archive/index.php/t-9229.html
* https://www.pouet.net/topic.php?which=10708
* https://getwacup.com/blog//index.php/2016/03/06/week-6/
* http://www.oldunreal.com/cgi-bin/yabb2/YaBB.pl?num=1421249113/2
* http://forum.renoise.com/index.php/topic/48648-crashes-with-malformed-files/
* https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=849840
* https://redmine.audacious-media-player.org/issues/848
* https://bugs.launchpad.net/mixxx/+bug/1859511

=== assorted links (need further review) ===

Manual: System Setup

2025-06-01T18:53:14Z

Saga Musix: /* System requirements */

<div style="float:right">__TOC__</div>
== System requirements ==
System requirements are few. There are different versions of OpenMPT for various hardware and software configurations. All you need to run and use OpenMPT is:
* '''32-bit version''':
** Windows 7 SP 1 or newer / Wine 1.8 or newer
** An x86-compatible CPU with support for the SSE2 instruction set*
* '''64-bit version''':
** Windows 7 SP 1 or newer / Wine 1.8 or newer
** An x64-compatible CPU
* '''ARM versions'''
** Windows 8 or newer (ARM) / Windows 10 or newer (ARM64) / Wine 1.8 or newer
** An ARM / ARM64 CPU
* Some kind of soundcard
* A display resolution of 800x600 or higher, preferably much higher.

<nowiki>*</nowiki>Most computers capable of running Windows 7 will fulfill this requirement.

=== 64-bit vs. 32-bit ===
If you run a 64-bit operating system, you should generally use the 64-bit version of OpenMPT. 
If you must use 32-bit VST plugins, then you should take care; plugins that do not match OpenMPT’s “bitness” need to be run in a bridge process, and every bridged plugin slows down OpenMPT’s audio mixer. If you use more 32-bit plugins than you do 64-bit plugins, you should use the 32-bit version of OpenMPT to lessen performance issues.

If in doubt, you can try both versions and use either one at your discretion. When using the OpenMPT installer, all versions of OpenMPT supported by your setup are installed automatically. When using portable builds, you can extract them into separate directories to verify which one works better.

== Expandability ==
OpenMPT can also take advantage of some peripherals, such as:
* A MIDI-compatible external device. See the [[Manual: MIDI Reference|MIDI Reference]] for setting up a MIDI device for use in OpenMPT.
* External speakers or headphones, including Quad Surround systems for soundcards that support this configuration.
* Software plugins (either VST or DirectX plugins) that are compatible with your computer and operating system.*

<nowiki>*</nowiki>OpenMPT's system requirements are independent from any software plugin(s) you might use with it. Since some plugins can require higher system requirements than OpenMPT itself, you should also check the system requirements of any plugin(s) you plan on using.

== Installation ==
# [https://openmpt.org/download Download] a version of OpenMPT.
# Install OpenMPT.
#* If you are using the '''Installer''' software for OpenMPT, you will be asked for the directory you wish to install OpenMPT into.
#* If you are '''updating''' from a previous version, the installer will replace the old files and folders with any new ones by default as well as update the registry (for file associations) if necessary. '''Note''': As with all software, updates may not be as stable as their previous versions, or features that you have become accustomed to may have been reworked in the new version. Although the Installer will keep the old user files (by giving the files a new extension), it is recommended you backup your previous version of OpenMPT until you are satisfied with the upgrade.
#* If you are using the '''.zip archive''', unzip the archive to the folder of your choice.
# Run OpenMPT.
:: When run for the first time, the Welcome dialog will appear automatically to allow you to set up some basic settings. There are many more ways to customize OpenMPT through the [[Manual: Setup|Setup dialog]], but you should first set up your soundcard settings by opening the “Sound Card” tab in the Setup dialog. Consult the section on [[Manual: Setup/Soundcard|Soundcard Options]] for determining the proper settings for your system. OpenMPT’s conservative default settings should work on all Windows systems, but adjusting the options to better meet your system's capabilities will likely give you a better experience.

== Uninstallation ==

If you wish to uninstall OpenMPT, you can use the provided uninstaller to remove all files and registry entries created during installation. However, this process will not remove files created during the use of OpenMPT, which you may want to remove manually. If you have installed OpenMPT for all users of the system, this step needs to be repeated for every Windows user account on which OpenMPT was used.

* '''Auto saves''': Before uninstalling OpenMPT, review your [[Manual: Setup/Paths / Auto_Save#Auto Save|Auto Save settings]]. If a fixed auto save location has been set up, make sure to empty that folder if you do not want to keep the auto save files.
* '''Configuration data''': Before uninstalling OpenMPT, choose “Show Settings Folder” from the “Help” menu to open the folder containing all configuration data. Uninstall OpenMPT, then delete the folder.

== Portability ==

If you would like to use OpenMPT on a flash drive or other removable media, there is an option to keep OpenMPT self-contained so that it does not leave a footprint on the computer’s system. Using OpenMPT’s installer affects the system registry and creates a new folder in the Settings directory. Portable Mode bypasses all of these. It can be achieved in multiple ways:

=== Portable Zip Package ===

This is the preferred option. On the [https://openmpt.org/download download page], download a portable zip package for the architecture(s) you want to run OpenMPT on. If you want to have a portable OpenMPT version for more than one architecture, you must extract those packages to separate folders.

=== Command-line switch ===

You can force OpenMPT into using Portable Mode by specifying the <code>/portable</code> [[Manual: Command-line Parameters|command-line switch]]. Even if there is no configuration file present in OpenMPT’s directory, it will not look for an existing configuration in <code>%APPDATA%\OpenMPT</code>.

This way, you can copy an existing OpenMPT installation to a different location and make it portable temporarily.

=== Creating a permanent portable multi-architecture setup ===

To manually create a portable multi-architecture OpenMPT setup, you can use an existing installation from a non-portable drive.


<ol>
<li> Copy all of the files in the original OpenMPT folder (typically <code>C:\Program Files\OpenMPT</code>) to a new folder on the portable drive.
<li> Create a file called <code>OpenMPT.portable</code> in that folder.
<li> If you want to import your previous configurations (like keyboard shortcuts, tunings, and other preferences), you will need to:
<ol>
<li> Navigate to OpenMPT's setting folder (<code>%APPDATA%\OpenMPT</code>). This can be achieved by using the “Show Settings Folder” option from the [[Manual: Menus#Help|Help menu]].
<li> Copy all files into the folder you created. This includes <code>mptrack.ini</code>, <code>Keybindings.mkb</code>, <code>plugin.cache</code>, <code>SongSettings.ini</code> and the <code>tunings</code> folder.
</ol>
</ol>

Be sure to adjust the paths in the [[Manual: Setup/General|General]] and the [[Manual: Setup/Paths / Auto Save|Paths / Auto Save]] pages of the Options dialog.

After the above changes, OpenMPT should be completely portable. If you will be working away from your main computer, remember to copy any samples, instrument files, and plugins you plan on using somewhere you can access them.

<div style="padding:6px; border:1px solid #a00; background:#ffa;">
'''Important notes:''' Special care has to be taken of modules with external content:
* Plugins need to be installed on the same removable drive as OpenMPT or else they cannot be found on another computer. Some plugins cannot be used in a portable fashion since they may depend on program data on the system drive or registry entries.
* Paths to [[Manual:_Samples#External_Samples|external samples]] in MPTM modules are stored as relative paths to the MPTM file if possible, so they are portable as long the samples are stored on the same drive as the module file.
</div>

[[Category:Manual|System Setup]]
[[de:Handbuch: Installation]]

Manual: Effect Reference

2025-06-01T18:23:15Z

Saga Musix: /* Combined Commands */

This is a list of all effects that can be used in the [[Manual: Patterns|Pattern Editor]]. 
Commands that go into the effect column use '''uppercase''' effect letters (e.g. <code>G05</code>), while effects that go into the volume column use '''lowercase''' effect letters (e.g. <code>g05</code>).

The MOD and XM formats share a similar set of effects, with XM offering more effects than MOD. The S3M, IT, and MPTM formats share a different set of effects, of which many are compatible to those from the MOD and XM formats but have different letters (e.g. <code>F75</code> in MOD turns into <code>T75</code> in S3M).

Currently, some effects, in particular those related to volume and panning, only directly affect samples, not instrument plugins (but their effect may be observed by a plugin through [[Manual: Zxx Macros|MIDI macros]]). Since this might change in the future, such effects should be avoided on channels that make use of instrument plugins.

The behaviour of some effects is influenced by the [[Manual: Compatible Playback|Compatible Playback]] settings.

== Effect Layout ==
{| class="wikitable" style="float:right; margin:10px;"
|
<code>'''A'''xy</code>: Effect letter 
<code>A'''xy'''</code>: Parameter
|}
An effect command consists of one character (the '''“effect letter”''') followed by the value that will be applied (the '''“parameter”'''), which is a '''[[Manual: Basics#Hexadecimal Notation|hexadecimal]]''' number in the effect column and a '''decimal''' number in the volume column. 

If the notation for a parameter is given as '''<code>xx</code>''', it means that a 2-digit hexadecimal number is expected. For this notation, 62h would be equal to 98, 29h would be equal to 41, and E8h would be equal to 232.

If the notation is '''<code>xy</code>''', it means that for <code>x</code> and <code>y</code> each, a 1-digit hexadecimal number is expected. For this notation, each of the digits in 62h would be read separately — as 6 and 2. Similarly, 29h would mean 2 and 9, and E8h would mean 14 and 8.

If you do not wish to manually convert decimal to hexadecimal and vice versa, you can double-click on a pattern cell or press the <kbd>▤ Application</kbd> key (by default) to open the [[Manual: Note Properties|Note Properties]] dialog. From there, you can adjust the effect parameters using sliders and see their meaning.

Note that the parameter range of some commands is limited, such as the XM command <abbr title="Set Volume"><code>Cxx</code></abbr>, whose maximum value is 40h (64). Entering out-of-range values is not recommended as they might be interpreted differently by non-conforming players.

== Frequency Units ==

If [[Manual: Song Properties#Linear Frequency Slides|Linear Frequency Slides]] are enabled, each unit of a pitch sliding effect (e.g. <abbr title="Portamento Down"><code>Exx</code></abbr> or <abbr title="Tone Portamento"><code>Gxx</code></abbr> in the IT / MPTM format) is equal to 1⁄16 of a semitone. Extra fine (e.g. <abbr title="Extra Fine Portamento Down"><code>EEx</code></abbr> or <abbr title="Extra Fine Portamento Up"><code>FEx</code></abbr>) units are equal to 1⁄64 of a semitone.

Otherwise, the unit of a pitch sliding effect is one ''period'', a metric inverse to frequency. This means that the lower the current note, the smaller the effect of one pitch slide unit, and the higher the note, the bigger the effect is. The period of a frequency can be calculated by dividing 3,546,895 by the frequency (3,579,364 in the XM format).

Linear Frequency Slides are not available in the MOD and S3M formats.

== Common Effect Parameters ==

Most effect parameters follow a simple scheme, but some effects also use a look-up table for their parameters. Depending on the effect, different parameters might do completely different things. Some common look-up table effects are described below.

=== Waveform Types ===

Some oscillator effects (namely Vibrato, Tremolo and Panbrello) use preset oscillator waveforms. They can be changed using special commands; the possible parameters of these commands are listed here.
{|
| style="text-align:center;" |
==== S3M / IT / MPTM Formats ====

{| class="wikitable" style="text-align:left; margin-right:10px;"
|-
! Parameter !! Waveform
|-
| '''0''' (default) || Sine (retrigger)
|-
| '''1''' || Sawtooth (retrigger)
|-
| '''2''' || Square (retrigger)
|-
| '''3''' || Random (retrigger)
|}

| style="text-align:center;" |
==== MOD / XM Formats ====

{| class="wikitable" style="text-align:left;"
|-
! Parameter !! Waveform !! Parameter !! Waveform
|-
| '''0''' (default) || Sine (retrigger) || '''4''' || Sine (continue)
|-
| '''1''' || Sawtooth (retrigger) || '''5''' || Sawtooth (continue)
|-
| '''2''' || Square (retrigger) || '''6''' || Square (continue)
|-
| '''3''' || Random† (retrigger) || '''7''' || Random† (continue)
|}
|}

'''Retrigger''' means that the oscillator waveform is played from its starting point when a new note is played. 
'''Continue''' means that the waveform continues at its last playback position when a new note is played. This waveform type is exclusive to the MOD and XM formats.

Every oscillator waveform is 64 points long, and the speed parameter denotes by how many points per tick the play position is advanced. So at a vibrato speed of 2, the vibrato waveform repeats after 32 ticks.

† The '''Random''' waveforms are not supported by ProTracker and FastTracker. While they are supported by some MOD / XM players, they should be avoided.

=== Retrigger Volume ===

The Retrigger command (<code>Rxy</code> in the XM format, <code>Qxy</code> in the S3M / IT / MPTM formats) does not only retrigger the note every <code>y</code> ticks, but also changes the note volume depending on the <code>x</code> value.

The following table explains the meaning of every possible <code>x</code> parameter:

{| class="wikitable"
|-
! Parameter !! Effect !! Parameter !! Effect
|-
| '''0''' || (XM) Last <code>x</code> value (S3M / IT / MPTM) No volume change || '''8''' || No volume change
|-
| '''1''' || Volume - 1 || '''9''' || Volume + 1
|-
| '''2''' || Volume - 2 || '''A''' || Volume + 2
|-
| '''3''' || Volume - 4 || '''B''' || Volume + 4
|-
| '''4''' || Volume - 8 || '''C''' || Volume + 8
|-
| '''5''' || Volume - 16 || '''D''' || Volume + 16
|-
| '''6''' || Volume × ⅔ || '''E''' || Volume × 1.5
|-
| '''7''' || Volume × ½ || '''F''' || Volume × 2
|}

=== Sound Control ===

The sound control effect (<code>X9x</code> in the XM format, <code>S9x</code> in the S3M / IT / MPTM formats) can be used to control various aspects of sound playback. Possible parameters are listed here.

<big>{{Warning|1=Using any of these commands outside of the MPTM format (except <abbr title="Surround On"><code>S91</code></abbr> which is native to only the IT and MPTM formats) is considered a ModPlug hack.}}</big>

{| class="wikitable"
|-
! Parameter
! Name
! Description
|-
| '''0'''
| Surround Off
| Disables surround playback on the current channel. This should only be used when using Quad Surround Panning. To keep compatibility with other trackers, a normal panning effect should be used in Center Surround mode.
|-
| '''1'''
| Surround On
| Enables surround playback on the current channel. When using stereo playback, the right channel of a sample is played with inversed phase (Pro Logic Surround). When using quad playback, the rear channels are used for playing this channel.
|-
| '''8'''
| Reverb Off
| Disables Reverb on the current channel.
|-
| '''9'''
| Reverb On
| {{Warning|As there is no per-song configuration for reverb available, use of this command is discouraged. Use a reverb plugin such as [[Manual: I3DL2Reverb Plugin|I3DL2Reverb]] or [[Manual: WavesReverb Plugin|WavesReverb]] instead.}} Enables Reverb on the current channel. The reverb parameters from the [[Manual: Setup/DSP|DSP Setup]] are used.
|-
| '''A'''
| Center Surround
| Sets the surround mode to Center Surround for all channels. This is the default mode. The <abbr title="Surround On"><code>S91</code></abbr> command will place the channel in the center of the rear channels. Any panning command will bring it back to the front channels.
|-
| '''B'''
| Quad Surround
| Sets the surround mode to Quad Surround for all channels. In this mode, panning commands can adjust the position of the rear channels. Switching between the front and rear channels can only be done by using the <abbr title="Surround On"><code>S91</code></abbr> and <abbr title="Surround Off"><code>S90</code></abbr> commands.
|-
| '''C'''
| Global Filters
| Sets filter mode to Global on all channels (Impulse Tracker behaviour). In this mode, when resonant filters are enabled with a <abbr title="MIDI Macro"><code>Zxx</code></abbr> effect, they will stay active until explicitly disabled by setting the cutoff frequency to the maximum (<code>Z7F</code>), and the resonance to the minimum (<code>Z80</code>).
|-
| '''D'''
| Local Filters
| Sets filter mode to Local on all channels. In this mode, the resonant filter will only affect the current note and will revert when a new note is played.
|-
| '''E'''
| Play Forward
| Forces the current sample to play forward.
|-
| '''F'''
| Play Backward
| Forces the current sample to play backward.
|}

== MOD Effect Commands ==

=== Effect Column ===

The MOD format only allows use of the effect column; there are no volume column commands.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>0xy</code>'''
| Arpeggio
| No
| Plays an arpeggiation of three notes in one row, cycling between the current note, current note + <code>x</code> semitones, and current note + <code>y</code> semitones.
| class="eff-pitch" | Pitch
|-
| '''<code>1xx</code>'''
| Portamento Up
| No
| Increases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>2xx</code>'''
| Portamento Down
| No
| Decreases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>3xx</code>'''
| Tone Portamento
| Yes
| Slides the pitch of the previous note towards the current note by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>4xy</code>'''
| Vibrato
| Yes
| Executes vibrato with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected vibrato waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>5xy</code>'''
| Volume Slide + Tone Portamento
| <abbr title="500 will call Tone Portamento memory">No</abbr>
| Functions like <abbr title="Volume Slide"><code>Axy</code></abbr> with <abbr title="Tone Portamento memory"><code>300</code></abbr>. Parameters are used like <code>Axy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>6xy</code>'''
| Volume Slide + Vibrato
| <abbr title="600 will call Vibrato memory">No</abbr>
| Functions like <abbr title="Volume Slide"><code>Axy</code></abbr> with <abbr title="Vibrato memory"><code>400</code></abbr>. Parameters are used like <code>Axy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>7xy</code>'''
| Tremolo
| Yes
| Executes tremolo with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected tremolo waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>8xx</code>'''
| Set Panning
| —
| Sets the current channel's panning position. Ranges from 00h (left) to FFh (right).
| class="eff-pan" | Panning
|-
| '''<code>9xx</code>'''
| Sample Offset
| Yes
| Starts playing the current sample from position <code>xx</code> × 256, instead of position 0. Ineffective if there is no note in the same pattern cell.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Axy</code>'''
| Volume Slide
| No
| Slides the current note volume up or down.
* '''<code>A0y</code>''' '''decreases''' note volume by <code>y</code> units on every tick of the row except the first.
* '''<code>Ax0</code>''' '''increases''' note volume by <code>x</code> units on every tick of the row except the first.
| class="eff-vol" | Volume
|-
| '''<code>Bxx</code>'''
| Position Jump
| —
| Causes playback to jump to pattern position <code>xx</code>. <code>B00</code> would restart a song from the beginning (first pattern in the Order List). If <abbr title="Pattern Break"><code>Dxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Dxx</code> jumps in. Ranges from 00h to 7Fh (127; maximum amount of patterns for the MOD format).
| class="eff-global" | Global (Pattern)
|-
| '''<code>Cxx</code>'''
| Set Volume
| —
| Sets the current note volume to <code>xx</code>. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Dxx</code>'''
| Pattern Break
| —
| Jumps to row <code>xx</code> of the next pattern in the Order List. If the current pattern is the last pattern in the Order List, <code>Dxx</code> will jump to row <code>xx</code> of the first pattern. If <abbr title="Position Jump"><code>Bxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Dxx</code> jumps in. Ranges from 00h to 3Fh (64; maximum amount of rows for each pattern in the MOD format).
| class="eff-global" | Global (Pattern)
|-
| '''<code>E0x</code>'''
| Set Filter
| —
| Configures the Amiga's LED lowpass filter.
* '''<code>E00</code>''' '''enables''' emulation of the lowpass filter.
* '''<code>E01</code>''' '''disables''' emulation of the lowpass filter.
Enabling the filter makes the sound output more muffled and is not recommended. Using this effect is only recommended to explicitly disable the filter for environments where it might not be disabled by default (such as a real Amiga system). OpenMPT only emulates the lowpass filter if the [[Manual: Setup/Mixer#Use Amiga resampler for Amiga modules|Amiga resampler]] is enabled in the Mixer settings.
| class="eff-misc" | Miscellaneous
|-
| '''<code>E1x</code>'''
| Fine Portamento Up
| No
| Similar to <abbr title="Portamento Up"><code>1xx</code></abbr>, but only applies on the first tick of the row.
| class="eff-pitch" | Pitch
|-
| '''<code>E2x</code>'''
| Fine Portamento Down
| No
| Similar to <abbr title="Portamento Down"><code>2xx</code></abbr>, but only applies on the first tick of the row.
| class="eff-pitch" | Pitch
|-
| '''<code>E3x</code>'''
| Glissando Control
| —
| {{Warning|This effect is not widely supported and behaves quirky in OpenMPT.}} Configures whether tone portamento effects slide by semitones or not.
* '''<code>E30</code> disables''' glissando.
* '''<code>E31</code> enables''' glissando.
| class="eff-pitch" | Pitch
|-
| '''<code>E4x</code>'''
| Set Vibrato Waveform
| —
| Sets the waveform of future Vibrato effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>E5x</code>'''
| Set Finetune
| —
| Overrides the finetune value for the currently playing note. Functions similarly to the same setting in the Sample Editor but is only applied temporarily. This command only works with a note next to it.
| class="eff-pitch" | Pitch
|-
| '''<code>E60</code>'''
| Pattern Loop Start
| —
| Marks the current row position to be used as the start of a pattern loop.
| class="eff-global" | Global (Pattern)
|-
| '''<code>E6x</code>'''
| Pattern Loop
| —
| Each time this command is reached, jumps to the row marked by <abbr title="Pattern Loop Start"><code>E60</code></abbr> until <code>x</code> jumps have occured in total. If <code>E6x</code> is used in a pattern with no <code>E60</code> effect, <code>E6x</code> will use the row position marked by any previous <code>E60</code> effect. Pattern loops cannot span multiple patterns. Ranges from 1h to Fh.
| class="eff-global" | Global (Pattern)
|-
| '''<code>E7x</code>'''
| Set Tremolo Waveform
| —
| Sets the waveform of future Tremolo effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>E8x</code>'''
| Set Panning
| —
| ''<abbr title="Set Panning"><code>8xx</code></abbr> is a much finer panning effect.'' Sets the current channel's panning position. Ranges from 0h (left) to Fh (right).
| class="eff-pan" | Panning
|-
| '''<code>E9x</code>'''
| Retrigger
| No
| Retriggers the current note every <code>x</code> ticks. This effect works with parameters greater than the current Speed setting if the row after it also contains an <code>E9x</code> effect.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EAx</code>'''
| Fine Volume Slide Up
| No
| Similar to <abbr title="Volume Slide Up"><code>Ax0</code></abbr>, but only applies on the first tick of the row.
| class="eff-vol" | Volume
|-
| '''<code>EBx</code>'''
| Fine Volume Slide Down
| No
| Similar to <abbr title="Volume Slide Down"><code>A0y</code></abbr>, but only applies on the first tick of the row.
| class="eff-vol" | Volume
|-
| '''<code>ECx</code>'''
| Note Cut
| —
| Sets note volume to 0 after <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, this command is ignored.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EDx</code>'''
| Note Delay
| —
| Delays the note or instrument change in the current pattern cell by <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, the current pattern cell's contents are never played.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EEx</code>'''
| Pattern Delay
| —
| Repeats the current row <code>x</code> times. Notes are not retriggered on every repetition, but effects are still processed. If multiple <code>EEx</code> commands are found on the same row, only the rightmost is considered.
| class="eff-global" | Global (Pattern)
|-
| '''<code>EFx</code>'''
| Invert Loop
| —
| {{Warning|This effect permanently modifies the module file when encountered during playback.}}
* '''<code>EFx</code>''', when used with a looped sample, goes through the sample loop and inverts all sampling points (i.e. changes the sign) one by one at speed <code>x</code>.
* '''<code>EF0</code>''' cancels <code>EFx</code>.
Samples modified by this effect cannot be recovered automatically (e.g. no undo point is created).
| class="eff-misc" | Miscellaneous
|-
| '''<code>Fxx</code>'''
| Set Speed / Tempo
| —
| {{Warning|Avoid using 20h or 00h as parameters.}}
* Sets the module '''Speed''' (ticks per row) if <code>xx</code> is less than 20h.
* Sets the module '''Tempo''' if <code>xx</code> greater than or equal to 20h.
Some players (including old OpenMPT versions) differ in their interpretations of <code>F20</code>. <code>F00</code> does nothing in OpenMPT, but some players stop the song when they encounter it.
| class="eff-global" | Global (Timing)
|}

'''† Effect Memory''': 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''No''' means that the command does nothing.
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>482</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>400</code></abbr> on a subsequent row, the <code>400</code> effect recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Volume"><code>C00</code></abbr> sets note volume to 0, <abbr title="Set Panning"><code>800</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.

== XM Effect Commands ==

Fasttracker II's XM format uses an extended version of the MOD command set.

As Fasttracker II was a rather buggy program, many effect commands may behave in a quirky way. Always enable the default [[Manual: Compatible Playback#XM compatibility settings|FT2 compatible playback settings]] for the best possible emulation of those quirks.

=== Effect Column ===

Some effects and features mentioned here are not actually part of the original XM format specifications. They will be labeled '''ModPlug hacks''', as they are not compatible with Fasttracker II. Use of these effects in the XM format is strongly discouraged; if you wish to use them, you should use a different format with equivalent, natively implemented effects.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>0xy</code>'''
| Arpeggio
| No
| Plays an arpeggiation of three notes in one row, cycling between the current note, current note + <code>x</code> semitones, and current note + <code>y</code> semitones.
| class="eff-pitch" | Pitch
|-
| '''<code>1xx</code>'''
| Portamento Up
| Yes
| Increases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>2xx</code>'''
| Portamento Down
| Yes
| Decreases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>3xx</code>'''
| Tone Portamento
| Yes
| Slides the pitch of the previous note towards the current note by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>4xy</code>'''
| Vibrato
| Yes
| Executes vibrato with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected vibrato waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>5xy</code>'''
| Volume Slide + Tone Portamento
| Yes
| Functions like <abbr title="Volume Slide"><code>Axy</code></abbr> with <abbr title="Tone Portamento memory"><code>300</code></abbr>. Parameters are used like <code>Axy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>6xy</code>'''
| Volume Slide + Vibrato
| Yes
| Functions like <abbr title="Volume Slide"><code>Axy</code></abbr> with <abbr title="Vibrato memory"><code>400</code></abbr>. Parameters are used like <code>Axy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>7xy</code>'''
| Tremolo
| Yes
| Executes tremolo with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected tremolo waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>8xx</code>'''
| Set Panning
| —
| Sets the current sample's panning position. As every sample has an enforced default panning, this setting is reset by any future entries in the instrument column. Ranges from 00h (left) to FFh (right).
| class="eff-pan" | Panning
|-
| '''<code>9xx</code>'''
| Sample Offset
| Yes
| Starts playing the current sample from position <code>xx</code> × 256, instead of position 0. Ineffective if there is no note in the same pattern cell.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Axy</code>'''
| Volume Slide
| Yes
| Slides the current note volume up or down.
* '''<code>A0y</code>''' '''decreases''' note volume by <code>y</code> units on every tick of the row except the first.
* '''<code>Ax0</code>''' '''increases''' note volume by <code>x</code> units on every tick of the row except the first.
| class="eff-vol" | Volume
|-
| '''<code>Bxx</code>'''
| Position Jump
| —
| Causes playback to jump to pattern position <code>xx</code>. <code>B00</code> would restart a song from the beginning (first pattern in the Order List). If <abbr title="Pattern Break"><code>Dxx</code></abbr> is on the same row and '''to the right''' of <code>Bxx</code>, the pattern specified by <code>Bxx</code> will be the pattern <code>Dxx</code> jumps in.
| class="eff-global" | Global (Pattern)
|-
| '''<code>Cxx</code>'''
| Set Volume
| —
| Sets the current note volume to <code>xx</code>. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Dxx</code>'''
| Pattern Break
| —
| {{Warning|To maintain compatibility with Fasttracker II, you should not jump past row 3Fh (63).}} Jumps to row <code>xx</code> of the next pattern in the Order List. If the current pattern is the last pattern in the Order List, <code>Dxx</code> will jump to row <code>xx</code> of the first pattern. If <abbr title="Position Jump"><code>Bxx</code></abbr> is on the same row and '''to the left''' of <code>Bxx</code>, the pattern specified by <code>Bxx</code> will be the pattern <code>Dxx</code> jumps in.
| class="eff-global" | Global (Pattern)
|-
| '''<code>E1x</code>'''
| Fine Portamento Up
| Yes
| Similar to <abbr title="Portamento Up"><code>1xx</code></abbr>, but only applies on the first tick of the row.
| class="eff-pitch" | Pitch
|-
| '''<code>E2x</code>'''
| Fine Portamento Down
| Yes
| Similar to <abbr title="Portamento Down"><code>2xx</code></abbr>, but only applies on the first tick of the row.
| class="eff-pitch" | Pitch
|-
| '''<code>E3x</code>'''
| Glissando Control
| —
| {{Warning|This effect is not widely supported and behaves quirky in OpenMPT.}} Configures whether tone portamento effects slide by semitones or not.
* '''<code>E30</code>''' '''disables''' glissando.
* '''<code>E31</code>''' '''enables''' glissando.
| class="eff-pitch" | Pitch
|-
| '''<code>E4x</code>'''
| Set Vibrato Waveform
| —
| Sets the waveform of future Vibrato effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>E5x</code>'''
| Set Finetune
| —
| Overrides the finetune value for the currently playing note. Functions similarly to the same setting in the Sample Editor but is only applied temporarily. This command only works with a note next to it.
| class="eff-pitch" | Pitch
|-
| '''<code>E60</code>'''
| Pattern Loop Start
| —
| {{Warning|A Fasttracker II bug makes use of this command non-trivial.}} Marks the current row position to be used as the start of a pattern loop. {{Warning|1=When <code>E60</code> is used on pattern row <code>x</code>, the following pattern also starts from row <code>x</code> instead of row 0. This can be circumvented by using a <abbr title="Pattern Break"><code>D00</code></abbr> command on the last row of the same pattern.}}
| class="eff-global" | Global (Pattern)
|-
| '''<code>E6x</code>'''
| Pattern Loop
| —
| Each time this command is reached, jumps to the row marked by <abbr title="Pattern Loop Start"><code>E60</code></abbr> until <code>x</code> jumps have occured in total. If <code>E6x</code> is used in a pattern with no <code>E60</code> effect, <code>E6x</code> will use the row position marked by any previous <code>E60</code> effect. Pattern loops cannot span multiple patterns. Ranges from 1h to Fh.
| class="eff-global" | Global (Pattern)
|-
| '''<code>E7x</code>'''
| Set Tremolo Waveform
| —
| Sets the waveform of future Tremolo effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>E8x</code>'''
| Set Panning
| —
| ''<abbr title="Set Panning"><code>8xx</code></abbr> is a much finer panning effect.'' Sets the current channel's panning position. Ranges from 0h (left) to Fh (right).
| class="eff-pan" | Panning
|-
| '''<code>E9x</code>'''
| Retrigger
| No
| Retriggers the current note every <code>x</code> ticks. This effect works with parameters greater than the current Speed setting if the row after it also contains an <code>E9x</code> effect.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EAx</code>'''
| Fine Volume Slide Up
| Yes
| Similar to <abbr title="Volume Slide Up"><code>Ax0</code></abbr>, but only applies on the first tick of the row.
| class="eff-vol" | Volume
|-
| '''<code>EBx</code>'''
| Fine Volume Slide Down
| Yes
| Similar to <abbr title="Volume Slide Down"><code>A0y</code></abbr>, but only applies on the first tick of the row.
| class="eff-vol" | Volume
|-
| '''<code>ECx</code>'''
| Note Cut
| —
| Sets note volume to 0 after <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, this command is ignored.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EDx</code>'''
| Note Delay
| —
| {{Warning|This command is very buggy (e.g. portamento effects next to a note delay are ignored). You should not rely on these bugs to be emulated by other players.}} Delays the note or instrument change in the current pattern cell by <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, the current pattern cell's contents are never played.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EEx</code>'''
| Pattern Delay
| —
| Repeats the current row <code>x</code> times. Notes are not retriggered on every repetition, but effects are still processed. If multiple <code>EEx</code> commands are found on the same row, only the rightmost is considered.
| class="eff-global" | Global (Pattern)
|-
| '''<code>EFx</code>'''
| Set Active Macro
| —
| {{Warning|This effect is a ModPlug hack.}} Selects the active [[Manual: Zxx Macros#Parametered Macros|parametered macro]] for the current channel.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Fxx</code>'''
| Set Speed / Tempo
| —
| {{Warning|Avoid using 00h as a parameter.}}
* Sets the module '''Speed''' (ticks per row) if <code>xx</code> is less than 20h.
* Sets the module '''Tempo''' if <code>xx</code> greater than or equal to 20h.
In OpenMPT and Fasttracker II, <code>F00</code> sets the Speed to 65535 ticks per row, but in other players it may stop the song entirely, or simply do nothing.
| class="eff-global" | Global (Timing)
|-
| '''<code>Gxx</code>'''
| Set Global Volume
| —
| Sets the global volume. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Hxy</code>'''
| Global Volume Slide
| Yes
| Similar to <abbr title="Volume Slide"><code>Axy</code></abbr>, but applies to the global volume.
| class="eff-vol" | Volume
|-
| '''<code>Kxx</code>'''
| Key Off
| —
| {{Warning|Avoid using 00h as a parameter; it interferes with other entries (e.g. notes, instruments) in the same pattern cell.}} Triggers a Note Off command after <code>xx</code> ticks.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Lxx</code>'''
| Set Envelope Position
| —
| Sets the volume envelope playback position to <code>xx</code> ticks. If the volume envelope’s sustain point is enabled, the panning envelope position is also changed.
| class="eff-vol" | Volume
|-
| '''<code>Pxy</code>'''
| Panning Slide
| Yes
| Slides the current sample's panning position left or right.
* '''<code>P0y</code>''' slides the panning to the '''left''' by <code>y</code> units on the first tick of the row.
* '''<code>Px0</code>''' slides the panning to the '''right''' by <code>x</code> units on the first tick of the row.
| class="eff-pan" | Panning
|-
| '''<code>Rxy</code>'''
| Retrigger
| Yes
| {{Warning|This command is very buggy (e.g. if a volume command is in the same pattern cell as <code>Rxy</code>, it will skip some ticks).}} Retriggers the current note every <code>y</code> ticks and changes the volume based on the <code>x</code> value (see the [[#Retrigger Volume|Retrigger Volume table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>Txy</code>'''
| Tremor
| Yes
| Rapidly switches the sample volume on and off on every tick of the row except the first. Volume is '''on''' for <code>x</code> + 1 ticks and '''off''' for <code>y</code> + 1 ticks. For instrument plugins {{Warning|(ModPlug hack)}}, this command sends note-on and note-off messages instead of modifying the volume.
| class="eff-vol" | Volume
|-
| '''<code>X1x</code>'''
| Extra Fine Portamento Up
| Yes
| Similar to <abbr title="Fine Portamento Up"><code>E1x</code></abbr>, but with 4 times the precision.
| class="eff-pitch" | Pitch
|-
| '''<code>X2x</code>'''
| Extra Fine Portamento Down
| Yes
| Similar to <abbr title="Fine Portamento Down"><code>E2x</code></abbr>, but with 4 times the precision.
| class="eff-pitch" | Pitch
|-
| '''<code>X5x</code>'''
| Set Panbrello Waveform
| —
| {{Warning|This effect is a ModPlug hack.}} Sets the waveform of future Panbrello effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>X6x</code>'''
| Fine Pattern Delay
| —
| {{Warning|This effect is a ModPlug hack.}} Extends the current row by <code>x</code> ticks. If multiple <code>X6x</code> commands are found on the same row, the sum of their parameters is used.
| class="eff-global" | Global (Pattern)
|-
| '''<code>X9x</code>'''
| Sound Control
| —
| {{Warning|This effect is a ModPlug hack.}} Executes a sound control command (see the [[Manual: Effect Reference#Sound Control|Sound Control table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>XAx</code>'''
| High Offset
| —
| {{Warning|This effect is a ModPlug hack.}} Sets the high offset for future <abbr title="Sample Offset"><code>9xx</code></abbr> commands. <code>x</code> × 65536 (10000h) is added to all offset effects that follow this command.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Yxy</code>'''
| Panbrello
| Yes
| {{Warning|This effect is a ModPlug hack.}} Executes Panbrello with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected Panbrello waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>Zxx</code>'''
| MIDI Macro
| —
| {{Warning|This effect is a ModPlug hack.}} Executes a [[Manual: Zxx Macros|MIDI Macro]].
| class="eff-misc" | Miscellaneous
|-
| '''<code>\xx</code>'''
| Smooth MIDI Macro
| —
| {{Warning|This effect is a ModPlug hack.}} Executes an interpolated MIDI Macro.
| class="eff-misc" | Miscellaneous
|}

=== Volume Column ===

The following commands can be entered into the effect column.

All parameter values are '''decimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>axx</code>'''
| Fine Volume Slide Up
| No
| Functions like <abbr title="Fine Volume Slide Up"><code>EAx</code></abbr> (slides the volume up <code>xx</code> units on the first tick).
| class="eff-vol" | Volume
|-
| '''<code>bxx</code>'''
| Fine Volume Slide Down
| No
| Functions like <abbr title="Fine Volume Slide Down"><code>EBx</code></abbr> (slides the volume down <code>xx</code> units on the first tick).
| class="eff-vol" | Volume
|-
| '''<code>cxx</code>'''
| Volume Slide Up
| No
| Functions like <abbr title="Volume Slide Up"><code>Ax0</code></abbr> (slides the volume up <code>xx</code> units on all ticks except the first).
| class="eff-vol" | Volume
|-
| '''<code>dxx</code>'''
| Volume Slide Down
| No
| Functions like <abbr title="Volume Slide Down"><code>A0y</code></abbr> (slides the volume down <code>xx</code> units on all ticks except the first).
| class="eff-vol" | Volume
|-
| '''<code>gxx</code>'''
| Tone Portamento
| Yes
| Functions like <abbr title="Tone Portamento"><code>3xx</code></abbr> (pitch-bends from the previous note to the current note). Compared to <code>3xx</code>, parameters are 16 times more coarse (e.g. <code>g01</code> = <abbr title="Tone Portamento with speed 16 (10h)"><code>310</code></abbr>). Combining the effect with <code>3xx</code> will double the effect parameter (e.g. <code>g01</code> would act like <code>g02</code>) and ignores the <code>3xx</code> command. Ineffective if <abbr title="Note Delay"><code>EDx</code></abbr> is in the same pattern cell.
| class="eff-pitch" | Pitch
|-
| '''<code>hxx</code>'''
| Vibrato Depth
| Yes
| Executes vibrato with depth <code>xx</code> and speed from the last <abbr title="Vibrato"><code>4xy</code></abbr> or <abbr title="Vibrato Speed"><code>u0x</code></abbr> command.
| class="eff-pitch" | Pitch
|-
| '''<code>lxx</code>'''
| Panning Slide Left
| No
| Functions like <abbr title="Panning Slide Left"><code>P0y</code></abbr> (slides the panning left by <code>xx</code> units).
| class="eff-pan" | Panning
|-
| '''<code>pxx</code>'''
| Set Panning
| No
| Sets the current channel's panning position. This effect only accepts 4-bit parameters (with 16 distinct values); when saving the file, parameters that are not multiples of 4 will be rounded down to a multiple of 4 (e.g. 55 will save as 52 and 5 will save as 4). Ranges from 0 (left) to 64 (right).
| class="eff-pan" | Panning
|-
| '''<code>rxx</code>'''
| Panning Slide Right
| No
| Functions like <abbr title="Panning Slide Right"><code>Px0</code></abbr> (slides the panning right by <code>xx</code> units).
| class="eff-pan" | Panning
|-
| '''<code>uxx</code>'''
| Vibrato Speed
| No
| Sets the vibrato speed to <code>xx</code>, but does not execute a vibrato.
| class="eff-pitch" | Pitch
|-
| '''<code>vxx</code>'''
| Set Volume
| No
| Sets the current note volume to <code>xx</code>. The behaviour of this command when sent to instrument plugins can be configured in the [[Manual: Instruments#Plugin / MIDI|Instrument Editor]] {{Warning|(ModPlug hack)}}. Ranges from 0 (off) to 64 (full).
| class="eff-vol" | Volume
|}

'''† Effect Memory''': 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''No''' means that the command does nothing.
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>482</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>400</code></abbr> on a subsequent row, the <code>400</code> effect recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Volume"><code>C00</code></abbr> sets note volume to 0, <abbr title="Set Panning"><code>800</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.

== S3M Effect Commands ==

Scream Tracker′s S3M format uses a command set that is entirely different from the MOD and XM formats'. Its use of the volume column is very limited.

The format was soon extended by other programs and players to support more effect commands (e.g. 7-Bit panning, panning slides, channel volume, etc.). Though these are also supported by OpenMPT, they are not original Scream Tracker 3 commands, and thus will be marked as such below.

=== Effect Column ===

The following commands can be entered into the effect column.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>Axx</code>'''
| Set Speed
| No
| Sets the module Speed (ticks per row).
| class="eff-global" | Global (Timing)
|-
| '''<code>Bxx</code>'''
| Position Jump
| —
| Causes playback to jump to pattern position <code>xx</code>. <code>B00</code> would restart a song from the beginning (first pattern in the Order List). If <abbr title="Pattern Break"><code>Cxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Cxx</code> jumps in.
| class="eff-global" | Global (Pattern)
|-
| '''<code>Cxx</code>'''
| Pattern Break
| —
| Jumps to row <code>xx</code> of the next pattern in the Order List. If the current pattern is the last pattern in the Order List, <code>Cxx</code> will jump to row <code>xx</code> of the first pattern. If <abbr title="Position Jump"><code>Bxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Cxx</code> jumps in. Ranges from 00h to 3Fh (64; maximum amount of pattern rows for the S3M format); higher values are ignored.
| class="eff-global | Global (Pattern)
|-
| '''<code>Dxy</code>'''
| Volume Slide or Fine Volume Slide
| Global
| Slides the current note volume up or down.
* '''<code>D0y</code> decreases''' note volume by <code>y</code> units on every tick of the row except the first. If <code>y</code> is Fh and [[Manual: Song Properties#Fast Volume Slides|Fast Volume Slides]] are enabled, volume decreases on every tick.
* '''<code>Dx0</code> increases''' note volume by <code>x</code> units on every tick of the row except the first. If <code>x</code> is Fh and [[Manual: Song Properties#Fast Volume Slides|Fast Volume Slides]] are enabled, volume decreases on every tick. Volume will not exceed 64 (40h).
* '''<code>DFy</code> finely decreases''' note volume by only applying <code>y</code> units on the first tick of the row. <code>y</code> cannot be Fh.
* '''<code>DxF</code> finely increases''' note volume by only applying <code>x</code> units on the first tick of the row. <code>x</code> cannot be Fh.
| class="eff-vol" | Volume
|-
| '''<code>Exx</code>'''
| Portamento Down or Fine Portamento Down or Extra Fine Portamento Down
| Global
| Decreases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
* '''<code>EFx</code> finely''' decreases note pitch by only applying <code>x</code> [[#Frequency Units|units]] on the first tick of the row.
* '''<code>EEx</code> extra-finely''' decreases note pitch by applying with 4 times the precision of <code>EFx</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Fxx</code>'''
| Portamento Up or Fine Portamento Up or Extra Fine Portamento Up
| Global
| Increases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
* '''<code>FFx</code> finely''' increases note pitch by only applying <code>x</code> [[#Frequency Units|units]] on the first tick of the row.
* '''<code>FEx</code> extra-finely''' increases note pitch by applying with 4 times the precision of <code>EFx</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Gxx</code>'''
| Tone Portamento
| Yes
| Slides the pitch of the previous note towards the current note by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>Hxy</code>'''
| Vibrato
| Yes
| Executes vibrato with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected vibrato waveform (see the [[#Waveform Types|Waveform Types table]] for more details). Shares memory with <abbr title="Fine Vibrato"><code>Uxy</code></abbr>.
| class="eff-pitch" | Pitch
|-
| '''<code>Ixy</code>'''
| Tremor
| Global
| Rapidly switches the sample volume on and off. Volume is on for <code>x</code> ticks and off for <code>y</code> ticks.
| class="eff-vol" | Volume
|-
| '''<code>Jxy</code>'''
| Arpeggio
| Global
| Plays an arpeggiation of three notes in one row, cycling between the current note, current note + <code>x</code> semitones, and current note + <code>y</code> semitones.
| class="eff-pitch" | Pitch
|-
| '''<code>Kxy</code>'''
| Volume Slide + Vibrato
| Global
| Functions like <abbr title="Volume Slide"><code>Dxy</code></abbr> with <abbr title="Vibrato memory"><code>H00</code></abbr>. Parameters are used like <code>Dxy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Lxy</code>'''
| Volume Slide + Tone Portamento
| Global
| Functions like <abbr title="Volume Slide"><code>Dxy</code></abbr> with <abbr title="Tone Portamento memory"><code>G00</code></abbr>. Parameters are used like <code>Dxy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Mxx</code>'''
| Set Channel Volume
| —
| {{Warning|This is not an original Scream Tracker 3 effect.}} Sets the current channel volume, which multiplies all note volumes it encompasses. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Nxy</code>'''
| Channel Volume Slide
| Yes
| {{Warning|This is not an original Scream Tracker 3 effect.}} Similar to <abbr title="Volume Slide"><code>Dxy</code></abbr>, but applies to the current channel's volume.
| class="eff-vol" | Volume
|-
| '''<code>Oxx</code>'''
| Sample Offset
| Yes
| Starts playing the current sample from position <code>xx</code> × 256, instead of position 0. Ineffective if there is no note in the same pattern cell.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Pxy</code>'''
| Panning Slide or Fine Panning Slide
| Yes
| {{Warning|This is not an original Scream Tracker 3 effect.}} Slides the current channel's panning position left or right.
* '''<code>P0y</code>''' slides the panning to the '''right''' by <code>y</code> units on every tick of the row except the first.
* '''<code>Px0</code>''' slides the panning to the '''left''' by <code>x</code> units on every tick of the row except the first.
* '''<code>PFy</code> finely''' slides the panning to the right by only applying <code>y</code> units on the first tick of the row. <code>y</code> cannot be Fh.
* '''<code>PxF</code> finely''' slides the panning to the left by only applying <code>x</code> units on the first tick of the row. <code>x</code> cannot be Fh.
| class="eff-pan" | Panning
|-
| '''<code>Qxy</code>'''
| Retrigger
| Global
| Retriggers the current note every <code>y</code> ticks and changes the volume based on the <code>x</code> value (see the [[#Retrigger Volume|Retrigger Volume table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>Rxy</code>'''
| Tremolo
| Global
| Executes tremolo with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected tremolo waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>S1x</code>'''
| Glissando Control
| <abbr title="Global memory can be called with S00">—</abbr>
| {{Warning|This effect is not widely supported and behaves quirky in OpenMPT.}} Configures whether tone portamento effects slide by semitones or not.
* '''<code>S10</code> disables''' glissando.
* '''<code>S11</code> enables''' glissando.
| class="eff-pitch" | Pitch
|-
| '''<code>S2x</code>'''
| Set Finetune
| <abbr title="Global memory can be called with S00">—</abbr>
| ''Considered a legacy command.'' Overrides the current sample's C-5 frequency with a MOD finetune value.
| class="eff-pitch" | Pitch
|-
| '''<code>S3x</code>'''
| Set Vibrato Waveform
| <abbr title="Global memory can be called with S00">—</abbr>
| Sets the waveform of future Vibrato effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>S4x</code>'''
| Set Tremolo Waveform
| <abbr title="Global memory can be called with S00">—</abbr>
| Sets the waveform of future Tremolo effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>S5x</code>'''
| Set Panbrello Waveform
| <abbr title="Global memory can be called with S00">—</abbr>
| {{Warning|This is not an original Scream Tracker 3 effect.}} Sets the waveform of future Panbrello effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>S6x</code>'''
| Fine Pattern Delay
| <abbr title="Global memory can be called with S00">—</abbr>
| Extends the current row by <code>x</code> ticks. If multiple <code>S6x</code> commands are on the same row, the sum of their parameters is used.
| class="eff-global" | Global (Pattern)
|-
| '''<code>S8x</code>'''
| Set Panning
| <abbr title="Global memory can be called with S00">—</abbr>
| ''<abbr title="Set Panning"><code>Xxx</code></abbr> is a much finer panning effect.'' Sets the current channel's panning position. Ranges from 0h (left) to Fh (right).
| class="eff-pan" | Panning
|-
| '''<code>S9x</code>'''
| Sound Control
| <abbr title="Global memory can be called with S00">—</abbr>
| {{Warning|This is not an original Scream Tracker 3 effect.}} Executes a sound control command (see the [[#Sound Control|Sound Control table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>SAx</code>'''
| High Offset
| <abbr title="Global memory can be called with S00">—</abbr>
| {{Warning|This is not an original Scream Tracker 3 effect.}} Sets the high offset for future <abbr title="Sample Offset"><code>Oxx</code></abbr> commands. <code>x</code> × 65536 (10000h) is added to all offset effects that follow this command.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SB0</code>'''
| Pattern Loop Start
| <abbr title="Global memory can be called with S00">—</abbr>
| Marks the current row position to be used as the start of a pattern loop.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SBx</code>'''
| Pattern Loop
| <abbr title="Global memory can be called with S00">—</abbr>
| Each time this command is reached, jumps to the row marked by <abbr title="Pattern Loop Start"><code>SB0</code></abbr> until <code>x</code> jumps have occurred in total. If <code>SBx</code> is used in a pattern with no <code>SB0</code> effect, <code>SBx</code> will use the row position marked by any previous <code>SB0</code> effect. Pattern loops cannot span multiple patterns. Ranges from 1h to Fh.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SCx</code>'''
| Note Cut
| <abbr title="Global memory can be called with S00">—</abbr>
| Stops the current sample after <code>x</code> ticks. If <code>x</code> is 0, or greater than or equal to the current module Speed, this command is ignored.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SDx</code>'''
| Note Delay
| <abbr title="Global memory can be called with S00">—</abbr>
| Delays the note or instrument change in the current pattern cell by <code>x</code> ticks. If <code>x</code> is 0, or greater than or equal to the current module Speed, the current pattern cell's contents are never played.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SEx</code>'''
| Pattern Delay
| <abbr title="Global memory can be called with S00">—</abbr>
| Repeats the current row <code>x</code> times. Notes are not retriggered on every repetition, but effects are still processed. If multiple <code>SEx</code> commands are on the same row, only the leftmost command is used.
| class="eff-global" | Global (Pattern)
|-
| '''<code>T0x</code>'''
| Decrease Tempo
| Yes
| Decreases the module Tempo by <code>x</code> BPM on every tick of the row except the first.
| class="eff-global" | Global (Timing)
|-
| '''<code>T1x</code>'''
| Increase Tempo
| Yes
| Increases the module Tempo by <code>x</code> BPM on every tick of the row except the first.
| class="eff-global" | Global (Timing)
|-
| '''<code>Txx</code>'''
| Set Tempo
| No
| Sets the module Tempo if <code>xx</code> is greater than or equal to 20h.
| class="eff-global" | Global (Timing)
|-
| '''<code>Uxy</code>'''
| Fine Vibrato
| Yes
| Similar to <abbr title="Vibrato"><code>Hxy</code></abbr>, but with 4 times the precision. Shares memory with <code>Hxy</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Vxx</code>'''
| Set Global Volume
| —
| Sets the global volume. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Wxy</code>'''
| Global Volume Slide
| Yes
| {{Warning|This is not an original Scream Tracker 3 effect.}} Similar to <abbr title="Volume Slide"><code>Dxy</code></abbr>, but applies to the global volume.
| class="eff-vol" | Volume
|-
| '''<code>Xxx</code>'''
| Set Panning
| —
| Sets the current channel's panning position.
* '''<code>XA4</code> enables surround playback''' on the current channel. When using '''stereo''' playback, the right channel of a sample is played with inversed phase (Pro Logic Surround). When using '''quad''' playback, the rear channels are used for playing this channel.
Surround mode can be disabled by using a different <code>Xxx</code> command on the same channel it was enabled on. Ranges from 00h (left) to 80h (right).
| class="eff-pan" | Panning
|-
| '''<code>Yxy</code>'''
| Panbrello
| Yes
| {{Warning|This is not an original Scream Tracker 3 effect.}} Executes panbrello with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected panbrello waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>Zxx</code>'''
| MIDI Macro
| —
| {{Warning|This is not an original Scream Tracker 3 effect.}} Executes a [[Manual: Zxx Macros|MIDI Macro]]. Since MIDI Macros are not stored in S3M files, only the default macro configuration can be used to control the resonant filter.
| class="eff-misc" | Miscellaneous
|}

=== Volume Column ===

The following commands can be entered into the volume column.

All parameter values are '''decimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>pxx</code>'''
| Set Panning
| No
| {{Warning|This is not an original Scream Tracker 3 effect.}} Sets the current channel's panning position to <code>xx</code>. Ranges from 0 to 64 (decimal).
| class="eff-pan" | Panning
|-
| '''<code>vxx</code>'''
| Set Volume
| No
| Sets the current note volume to <code>xx</code>. Ranges from 0 to 64 (decimal).
| class="eff-vol" | Volume
|}

'''† Effect Memory:''' 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''No''' means that the command does nothing.
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>H82</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>H00</code></abbr> on a subsequent row, the <code>H00</code> command recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Global Volume"><code>V00</code></abbr> sets the global volume to 0, <abbr title="Set Panning"><code>X00</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.
* '''Global''' means that the effect calls any previous non-zero parameter in the same column. For example, if the effect <abbr title="Portamento Down by 22h (34) units"><code>E22</code></abbr> is followed by <abbr title="Tremor memory"><code>I00</code></abbr>, the <code>I00</code> command recalls the effect parameter 22h.

=== AdLib / OPL3 Instruments ===
OpenMPT supports AdLib / OPL3 instruments in the S3M format, but not all effects are compatible with them. Below is a list of effects that do not function with AdLib / OPL3 instruments in S3M files:
* <code>Oxx</code> (Sample Offset)
* <code>S9x</code> (Sound Control)
* <code>SAx</code> (High Offset)
* <code>XA4</code> (Enable Surround)

The following effects are not supported in Scream Tracker 3 but work with AdLib / OPL3 instruments in OpenMPT:
* <code>Mxx</code> (Set Channel Volume)
* <code>Nxy</code> (Channel Volume Slide)

Additionally, since AdLib / OPL3 instruments only support hard left, center, and hard right panning, the range of <abbr title="Set Panning"><code>Xxx</code></abbr> and <abbr title="Set Panning"><code>pxx</code></abbr> are effectively restricted to those positions.

== IT Effect Commands ==

Impulse Tracker's IT format uses a command set that expands upon the S3M format's, adding several new effects and improving effect memory usage.

=== Effect Column ===

The following commands can be entered into the effect column.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>Axx</code>'''
| Set Speed
| No
| Sets the module Speed (ticks per row).
| class="eff-global" | Global (Timing)
|-
| '''<code>Bxx</code>'''
| Position Jump
| —
| Causes playback to jump to pattern position <code>xx</code>. <code>B00</code> would restart a song from the beginning (first pattern in the Order List). If <abbr title="Pattern Break"><code>Cxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Cxx</code> jumps in.
| class="eff-global" | Global (Pattern)
|-
| '''<code>Cxx</code>'''
| Pattern Break
| —
| Jumps to row <code>xx</code> of the next pattern in the Order List. If the current pattern is the last pattern in the Order List, <code>Cxx</code> will jump to row <code>xx</code> of the first pattern. If <abbr title="Position Jump"><code>Bxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Cxx</code> jumps in. Ranges from 00h to the next pattern's row length; higher values are treated as 00h.
| class="eff-global | Global (Pattern)
|-
| '''<code>Dxy</code>'''
| Volume Slide or Fine Volume Slide
| Yes
| Slides the current note volume up or down.
* '''<code>D0y</code> decreases''' note volume by <code>y</code> units on every tick of the row except the first. If <code>y</code> is Fh, volume decreases on every tick.
* '''<code>Dx0</code> increases''' note volume by <code>x</code> units on every tick of the row except the first. Volume will not exceed 64 (40h).
* '''<code>DFy</code> finely decreases''' note volume by only applying <code>y</code> units on the first tick of the row. <code>y</code> cannot be Fh.
* '''<code>DxF</code> finely increases''' note volume by only applying <code>x</code> units on the first tick of the row. <code>x</code> cannot be Fh.
| class="eff-vol" | Volume
|-
| '''<code>Exx</code>'''
| Portamento Down or Fine Portamento Down or Extra Fine Portamento Down
| Yes
| Decreases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
* '''<code>EFx</code> finely''' decreases note pitch by only applying <code>x</code> [[#Frequency Units|units]] on the first tick of the row.
* '''<code>EEx</code> extra-finely''' decreases note pitch by applying with 4 times the precision of <code>EFx</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Fxx</code>'''
| Portamento Up or Fine Portamento Up or Extra Fine Portamento Up
| Yes
| Increases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
* '''<code>FFx</code> finely''' increases note pitch by only applying <code>x</code> [[#Frequency Units|units]] on the first tick of the row.
* '''<code>FEx</code> extra-finely''' increases note pitch by applying with 4 times the precision of <code>EFx</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Gxx</code>'''
| Tone Portamento
| Yes
| Slides the pitch of the previous note towards the current note by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>Hxy</code>'''
| Vibrato
| Yes
| Executes vibrato with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected vibrato waveform (see the [[#Waveform Types|Waveform Types table]] for more details). Shares memory with <abbr title="Fine Vibrato"><code>Uxy</code></abbr>.
| class="eff-pitch" | Pitch
|-
| '''<code>Ixy</code>'''
| Tremor
| Yes
| Rapidly switches the sample volume on and off. Volume is on for <code>x</code> ticks and off for <code>y</code> ticks. For instrument plugins {{Warning|(ModPlug hack)}}, this command sends note-on and note-off messages instead of modifying the volume.
| class="eff-vol" | Volume
|-
| '''<code>Jxy</code>'''
| Arpeggio
| Yes
| Plays an arpeggiation of three notes in one row, cycling between the current note, current note + <code>x</code> semitones, and current note + <code>y</code> semitones.
| class="eff-pitch" | Pitch
|-
| '''<code>Kxy</code>'''
| Volume Slide + Vibrato
| Yes
| Functions like <abbr title="Volume Slide"><code>Dxy</code></abbr> with <abbr title="Vibrato memory"><code>H00</code></abbr>. Parameters are used like <code>Dxy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Lxy</code>'''
| Volume Slide + Tone Portamento
| Yes
| Functions like <abbr title="Volume Slide"><code>Dxy</code></abbr> with <abbr title="Tone Portamento memory"><code>G00</code></abbr>. Parameters are used like <code>Dxy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Mxx</code>'''
| Set Channel Volume
| —
| Sets the current channel volume, which multiplies all note volumes it encompasses. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Nxy</code>'''
| Channel Volume Slide
| Yes
| Similar to <abbr title="Volume Slide"><code>Dxy</code></abbr>, but applies to the current channel's volume.
| class="eff-vol" | Volume
|-
| '''<code>Oxx</code>'''
| Sample Offset
| Yes
| Starts playing the current sample from position <code>xx</code> × 256, instead of position 0. Ineffective if there is no note in the same pattern cell.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Pxy</code>'''
| Panning Slide or Fine Panning Slide
| Yes
| Slides the current channel's panning position left or right.
* '''<code>P0y</code>''' slides the panning to the '''right''' by <code>y</code> units on every tick of the row except the first.
* '''<code>Px0</code>''' slides the panning to the '''left''' by <code>x</code> units on every tick of the row except the first.
* '''<code>PFy</code> finely''' slides the panning to the right by only applying <code>y</code> units on the first tick of the row. <code>y</code> cannot be Fh.
* '''<code>PxF</code> finely''' slides the panning to the left by only applying <code>x</code> units on the first tick of the row. <code>x</code> cannot be Fh.
| class="eff-pan" | Panning
|-
| '''<code>Qxy</code>'''
| Retrigger
| Yes
| Retriggers the current note every <code>y</code> ticks and changes the volume based on the <code>x</code> value (see the [[#Retrigger Volume|Retrigger Volume table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>Rxy</code>'''
| Tremolo
| Yes
| Executes tremolo with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected tremolo waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>S1x</code>'''
| Glissando Control
| <abbr title="Memory can be called with S00">—</abbr>
| {{Warning|This effect is not widely supported and behaves quirky in OpenMPT.}} Configures whether tone portamento effects slide by semitones or not.
* '''<code>S10</code> disables''' glissando.
* '''<code>S11</code> enables''' glissando.
| class="eff-pitch" | Pitch
|-
| '''<code>S2x</code>'''
| Set Finetune
| <abbr title="Memory can be called with S00">—</abbr>
| ''Considered a legacy command.'' Overrides the current sample's C-5 frequency with a MOD finetune value.
| class="eff-pitch" | Pitch
|-
| '''<code>S3x</code>'''
| Set Vibrato Waveform
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the waveform of future Vibrato effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>S4x</code>'''
| Set Tremolo Waveform
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the waveform of future Tremolo effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>S5x</code>'''
| Set Panbrello Waveform
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the waveform of future Panbrello effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>S6x</code>'''
| Fine Pattern Delay
| <abbr title="Memory can be called with S00">—</abbr>
| Extends the current row by <code>x</code> ticks. If multiple <code>S6x</code> commands are on the same row, the sum of their parameters is used.
| class="eff-global" | Global (Pattern)
|-

| '''<code>S70</code>'''
| Past Note Cut
| <abbr title="Memory can be called with S00">—</abbr>
| '''Cuts''' all notes playing as a result of New Note Actions on the current channel.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S71</code>'''
| Past Note Off
| <abbr title="Memory can be called with S00">—</abbr>
| '''Sends a Note Off''' to all notes playing as a result of New Note Actions on the current channel.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S72</code>'''
| Past Note Fade
| <abbr title="Memory can be called with S00">—</abbr>
| '''Fades out''' all notes playing as a result of New Note Actions on the current channel.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S73</code>'''
| NNA Note Cut
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the currently active note's New Note Action to '''Note Cut'''.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S74</code>'''
| NNA Note Continue
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the currently active note's New Note Action to '''Continue'''.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S75</code>'''
| NNA Note Off
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the currently active note's New Note Action to '''Note Off'''.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S76</code>'''
| NNA Note Fade
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the currently active note's New Note Action to '''Note Fade'''.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S77</code>'''
| Volume Envelope Off
| <abbr title="Memory can be called with S00">—</abbr>
| '''Disables''' the currently active note's '''volume''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S78</code>'''
| Volume Envelope On
| <abbr title="Memory can be called with S00">—</abbr>
| '''Enables''' the currently active note's '''volume''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S79</code>'''
| Panning Envelope Off
| <abbr title="Memory can be called with S00">—</abbr>
| '''Disables''' the currently active note's '''panning''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S7A</code>'''
| Panning Envelope On
| <abbr title="Memory can be called with S00">—</abbr>
| '''Enables''' the currently active note's '''panning''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S7B</code>'''
| Pitch Envelope Off
| <abbr title="Memory can be called with S00">—</abbr>
| '''Disables''' the currently active note's '''pitch''' or '''filter''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S7C</code>'''
| Pitch Envelope On
| <abbr title="Memory can be called with S00">—</abbr>
| '''Enables''' the currently active note's '''pitch''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S8x</code>'''
| Set Panning
| <abbr title="Memory can be called with S00">—</abbr>
| ''<abbr title="Set Panning"><code>Xxx</code></abbr> is a much finer panning effect.'' Sets the current channel's panning position. Ranges from 0h (left) to Fh (right).
| class="eff-pan" | Panning
|-
| '''<code>S9x</code>'''
| Sound Control
| <abbr title="Memory can be called with S00">—</abbr>
| {{Warning|1=Only <abbr title="Surround On"><code>S91</code></abbr> is an original Impulse Tracker command.}} Executes a sound control command (see the [[#Sound Control|Sound Control table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>SAx</code>'''
| High Offset
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the high offset for future <abbr title="Sample Offset"><code>Oxx</code></abbr> commands. <code>x</code> × 65536 (10000h) is added to all offset effects that follow this command.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SB0</code>'''
| Pattern Loop Start
| <abbr title="Memory can be called with S00">—</abbr>
| Marks the current row position to be used as the start of a pattern loop.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SBx</code>'''
| Pattern Loop
| <abbr title="Memory can be called with S00">—</abbr>
| Each time this command is reached, jumps to the row marked by <abbr title="Pattern Loop Start"><code>SB0</code></abbr> until <code>x</code> jumps have occurred in total. If <code>SBx</code> is used in a pattern with no <code>SB0</code> effect, <code>SBx</code> will use the row position marked by any previous <code>SB0</code> effect. Pattern loops cannot span multiple patterns. Ranges from 1h to Fh.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SCx</code>'''
| Note Cut
| <abbr title="Memory can be called with S00">—</abbr>
| Stops the current sample after <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, this command is ignored. If <code>x</code> is 0, it will be treated as if it were 1.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SDx</code>'''
| Note Delay
| <abbr title="Memory can be called with S00">—</abbr>
| Delays the note or instrument change in the current pattern cell by <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, the current cell's contents are not played. If <code>x</code> is 0, it will be treated as if it were 1.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SEx</code>'''
| Pattern Delay
| <abbr title="Memory can be called with S00">—</abbr>
| Repeats the current row <code>x</code> times. Notes are not retriggered on every repetition, but effects are still processed. If multiple <code>SEx</code> commands are on the same row, only the leftmost command is used.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SFx</code>'''
| Set Active Macro
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the current channel's active [[Manual: Zxx Macros#Parametered Macros|parametered macro]].
| class="eff-misc" | Miscellaneous
|-
| '''<code>T0x</code>'''
| Decrease Tempo
| Yes
| Decreases the module Tempo by <code>x</code> BPM on every tick of the row except the first.
| class="eff-global" | Global (Timing)
|-
| '''<code>T1x</code>'''
| Increase Tempo
| Yes
| Increases the module Tempo by <code>x</code> BPM on every tick of the row except the first.
| class="eff-global" | Global (Timing)
|-
| '''<code>Txx</code>'''
| Set Tempo
| No
| Sets the module Tempo if <code>xx</code> is greater than or equal to 20h.
| class="eff-global" | Global (Timing)
|-
| '''<code>Uxy</code>'''
| Fine Vibrato
| Yes
| Similar to <abbr title="Vibrato"><code>Hxy</code></abbr>, but with 4 times the precision. Shares memory with <code>Hxy</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Vxx</code>'''
| Set Global Volume
| —
| Sets the global volume. Ranges from 00h (off) to 80h (full).
| class="eff-vol" | Volume
|-
| '''<code>Wxy</code>'''
| Global Volume Slide
| Yes
| Similar to <abbr title="Volume Slide"><code>Dxy</code></abbr>, but applies to the global volume.
| class="eff-vol" | Volume
|-
| '''<code>Xxx</code>'''
| Set Panning
| —
| Sets the current channel's panning position. Ranges from 00h (left) to FFh (right).
| class="eff-pan" | Panning
|-
| '''<code>Yxy</code>'''
| Panbrello
| Yes
| Executes panbrello with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected panbrello waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>Zxx</code>'''
| MIDI Macro
| —
| Executes a [[Manual: Zxx Macros|MIDI Macro]].
| class="eff-misc" | Miscellaneous
|-
| '''<code>\xx</code>'''
| Smooth MIDI Macro
| —
| {{Warning|This effect is a ModPlug hack.}} Executes an interpolated MIDI Macro.
| class="eff-misc" | Miscellaneous
|}

=== Volume Column ===

The following commands can be entered into the volume column.

All parameter values are '''decimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| <code>'''a0x'''</code>
| Fine Volume Slide Up
| Yes
| Functions like <abbr title="Fine Volume Slide Up"><code>DxF</code></abbr> (slides the volume up <code>x</code> units on the first tick).
| class="eff-vol" | Volume
|-
| <code>'''b0x'''</code>
| Fine Volume Slide Down
| Yes
| Functions like <abbr title="Fine Volume Slide Down"><code>DFy</code></abbr> (slides the volume down <code>x</code> units on the first tick).
| class="eff-vol" | Volume
|-
| <code>'''c0x'''</code>
| Volume Slide Up
| Yes
| Functions like <abbr title="Volume Slide Up"><code>Dx0</code></abbr> (slides the volume up <code>x</code> units on all ticks except the first).
| class="eff-vol" | Volume
|-
| <code>'''d0x'''</code>
| Volume Slide Down
| Yes
| Functions like <abbr title="Volume Slide Down"><code>D0y</code></abbr> (slides the volume down <code>x</code> units on all ticks except the first).
| class="eff-vol" | Volume
|-
| <code>'''e0x'''</code>
| Portamento Down
| Yes
| Similar to <abbr title="Portamento Down"><code>Exx</code></abbr>. Compared to <code>Exx</code>, parameters are 4 times more coarse (e.g. <code>e01</code> = <abbr title="Portamento Down by 4 units"><code>E04</code></abbr>).
| class="eff-pitch" | Pitch
|-
| <code>'''f0x'''</code>
| Portamento Up
| Yes
| Similar to <abbr title="Portamento Up"><code>Fxx</code></abbr>. Compared to <code>Fxx</code>, parameters are 4 times more coarse (e.g. <code>f01</code> = <abbr title="Portamento Up by 4 units"><code>F04</code></abbr>).
| class="eff-pitch" | Pitch
|-
| <code>'''g0x'''</code>
| Tone Portamento
| Yes
| Similar to <abbr title="Tone Portamento"><code>Gxx</code></abbr>. Below is a table that translates <code>g0x</code> parameters to <code>Gxx</code> parameters:
{|
|-
|
{| class="wikitable"
|-
! <tt>g0x</tt> !! <tt>Gxx</tt>
|-
| <code>g00</code> || <code>G00</code>
|-
| <code>g01</code> || <code>G01</code>
|-
| <code>g02</code> || <code>G04</code>
|-
| <code>g03</code> || <code>G08</code>
|-
| <code>g04</code> || <code>G10</code>
|}
|
{| class="wikitable"
|-
! <tt>g0x</tt> !! <tt>Gxx</tt>
|-
| <code>g05</code> || <code>G20</code>
|-
| <code>g06</code> || <code>G40</code>
|-
| <code>g07</code> || <code>G60</code>
|-
| <code>g08</code> || <code>G80</code>
|-
| <code>g09</code> || <code>GFF</code>
|}
|}
| class="eff-pitch" | Pitch
|-
| <code>'''h0x'''</code>
| Vibrato Depth
| Yes
| Executes a vibrato with depth <code>x</code> and speed from the last <abbr title="Vibrato"><code>Hxy</code></abbr> or <abbr title="Fine Vibrato"><code>Uxy</code></abbr> command.
| class="eff-pitch" | Pitch
|-
| <code>'''pxx'''</code>
| Set Panning
| —
| Sets the current channel's panning position to <code>xx</code>. Ranges from 0 to 64.
| class="eff-pan" | Panning
|-
| <code>'''vxx'''</code>
| Set Volume
| —
| Sets the current note volume to <code>xx</code>. The behaviour of this command when sent to instrument plugins can be configured in the [[Manual: Instruments#Plugin / MIDI|Instrument Editor]] {{Warning|(ModPlug hack)}}.
| class="eff-vol" | Volume
|}

'''† Effect Memory:''' 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''No''' means that the command does nothing.
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>H82</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>H00</code></abbr> on a subsequent row, the <code>H00</code> command recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Global Volume"><code>V00</code></abbr> sets the global volume to 0, <abbr title="Set Panning"><code>X00</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.

: '''Volume Column Effect Memory:'''
:* All volume slide effects in the volume column share effect memory with each other.
:* <abbr title="Portamento Down"><code>e0x</code></abbr> and <abbr title="Portamento Up"><code>f0x</code></abbr> share effect memory with <abbr title="Portamento Down"><code>Exx</code></abbr> and <abbr title="Portamento Up"><code>Fxx</code></abbr> (respectively).

== MPTM Effect Commands ==

OpenMPT′s MPTM format is heavily based on the IT format and [[#IT Effect Commands|its effect command set]], but it does add several new features.

=== Effect Column ===

OpenMPT's MPTM format generally uses the same effect commands as the IT format. Commands from the IT section that are labeled as ModPlug hacks or unsupported by Impulse Tracker may be freely used in the MPTM format.

The following additional commands, exclusive to the MPTM format, can be entered in the effect column.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>S7D</code>'''
| Force Pitch Envelope
| <abbr title="Memory can be called with S00">—</abbr>
| Enables the currently active note's pitch envelope and forces it to act as a pitch envelope (rather than a filter cutoff envelope).
| class="eff-misc" | Miscellaneous
|-
| '''<code>S7E</code>'''
| Force Filter Envelope
| <abbr title="Memory can be called with S00">—</abbr>
| Enables the currently active note's pitch envelope and forces it to act as a filter cutoff envelope (rather than a pitch envelope).
| class="eff-misc" | Miscellaneous
|-
| '''<code>:xy</code>'''
| Note Delay + Cut
| —
| Delays the note in the current pattern cell by <code>x</code> ticks and cuts it after <code>x</code> + <code>y</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, the note will be ignored (and as such, cannot be cut with <code>y</code>). If <code>x</code> + <code>y</code> is greater than or equal to the current module Speed, only the note cut will be ignored.
| class="eff-misc" | Miscellaneous
|-
| '''<code>#xx</code>'''
| Parameter Extension
| —
| Extends the parameter of the last <abbr title="Position Jump"><code>Bxx</code></abbr>, <abbr title="Pattern Break"><code>Cxx</code></abbr>, <abbr title="Sample Offset"><code>Oxx</code></abbr>, <abbr title="Set Tempo"><code>Txx</code></abbr>, <abbr title="Finetune"><code>+xx</code></abbr> or <abbr title="Finetune (Smooth)"><code>*xx</code></abbr> command. If placed after such a command, the parameter values are combined. If there is only one <code>#xx</code> command below the actual command (the limit for <code>Bxx</code>, <code>Cxx</code>, and <code>Txx</code>), the original command is multiplied by 256 and then parameter <code>xx</code> is added to it. For <code>Oxx</code>, up to 4 rows can be combined. The fourth row is multiplied by 1, the third by 256 (100h), the second by 65536 (10000h), and so on.

'''Example:'''
<pattern>
ModPlug Tracker MPT
|C-501...O21
|........#02
|........#01
</pattern>
In this example, the '''hexadecimal''' sample offset is (21h × 10000h) + (2h × 100h) + 1h = 210201h. In '''decimal''', it is (33 × 65536) + (2 × 256) + 1 = 2,163,201.
| class="eff-misc" | Miscellaneous
|-
| '''<code>+xx</code>'''
| Finetune
| —
| Changes the current note’s tuning. <code>+80</code> is center (no change to the tuning), lower values decrease the tuning and higher values increase the tuning. In sample mode, the depth of this command is fixed at ±1 semitone. For sample-based instruments, the depth is defined by the instrument’s [[Manual: Instruments#Plugin / MIDI|pitch bend range]] setting. For plugins, this command directly translates to MIDI pitch bend commands, so the depth is whatever the pitch bend depth of the plugin or MIDI device is set to. This command can be extended by <code>#xx</code> Parameter extensions for even finer control over the tuning.
| class="eff-pitch" | Pitch
|-
| '''<code>*xx</code>'''
| Finetune (Smooth)
| —
| Exactly the same as <abbr title="Finetune"><code>+xx</code></abbr>, but slides from the previous finetune value to the new value on every tick of the row.
| class="eff-pitch" | Pitch
|}

=== Volume Column ===

In addition to all of the IT format's [[#Volume Column_3|volume column commands]], the following commands can be entered in the volume column.

All parameter values are '''decimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>o0x</code>'''
| Sample Cue
| Yes
| Starts playing the current sample from cue point <code>x</code>, instead of position 0. Cue points can be chosen in the [[Manual: Samples#Sample Display Context Menu|Sample Editor]]. Ineffective if there is no note in the same pattern cell. Shares effect memory with <abbr title="Sample Offset"><code>Oxx</code></abbr> and can be [[#Combined Commands|combined]] with that command.
| class="eff-misc" | Miscellaneous
|}

'''† Effect Memory:''' 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>H82</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>H00</code></abbr> on a subsequent row, the <code>H00</code> command recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Global Volume"><code>V00</code></abbr> sets the global volume to 0, <abbr title="Set Panning"><code>X00</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.

=== Combined Commands ===

By combining the volume column <abbr title="Sample Cue"><code>oxx</code></abbr> and effect column <abbr title="Sample Offset"><code>Oxx</code></abbr> commands, two special offset behaviours can be achieved:
* <code>o00</code> + <code>Oxx</code>: A cue point command with a parameter of 0 turns the effect column offset into a percentage offset, i.e. the command jumps to <code>xx</code> × 1/256th of the total sample length. For example <code>o00</code> + <code>O80</code> plays the second half of any sample. Further precision can be achieved by combining the <code>Oxx</code> command with <code>#xx</code>.
* <code>o0x</code> + <code>Oyy</code>: For <code>x</code> > 0, the effect column <code>Oyy</code> is added on top of the cue point, so <code>o05</code> + <code>O01</code> plays from the 5th cue point of the sample + 256 samples.

=== AdLib / OPL3 Instruments ===
OpenMPT supports AdLib / OPL3 instruments in the MPTM format, but not all effects are compatible with them. Below is a list of effects that do not function with AdLib / OPL3 instruments in MPTM files:
* <code>Oxx</code> (Sample Offset)
* <code>S9x</code> (Sound Control) parameters other than Ch and Dh (Global & Local Filters)
* <code>SAx</code> (High Offset)
* <code>o0x</code> (Sample Cue)

Additionally, since AdLib / OPL3 instruments only support hard left, center, and hard right panning, the range of <abbr title="Set Panning"><code>Xxx</code></abbr> and <abbr title="Set Panning"><code>pxx</code></abbr> are effectively restricted to those positions. Panning Slides like <abbr title="Panning Slide"><code>Pxy</code></abbr> and <abbr title="Panbrello"><code>Yxy</code></abbr> work with the same reduced granularity, but should be best avoided if possible.

=== Parameter Control Events ===

Another feature similar to effects that is only available in MPTM files are [[Manual: Parameter Control Events|Parameter Control Events]], which can be used to automate plugin parameters.

[[Category:Manual|Effect Reference]]
[[de:Handbuch: Effektbefehle]]

Manual: Setup/DSP

2025-06-01T18:16:07Z

Saga Musix: /* Reverb */

[[Image:Settings DSP.png|thumb|350px|DSP tab of the settings dialog]]

This page contains settings for audio post-processing effects that OpenMPT can apply. Keep in mind these settings are '''not''' saved with modules, but '''are''' applied to '''all''' tracks during playback and when exporting tracks to a streaming audio format (such as WAV).

Most are self-explanatory, but '''it is not recommended to enable any of these options'''. In order for any of them to be applied, you must enable the appropriate checkboxes.

== Equalizer ==

Playback audio is processed through the Equalizer only if the “Enable Graphic Equalizer” checkbox is set. The Equalizer settings are not saved with the song; they are a global setting applied to any output from OpenMPT. For this reason, do '''not''' use this equalizer as part of your production process; only use it to correct deficiencies in your audio hardware.

=== Equalizer Band Sliders ===
Move a slider higher to accentuate or bring out those frequencies, or lower to diminish the volume of those frequencies. Right-clicking on a slider shows a context menu from which you can change the center frequency for the selected band. The equalizer bands are by default set at 0 dB, which means no attenuation is applied to that band of frequencies.

=== Presets ===
Clicking one of the buttons next to the sliders chooses a preset equalizer setting. You can save your own preset (up to four) by adjusting the equalizer to the desired settings, then clicking “Save Preset”.

== DSP ==

=== Automatic Gain Control ===

The Automatic Gain Control (also abbreviated as AGC) applies a compressor / limiter-type effect that monitors and keeps the volume within a more-or-less steady amplification.
Softer sections will be made louder and loud sections will be softened in volume.

=== Bit Crush ===

Reduces the effective bit depth of the signal, e.g to emulate old hardware or trackers that only supported 8-bit output.

=== Bass Expansion ===

Applies a volume boost to the bass frequencies. Move the first slider to adjust bass gain, and the second slider to increase the frequency range to affect.
Best used without the equalizer, or not at all (time to get some proper speakers ;-).

=== Reverb ===

Applies a Reverb to sample output (not plugin output).
Move the slider to increase the reverb’s volume, and choose a Reverb type from the popup menu next to it.
Note that reverb can be explicitly turned on and off per pattern channel using effect commands.
However, since the reverb parameters are not stored with the module and cannot be changed using pattern commands, it is not recommended to rely on this setting.
It is wiser to use a dedicated reverb plugin such as [[Manual: I3DL2Reverb Plugin|I3DL2Reverb]] or [[Manual: WavesReverb Plugin|WavesReverb]] if you want reverb.

=== Pro-Logic Surround ===

Applies Surround Sound to the sound output.
When listening to music in stereo, this will mostly be noticeable as a slightly delayed echo signal with “wider” stereo sound, but in quad surround mode, the delayed signal is actually played on the rear speakers.
Move the first slider to set the amount of the Surround effect and the second slider to configure the delay of the echo signal.

[[Category:Manual|Setup/DSP]]
[[de:Handbuch: Setup/DSP]]

Manual: Effect Reference

2025-06-01T18:13:58Z

Saga Musix:

This is a list of all effects that can be used in the [[Manual: Patterns|Pattern Editor]]. 
Commands that go into the effect column use '''uppercase''' effect letters (e.g. <code>G05</code>), while effects that go into the volume column use '''lowercase''' effect letters (e.g. <code>g05</code>).

The MOD and XM formats share a similar set of effects, with XM offering more effects than MOD. The S3M, IT, and MPTM formats share a different set of effects, of which many are compatible to those from the MOD and XM formats but have different letters (e.g. <code>F75</code> in MOD turns into <code>T75</code> in S3M).

Currently, some effects, in particular those related to volume and panning, only directly affect samples, not instrument plugins (but their effect may be observed by a plugin through [[Manual: Zxx Macros|MIDI macros]]). Since this might change in the future, such effects should be avoided on channels that make use of instrument plugins.

The behaviour of some effects is influenced by the [[Manual: Compatible Playback|Compatible Playback]] settings.

== Effect Layout ==
{| class="wikitable" style="float:right; margin:10px;"
|
<code>'''A'''xy</code>: Effect letter 
<code>A'''xy'''</code>: Parameter
|}
An effect command consists of one character (the '''“effect letter”''') followed by the value that will be applied (the '''“parameter”'''), which is a '''[[Manual: Basics#Hexadecimal Notation|hexadecimal]]''' number in the effect column and a '''decimal''' number in the volume column. 

If the notation for a parameter is given as '''<code>xx</code>''', it means that a 2-digit hexadecimal number is expected. For this notation, 62h would be equal to 98, 29h would be equal to 41, and E8h would be equal to 232.

If the notation is '''<code>xy</code>''', it means that for <code>x</code> and <code>y</code> each, a 1-digit hexadecimal number is expected. For this notation, each of the digits in 62h would be read separately — as 6 and 2. Similarly, 29h would mean 2 and 9, and E8h would mean 14 and 8.

If you do not wish to manually convert decimal to hexadecimal and vice versa, you can double-click on a pattern cell or press the <kbd>▤ Application</kbd> key (by default) to open the [[Manual: Note Properties|Note Properties]] dialog. From there, you can adjust the effect parameters using sliders and see their meaning.

Note that the parameter range of some commands is limited, such as the XM command <abbr title="Set Volume"><code>Cxx</code></abbr>, whose maximum value is 40h (64). Entering out-of-range values is not recommended as they might be interpreted differently by non-conforming players.

== Frequency Units ==

If [[Manual: Song Properties#Linear Frequency Slides|Linear Frequency Slides]] are enabled, each unit of a pitch sliding effect (e.g. <abbr title="Portamento Down"><code>Exx</code></abbr> or <abbr title="Tone Portamento"><code>Gxx</code></abbr> in the IT / MPTM format) is equal to 1⁄16 of a semitone. Extra fine (e.g. <abbr title="Extra Fine Portamento Down"><code>EEx</code></abbr> or <abbr title="Extra Fine Portamento Up"><code>FEx</code></abbr>) units are equal to 1⁄64 of a semitone.

Otherwise, the unit of a pitch sliding effect is one ''period'', a metric inverse to frequency. This means that the lower the current note, the smaller the effect of one pitch slide unit, and the higher the note, the bigger the effect is. The period of a frequency can be calculated by dividing 3,546,895 by the frequency (3,579,364 in the XM format).

Linear Frequency Slides are not available in the MOD and S3M formats.

== Common Effect Parameters ==

Most effect parameters follow a simple scheme, but some effects also use a look-up table for their parameters. Depending on the effect, different parameters might do completely different things. Some common look-up table effects are described below.

=== Waveform Types ===

Some oscillator effects (namely Vibrato, Tremolo and Panbrello) use preset oscillator waveforms. They can be changed using special commands; the possible parameters of these commands are listed here.
{|
| style="text-align:center;" |
==== S3M / IT / MPTM Formats ====

{| class="wikitable" style="text-align:left; margin-right:10px;"
|-
! Parameter !! Waveform
|-
| '''0''' (default) || Sine (retrigger)
|-
| '''1''' || Sawtooth (retrigger)
|-
| '''2''' || Square (retrigger)
|-
| '''3''' || Random (retrigger)
|}

| style="text-align:center;" |
==== MOD / XM Formats ====

{| class="wikitable" style="text-align:left;"
|-
! Parameter !! Waveform !! Parameter !! Waveform
|-
| '''0''' (default) || Sine (retrigger) || '''4''' || Sine (continue)
|-
| '''1''' || Sawtooth (retrigger) || '''5''' || Sawtooth (continue)
|-
| '''2''' || Square (retrigger) || '''6''' || Square (continue)
|-
| '''3''' || Random† (retrigger) || '''7''' || Random† (continue)
|}
|}

'''Retrigger''' means that the oscillator waveform is played from its starting point when a new note is played. 
'''Continue''' means that the waveform continues at its last playback position when a new note is played. This waveform type is exclusive to the MOD and XM formats.

Every oscillator waveform is 64 points long, and the speed parameter denotes by how many points per tick the play position is advanced. So at a vibrato speed of 2, the vibrato waveform repeats after 32 ticks.

† The '''Random''' waveforms are not supported by ProTracker and FastTracker. While they are supported by some MOD / XM players, they should be avoided.

=== Retrigger Volume ===

The Retrigger command (<code>Rxy</code> in the XM format, <code>Qxy</code> in the S3M / IT / MPTM formats) does not only retrigger the note every <code>y</code> ticks, but also changes the note volume depending on the <code>x</code> value.

The following table explains the meaning of every possible <code>x</code> parameter:

{| class="wikitable"
|-
! Parameter !! Effect !! Parameter !! Effect
|-
| '''0''' || (XM) Last <code>x</code> value (S3M / IT / MPTM) No volume change || '''8''' || No volume change
|-
| '''1''' || Volume - 1 || '''9''' || Volume + 1
|-
| '''2''' || Volume - 2 || '''A''' || Volume + 2
|-
| '''3''' || Volume - 4 || '''B''' || Volume + 4
|-
| '''4''' || Volume - 8 || '''C''' || Volume + 8
|-
| '''5''' || Volume - 16 || '''D''' || Volume + 16
|-
| '''6''' || Volume × ⅔ || '''E''' || Volume × 1.5
|-
| '''7''' || Volume × ½ || '''F''' || Volume × 2
|}

=== Sound Control ===

The sound control effect (<code>X9x</code> in the XM format, <code>S9x</code> in the S3M / IT / MPTM formats) can be used to control various aspects of sound playback. Possible parameters are listed here.

<big>{{Warning|1=Using any of these commands outside of the MPTM format (except <abbr title="Surround On"><code>S91</code></abbr> which is native to only the IT and MPTM formats) is considered a ModPlug hack.}}</big>

{| class="wikitable"
|-
! Parameter
! Name
! Description
|-
| '''0'''
| Surround Off
| Disables surround playback on the current channel. This should only be used when using Quad Surround Panning. To keep compatibility with other trackers, a normal panning effect should be used in Center Surround mode.
|-
| '''1'''
| Surround On
| Enables surround playback on the current channel. When using stereo playback, the right channel of a sample is played with inversed phase (Pro Logic Surround). When using quad playback, the rear channels are used for playing this channel.
|-
| '''8'''
| Reverb Off
| Disables Reverb on the current channel.
|-
| '''9'''
| Reverb On
| {{Warning|As there is no per-song configuration for reverb available, use of this command is discouraged. Use a reverb plugin such as [[Manual: I3DL2Reverb Plugin|I3DL2Reverb]] or [[Manual: WavesReverb Plugin|WavesReverb]] instead.}} Enables Reverb on the current channel. The reverb parameters from the [[Manual: Setup/DSP|DSP Setup]] are used.
|-
| '''A'''
| Center Surround
| Sets the surround mode to Center Surround for all channels. This is the default mode. The <abbr title="Surround On"><code>S91</code></abbr> command will place the channel in the center of the rear channels. Any panning command will bring it back to the front channels.
|-
| '''B'''
| Quad Surround
| Sets the surround mode to Quad Surround for all channels. In this mode, panning commands can adjust the position of the rear channels. Switching between the front and rear channels can only be done by using the <abbr title="Surround On"><code>S91</code></abbr> and <abbr title="Surround Off"><code>S90</code></abbr> commands.
|-
| '''C'''
| Global Filters
| Sets filter mode to Global on all channels (Impulse Tracker behaviour). In this mode, when resonant filters are enabled with a <abbr title="MIDI Macro"><code>Zxx</code></abbr> effect, they will stay active until explicitly disabled by setting the cutoff frequency to the maximum (<code>Z7F</code>), and the resonance to the minimum (<code>Z80</code>).
|-
| '''D'''
| Local Filters
| Sets filter mode to Local on all channels. In this mode, the resonant filter will only affect the current note and will revert when a new note is played.
|-
| '''E'''
| Play Forward
| Forces the current sample to play forward.
|-
| '''F'''
| Play Backward
| Forces the current sample to play backward.
|}

== MOD Effect Commands ==

=== Effect Column ===

The MOD format only allows use of the effect column; there are no volume column commands.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>0xy</code>'''
| Arpeggio
| No
| Plays an arpeggiation of three notes in one row, cycling between the current note, current note + <code>x</code> semitones, and current note + <code>y</code> semitones.
| class="eff-pitch" | Pitch
|-
| '''<code>1xx</code>'''
| Portamento Up
| No
| Increases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>2xx</code>'''
| Portamento Down
| No
| Decreases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>3xx</code>'''
| Tone Portamento
| Yes
| Slides the pitch of the previous note towards the current note by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>4xy</code>'''
| Vibrato
| Yes
| Executes vibrato with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected vibrato waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>5xy</code>'''
| Volume Slide + Tone Portamento
| <abbr title="500 will call Tone Portamento memory">No</abbr>
| Functions like <abbr title="Volume Slide"><code>Axy</code></abbr> with <abbr title="Tone Portamento memory"><code>300</code></abbr>. Parameters are used like <code>Axy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>6xy</code>'''
| Volume Slide + Vibrato
| <abbr title="600 will call Vibrato memory">No</abbr>
| Functions like <abbr title="Volume Slide"><code>Axy</code></abbr> with <abbr title="Vibrato memory"><code>400</code></abbr>. Parameters are used like <code>Axy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>7xy</code>'''
| Tremolo
| Yes
| Executes tremolo with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected tremolo waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>8xx</code>'''
| Set Panning
| —
| Sets the current channel's panning position. Ranges from 00h (left) to FFh (right).
| class="eff-pan" | Panning
|-
| '''<code>9xx</code>'''
| Sample Offset
| Yes
| Starts playing the current sample from position <code>xx</code> × 256, instead of position 0. Ineffective if there is no note in the same pattern cell.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Axy</code>'''
| Volume Slide
| No
| Slides the current note volume up or down.
* '''<code>A0y</code>''' '''decreases''' note volume by <code>y</code> units on every tick of the row except the first.
* '''<code>Ax0</code>''' '''increases''' note volume by <code>x</code> units on every tick of the row except the first.
| class="eff-vol" | Volume
|-
| '''<code>Bxx</code>'''
| Position Jump
| —
| Causes playback to jump to pattern position <code>xx</code>. <code>B00</code> would restart a song from the beginning (first pattern in the Order List). If <abbr title="Pattern Break"><code>Dxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Dxx</code> jumps in. Ranges from 00h to 7Fh (127; maximum amount of patterns for the MOD format).
| class="eff-global" | Global (Pattern)
|-
| '''<code>Cxx</code>'''
| Set Volume
| —
| Sets the current note volume to <code>xx</code>. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Dxx</code>'''
| Pattern Break
| —
| Jumps to row <code>xx</code> of the next pattern in the Order List. If the current pattern is the last pattern in the Order List, <code>Dxx</code> will jump to row <code>xx</code> of the first pattern. If <abbr title="Position Jump"><code>Bxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Dxx</code> jumps in. Ranges from 00h to 3Fh (64; maximum amount of rows for each pattern in the MOD format).
| class="eff-global" | Global (Pattern)
|-
| '''<code>E0x</code>'''
| Set Filter
| —
| Configures the Amiga's LED lowpass filter.
* '''<code>E00</code>''' '''enables''' emulation of the lowpass filter.
* '''<code>E01</code>''' '''disables''' emulation of the lowpass filter.
Enabling the filter makes the sound output more muffled and is not recommended. Using this effect is only recommended to explicitly disable the filter for environments where it might not be disabled by default (such as a real Amiga system). OpenMPT only emulates the lowpass filter if the [[Manual: Setup/Mixer#Use Amiga resampler for Amiga modules|Amiga resampler]] is enabled in the Mixer settings.
| class="eff-misc" | Miscellaneous
|-
| '''<code>E1x</code>'''
| Fine Portamento Up
| No
| Similar to <abbr title="Portamento Up"><code>1xx</code></abbr>, but only applies on the first tick of the row.
| class="eff-pitch" | Pitch
|-
| '''<code>E2x</code>'''
| Fine Portamento Down
| No
| Similar to <abbr title="Portamento Down"><code>2xx</code></abbr>, but only applies on the first tick of the row.
| class="eff-pitch" | Pitch
|-
| '''<code>E3x</code>'''
| Glissando Control
| —
| {{Warning|This effect is not widely supported and behaves quirky in OpenMPT.}} Configures whether tone portamento effects slide by semitones or not.
* '''<code>E30</code> disables''' glissando.
* '''<code>E31</code> enables''' glissando.
| class="eff-pitch" | Pitch
|-
| '''<code>E4x</code>'''
| Set Vibrato Waveform
| —
| Sets the waveform of future Vibrato effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>E5x</code>'''
| Set Finetune
| —
| Overrides the finetune value for the currently playing note. Functions similarly to the same setting in the Sample Editor but is only applied temporarily. This command only works with a note next to it.
| class="eff-pitch" | Pitch
|-
| '''<code>E60</code>'''
| Pattern Loop Start
| —
| Marks the current row position to be used as the start of a pattern loop.
| class="eff-global" | Global (Pattern)
|-
| '''<code>E6x</code>'''
| Pattern Loop
| —
| Each time this command is reached, jumps to the row marked by <abbr title="Pattern Loop Start"><code>E60</code></abbr> until <code>x</code> jumps have occured in total. If <code>E6x</code> is used in a pattern with no <code>E60</code> effect, <code>E6x</code> will use the row position marked by any previous <code>E60</code> effect. Pattern loops cannot span multiple patterns. Ranges from 1h to Fh.
| class="eff-global" | Global (Pattern)
|-
| '''<code>E7x</code>'''
| Set Tremolo Waveform
| —
| Sets the waveform of future Tremolo effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>E8x</code>'''
| Set Panning
| —
| ''<abbr title="Set Panning"><code>8xx</code></abbr> is a much finer panning effect.'' Sets the current channel's panning position. Ranges from 0h (left) to Fh (right).
| class="eff-pan" | Panning
|-
| '''<code>E9x</code>'''
| Retrigger
| No
| Retriggers the current note every <code>x</code> ticks. This effect works with parameters greater than the current Speed setting if the row after it also contains an <code>E9x</code> effect.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EAx</code>'''
| Fine Volume Slide Up
| No
| Similar to <abbr title="Volume Slide Up"><code>Ax0</code></abbr>, but only applies on the first tick of the row.
| class="eff-vol" | Volume
|-
| '''<code>EBx</code>'''
| Fine Volume Slide Down
| No
| Similar to <abbr title="Volume Slide Down"><code>A0y</code></abbr>, but only applies on the first tick of the row.
| class="eff-vol" | Volume
|-
| '''<code>ECx</code>'''
| Note Cut
| —
| Sets note volume to 0 after <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, this command is ignored.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EDx</code>'''
| Note Delay
| —
| Delays the note or instrument change in the current pattern cell by <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, the current pattern cell's contents are never played.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EEx</code>'''
| Pattern Delay
| —
| Repeats the current row <code>x</code> times. Notes are not retriggered on every repetition, but effects are still processed. If multiple <code>EEx</code> commands are found on the same row, only the rightmost is considered.
| class="eff-global" | Global (Pattern)
|-
| '''<code>EFx</code>'''
| Invert Loop
| —
| {{Warning|This effect permanently modifies the module file when encountered during playback.}}
* '''<code>EFx</code>''', when used with a looped sample, goes through the sample loop and inverts all sampling points (i.e. changes the sign) one by one at speed <code>x</code>.
* '''<code>EF0</code>''' cancels <code>EFx</code>.
Samples modified by this effect cannot be recovered automatically (e.g. no undo point is created).
| class="eff-misc" | Miscellaneous
|-
| '''<code>Fxx</code>'''
| Set Speed / Tempo
| —
| {{Warning|Avoid using 20h or 00h as parameters.}}
* Sets the module '''Speed''' (ticks per row) if <code>xx</code> is less than 20h.
* Sets the module '''Tempo''' if <code>xx</code> greater than or equal to 20h.
Some players (including old OpenMPT versions) differ in their interpretations of <code>F20</code>. <code>F00</code> does nothing in OpenMPT, but some players stop the song when they encounter it.
| class="eff-global" | Global (Timing)
|}

'''† Effect Memory''': 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''No''' means that the command does nothing.
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>482</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>400</code></abbr> on a subsequent row, the <code>400</code> effect recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Volume"><code>C00</code></abbr> sets note volume to 0, <abbr title="Set Panning"><code>800</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.

== XM Effect Commands ==

Fasttracker II's XM format uses an extended version of the MOD command set.

As Fasttracker II was a rather buggy program, many effect commands may behave in a quirky way. Always enable the default [[Manual: Compatible Playback#XM compatibility settings|FT2 compatible playback settings]] for the best possible emulation of those quirks.

=== Effect Column ===

Some effects and features mentioned here are not actually part of the original XM format specifications. They will be labeled '''ModPlug hacks''', as they are not compatible with Fasttracker II. Use of these effects in the XM format is strongly discouraged; if you wish to use them, you should use a different format with equivalent, natively implemented effects.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>0xy</code>'''
| Arpeggio
| No
| Plays an arpeggiation of three notes in one row, cycling between the current note, current note + <code>x</code> semitones, and current note + <code>y</code> semitones.
| class="eff-pitch" | Pitch
|-
| '''<code>1xx</code>'''
| Portamento Up
| Yes
| Increases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>2xx</code>'''
| Portamento Down
| Yes
| Decreases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>3xx</code>'''
| Tone Portamento
| Yes
| Slides the pitch of the previous note towards the current note by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>4xy</code>'''
| Vibrato
| Yes
| Executes vibrato with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected vibrato waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>5xy</code>'''
| Volume Slide + Tone Portamento
| Yes
| Functions like <abbr title="Volume Slide"><code>Axy</code></abbr> with <abbr title="Tone Portamento memory"><code>300</code></abbr>. Parameters are used like <code>Axy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>6xy</code>'''
| Volume Slide + Vibrato
| Yes
| Functions like <abbr title="Volume Slide"><code>Axy</code></abbr> with <abbr title="Vibrato memory"><code>400</code></abbr>. Parameters are used like <code>Axy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>7xy</code>'''
| Tremolo
| Yes
| Executes tremolo with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected tremolo waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>8xx</code>'''
| Set Panning
| —
| Sets the current sample's panning position. As every sample has an enforced default panning, this setting is reset by any future entries in the instrument column. Ranges from 00h (left) to FFh (right).
| class="eff-pan" | Panning
|-
| '''<code>9xx</code>'''
| Sample Offset
| Yes
| Starts playing the current sample from position <code>xx</code> × 256, instead of position 0. Ineffective if there is no note in the same pattern cell.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Axy</code>'''
| Volume Slide
| Yes
| Slides the current note volume up or down.
* '''<code>A0y</code>''' '''decreases''' note volume by <code>y</code> units on every tick of the row except the first.
* '''<code>Ax0</code>''' '''increases''' note volume by <code>x</code> units on every tick of the row except the first.
| class="eff-vol" | Volume
|-
| '''<code>Bxx</code>'''
| Position Jump
| —
| Causes playback to jump to pattern position <code>xx</code>. <code>B00</code> would restart a song from the beginning (first pattern in the Order List). If <abbr title="Pattern Break"><code>Dxx</code></abbr> is on the same row and '''to the right''' of <code>Bxx</code>, the pattern specified by <code>Bxx</code> will be the pattern <code>Dxx</code> jumps in.
| class="eff-global" | Global (Pattern)
|-
| '''<code>Cxx</code>'''
| Set Volume
| —
| Sets the current note volume to <code>xx</code>. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Dxx</code>'''
| Pattern Break
| —
| {{Warning|To maintain compatibility with Fasttracker II, you should not jump past row 3Fh (63).}} Jumps to row <code>xx</code> of the next pattern in the Order List. If the current pattern is the last pattern in the Order List, <code>Dxx</code> will jump to row <code>xx</code> of the first pattern. If <abbr title="Position Jump"><code>Bxx</code></abbr> is on the same row and '''to the left''' of <code>Bxx</code>, the pattern specified by <code>Bxx</code> will be the pattern <code>Dxx</code> jumps in.
| class="eff-global" | Global (Pattern)
|-
| '''<code>E1x</code>'''
| Fine Portamento Up
| Yes
| Similar to <abbr title="Portamento Up"><code>1xx</code></abbr>, but only applies on the first tick of the row.
| class="eff-pitch" | Pitch
|-
| '''<code>E2x</code>'''
| Fine Portamento Down
| Yes
| Similar to <abbr title="Portamento Down"><code>2xx</code></abbr>, but only applies on the first tick of the row.
| class="eff-pitch" | Pitch
|-
| '''<code>E3x</code>'''
| Glissando Control
| —
| {{Warning|This effect is not widely supported and behaves quirky in OpenMPT.}} Configures whether tone portamento effects slide by semitones or not.
* '''<code>E30</code>''' '''disables''' glissando.
* '''<code>E31</code>''' '''enables''' glissando.
| class="eff-pitch" | Pitch
|-
| '''<code>E4x</code>'''
| Set Vibrato Waveform
| —
| Sets the waveform of future Vibrato effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>E5x</code>'''
| Set Finetune
| —
| Overrides the finetune value for the currently playing note. Functions similarly to the same setting in the Sample Editor but is only applied temporarily. This command only works with a note next to it.
| class="eff-pitch" | Pitch
|-
| '''<code>E60</code>'''
| Pattern Loop Start
| —
| {{Warning|A Fasttracker II bug makes use of this command non-trivial.}} Marks the current row position to be used as the start of a pattern loop. {{Warning|1=When <code>E60</code> is used on pattern row <code>x</code>, the following pattern also starts from row <code>x</code> instead of row 0. This can be circumvented by using a <abbr title="Pattern Break"><code>D00</code></abbr> command on the last row of the same pattern.}}
| class="eff-global" | Global (Pattern)
|-
| '''<code>E6x</code>'''
| Pattern Loop
| —
| Each time this command is reached, jumps to the row marked by <abbr title="Pattern Loop Start"><code>E60</code></abbr> until <code>x</code> jumps have occured in total. If <code>E6x</code> is used in a pattern with no <code>E60</code> effect, <code>E6x</code> will use the row position marked by any previous <code>E60</code> effect. Pattern loops cannot span multiple patterns. Ranges from 1h to Fh.
| class="eff-global" | Global (Pattern)
|-
| '''<code>E7x</code>'''
| Set Tremolo Waveform
| —
| Sets the waveform of future Tremolo effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>E8x</code>'''
| Set Panning
| —
| ''<abbr title="Set Panning"><code>8xx</code></abbr> is a much finer panning effect.'' Sets the current channel's panning position. Ranges from 0h (left) to Fh (right).
| class="eff-pan" | Panning
|-
| '''<code>E9x</code>'''
| Retrigger
| No
| Retriggers the current note every <code>x</code> ticks. This effect works with parameters greater than the current Speed setting if the row after it also contains an <code>E9x</code> effect.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EAx</code>'''
| Fine Volume Slide Up
| Yes
| Similar to <abbr title="Volume Slide Up"><code>Ax0</code></abbr>, but only applies on the first tick of the row.
| class="eff-vol" | Volume
|-
| '''<code>EBx</code>'''
| Fine Volume Slide Down
| Yes
| Similar to <abbr title="Volume Slide Down"><code>A0y</code></abbr>, but only applies on the first tick of the row.
| class="eff-vol" | Volume
|-
| '''<code>ECx</code>'''
| Note Cut
| —
| Sets note volume to 0 after <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, this command is ignored.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EDx</code>'''
| Note Delay
| —
| {{Warning|This command is very buggy (e.g. portamento effects next to a note delay are ignored). You should not rely on these bugs to be emulated by other players.}} Delays the note or instrument change in the current pattern cell by <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, the current pattern cell's contents are never played.
| class="eff-misc" | Miscellaneous
|-
| '''<code>EEx</code>'''
| Pattern Delay
| —
| Repeats the current row <code>x</code> times. Notes are not retriggered on every repetition, but effects are still processed. If multiple <code>EEx</code> commands are found on the same row, only the rightmost is considered.
| class="eff-global" | Global (Pattern)
|-
| '''<code>EFx</code>'''
| Set Active Macro
| —
| {{Warning|This effect is a ModPlug hack.}} Selects the active [[Manual: Zxx Macros#Parametered Macros|parametered macro]] for the current channel.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Fxx</code>'''
| Set Speed / Tempo
| —
| {{Warning|Avoid using 00h as a parameter.}}
* Sets the module '''Speed''' (ticks per row) if <code>xx</code> is less than 20h.
* Sets the module '''Tempo''' if <code>xx</code> greater than or equal to 20h.
In OpenMPT and Fasttracker II, <code>F00</code> sets the Speed to 65535 ticks per row, but in other players it may stop the song entirely, or simply do nothing.
| class="eff-global" | Global (Timing)
|-
| '''<code>Gxx</code>'''
| Set Global Volume
| —
| Sets the global volume. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Hxy</code>'''
| Global Volume Slide
| Yes
| Similar to <abbr title="Volume Slide"><code>Axy</code></abbr>, but applies to the global volume.
| class="eff-vol" | Volume
|-
| '''<code>Kxx</code>'''
| Key Off
| —
| {{Warning|Avoid using 00h as a parameter; it interferes with other entries (e.g. notes, instruments) in the same pattern cell.}} Triggers a Note Off command after <code>xx</code> ticks.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Lxx</code>'''
| Set Envelope Position
| —
| Sets the volume envelope playback position to <code>xx</code> ticks. If the volume envelope’s sustain point is enabled, the panning envelope position is also changed.
| class="eff-vol" | Volume
|-
| '''<code>Pxy</code>'''
| Panning Slide
| Yes
| Slides the current sample's panning position left or right.
* '''<code>P0y</code>''' slides the panning to the '''left''' by <code>y</code> units on the first tick of the row.
* '''<code>Px0</code>''' slides the panning to the '''right''' by <code>x</code> units on the first tick of the row.
| class="eff-pan" | Panning
|-
| '''<code>Rxy</code>'''
| Retrigger
| Yes
| {{Warning|This command is very buggy (e.g. if a volume command is in the same pattern cell as <code>Rxy</code>, it will skip some ticks).}} Retriggers the current note every <code>y</code> ticks and changes the volume based on the <code>x</code> value (see the [[#Retrigger Volume|Retrigger Volume table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>Txy</code>'''
| Tremor
| Yes
| Rapidly switches the sample volume on and off on every tick of the row except the first. Volume is '''on''' for <code>x</code> + 1 ticks and '''off''' for <code>y</code> + 1 ticks. For instrument plugins {{Warning|(ModPlug hack)}}, this command sends note-on and note-off messages instead of modifying the volume.
| class="eff-vol" | Volume
|-
| '''<code>X1x</code>'''
| Extra Fine Portamento Up
| Yes
| Similar to <abbr title="Fine Portamento Up"><code>E1x</code></abbr>, but with 4 times the precision.
| class="eff-pitch" | Pitch
|-
| '''<code>X2x</code>'''
| Extra Fine Portamento Down
| Yes
| Similar to <abbr title="Fine Portamento Down"><code>E2x</code></abbr>, but with 4 times the precision.
| class="eff-pitch" | Pitch
|-
| '''<code>X5x</code>'''
| Set Panbrello Waveform
| —
| {{Warning|This effect is a ModPlug hack.}} Sets the waveform of future Panbrello effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>X6x</code>'''
| Fine Pattern Delay
| —
| {{Warning|This effect is a ModPlug hack.}} Extends the current row by <code>x</code> ticks. If multiple <code>X6x</code> commands are found on the same row, the sum of their parameters is used.
| class="eff-global" | Global (Pattern)
|-
| '''<code>X9x</code>'''
| Sound Control
| —
| {{Warning|This effect is a ModPlug hack.}} Executes a sound control command (see the [[Manual: Effect Reference#Sound Control|Sound Control table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>XAx</code>'''
| High Offset
| —
| {{Warning|This effect is a ModPlug hack.}} Sets the high offset for future <abbr title="Sample Offset"><code>9xx</code></abbr> commands. <code>x</code> × 65536 (10000h) is added to all offset effects that follow this command.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Yxy</code>'''
| Panbrello
| Yes
| {{Warning|This effect is a ModPlug hack.}} Executes Panbrello with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected Panbrello waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>Zxx</code>'''
| MIDI Macro
| —
| {{Warning|This effect is a ModPlug hack.}} Executes a [[Manual: Zxx Macros|MIDI Macro]].
| class="eff-misc" | Miscellaneous
|-
| '''<code>\xx</code>'''
| Smooth MIDI Macro
| —
| {{Warning|This effect is a ModPlug hack.}} Executes an interpolated MIDI Macro.
| class="eff-misc" | Miscellaneous
|}

=== Volume Column ===

The following commands can be entered into the effect column.

All parameter values are '''decimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>axx</code>'''
| Fine Volume Slide Up
| No
| Functions like <abbr title="Fine Volume Slide Up"><code>EAx</code></abbr> (slides the volume up <code>xx</code> units on the first tick).
| class="eff-vol" | Volume
|-
| '''<code>bxx</code>'''
| Fine Volume Slide Down
| No
| Functions like <abbr title="Fine Volume Slide Down"><code>EBx</code></abbr> (slides the volume down <code>xx</code> units on the first tick).
| class="eff-vol" | Volume
|-
| '''<code>cxx</code>'''
| Volume Slide Up
| No
| Functions like <abbr title="Volume Slide Up"><code>Ax0</code></abbr> (slides the volume up <code>xx</code> units on all ticks except the first).
| class="eff-vol" | Volume
|-
| '''<code>dxx</code>'''
| Volume Slide Down
| No
| Functions like <abbr title="Volume Slide Down"><code>A0y</code></abbr> (slides the volume down <code>xx</code> units on all ticks except the first).
| class="eff-vol" | Volume
|-
| '''<code>gxx</code>'''
| Tone Portamento
| Yes
| Functions like <abbr title="Tone Portamento"><code>3xx</code></abbr> (pitch-bends from the previous note to the current note). Compared to <code>3xx</code>, parameters are 16 times more coarse (e.g. <code>g01</code> = <abbr title="Tone Portamento with speed 16 (10h)"><code>310</code></abbr>). Combining the effect with <code>3xx</code> will double the effect parameter (e.g. <code>g01</code> would act like <code>g02</code>) and ignores the <code>3xx</code> command. Ineffective if <abbr title="Note Delay"><code>EDx</code></abbr> is in the same pattern cell.
| class="eff-pitch" | Pitch
|-
| '''<code>hxx</code>'''
| Vibrato Depth
| Yes
| Executes vibrato with depth <code>xx</code> and speed from the last <abbr title="Vibrato"><code>4xy</code></abbr> or <abbr title="Vibrato Speed"><code>u0x</code></abbr> command.
| class="eff-pitch" | Pitch
|-
| '''<code>lxx</code>'''
| Panning Slide Left
| No
| Functions like <abbr title="Panning Slide Left"><code>P0y</code></abbr> (slides the panning left by <code>xx</code> units).
| class="eff-pan" | Panning
|-
| '''<code>pxx</code>'''
| Set Panning
| No
| Sets the current channel's panning position. This effect only accepts 4-bit parameters (with 16 distinct values); when saving the file, parameters that are not multiples of 4 will be rounded down to a multiple of 4 (e.g. 55 will save as 52 and 5 will save as 4). Ranges from 0 (left) to 64 (right).
| class="eff-pan" | Panning
|-
| '''<code>rxx</code>'''
| Panning Slide Right
| No
| Functions like <abbr title="Panning Slide Right"><code>Px0</code></abbr> (slides the panning right by <code>xx</code> units).
| class="eff-pan" | Panning
|-
| '''<code>uxx</code>'''
| Vibrato Speed
| No
| Sets the vibrato speed to <code>xx</code>, but does not execute a vibrato.
| class="eff-pitch" | Pitch
|-
| '''<code>vxx</code>'''
| Set Volume
| No
| Sets the current note volume to <code>xx</code>. The behaviour of this command when sent to instrument plugins can be configured in the [[Manual: Instruments#Plugin / MIDI|Instrument Editor]] {{Warning|(ModPlug hack)}}. Ranges from 0 (off) to 64 (full).
| class="eff-vol" | Volume
|}

'''† Effect Memory''': 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''No''' means that the command does nothing.
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>482</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>400</code></abbr> on a subsequent row, the <code>400</code> effect recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Volume"><code>C00</code></abbr> sets note volume to 0, <abbr title="Set Panning"><code>800</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.

== S3M Effect Commands ==

Scream Tracker′s S3M format uses a command set that is entirely different from the MOD and XM formats'. Its use of the volume column is very limited.

The format was soon extended by other programs and players to support more effect commands (e.g. 7-Bit panning, panning slides, channel volume, etc.). Though these are also supported by OpenMPT, they are not original Scream Tracker 3 commands, and thus will be marked as such below.

=== Effect Column ===

The following commands can be entered into the effect column.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>Axx</code>'''
| Set Speed
| No
| Sets the module Speed (ticks per row).
| class="eff-global" | Global (Timing)
|-
| '''<code>Bxx</code>'''
| Position Jump
| —
| Causes playback to jump to pattern position <code>xx</code>. <code>B00</code> would restart a song from the beginning (first pattern in the Order List). If <abbr title="Pattern Break"><code>Cxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Cxx</code> jumps in.
| class="eff-global" | Global (Pattern)
|-
| '''<code>Cxx</code>'''
| Pattern Break
| —
| Jumps to row <code>xx</code> of the next pattern in the Order List. If the current pattern is the last pattern in the Order List, <code>Cxx</code> will jump to row <code>xx</code> of the first pattern. If <abbr title="Position Jump"><code>Bxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Cxx</code> jumps in. Ranges from 00h to 3Fh (64; maximum amount of pattern rows for the S3M format); higher values are ignored.
| class="eff-global | Global (Pattern)
|-
| '''<code>Dxy</code>'''
| Volume Slide or Fine Volume Slide
| Global
| Slides the current note volume up or down.
* '''<code>D0y</code> decreases''' note volume by <code>y</code> units on every tick of the row except the first. If <code>y</code> is Fh and [[Manual: Song Properties#Fast Volume Slides|Fast Volume Slides]] are enabled, volume decreases on every tick.
* '''<code>Dx0</code> increases''' note volume by <code>x</code> units on every tick of the row except the first. If <code>x</code> is Fh and [[Manual: Song Properties#Fast Volume Slides|Fast Volume Slides]] are enabled, volume decreases on every tick. Volume will not exceed 64 (40h).
* '''<code>DFy</code> finely decreases''' note volume by only applying <code>y</code> units on the first tick of the row. <code>y</code> cannot be Fh.
* '''<code>DxF</code> finely increases''' note volume by only applying <code>x</code> units on the first tick of the row. <code>x</code> cannot be Fh.
| class="eff-vol" | Volume
|-
| '''<code>Exx</code>'''
| Portamento Down or Fine Portamento Down or Extra Fine Portamento Down
| Global
| Decreases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
* '''<code>EFx</code> finely''' decreases note pitch by only applying <code>x</code> [[#Frequency Units|units]] on the first tick of the row.
* '''<code>EEx</code> extra-finely''' decreases note pitch by applying with 4 times the precision of <code>EFx</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Fxx</code>'''
| Portamento Up or Fine Portamento Up or Extra Fine Portamento Up
| Global
| Increases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
* '''<code>FFx</code> finely''' increases note pitch by only applying <code>x</code> [[#Frequency Units|units]] on the first tick of the row.
* '''<code>FEx</code> extra-finely''' increases note pitch by applying with 4 times the precision of <code>EFx</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Gxx</code>'''
| Tone Portamento
| Yes
| Slides the pitch of the previous note towards the current note by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>Hxy</code>'''
| Vibrato
| Yes
| Executes vibrato with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected vibrato waveform (see the [[#Waveform Types|Waveform Types table]] for more details). Shares memory with <abbr title="Fine Vibrato"><code>Uxy</code></abbr>.
| class="eff-pitch" | Pitch
|-
| '''<code>Ixy</code>'''
| Tremor
| Global
| Rapidly switches the sample volume on and off. Volume is on for <code>x</code> ticks and off for <code>y</code> ticks.
| class="eff-vol" | Volume
|-
| '''<code>Jxy</code>'''
| Arpeggio
| Global
| Plays an arpeggiation of three notes in one row, cycling between the current note, current note + <code>x</code> semitones, and current note + <code>y</code> semitones.
| class="eff-pitch" | Pitch
|-
| '''<code>Kxy</code>'''
| Volume Slide + Vibrato
| Global
| Functions like <abbr title="Volume Slide"><code>Dxy</code></abbr> with <abbr title="Vibrato memory"><code>H00</code></abbr>. Parameters are used like <code>Dxy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Lxy</code>'''
| Volume Slide + Tone Portamento
| Global
| Functions like <abbr title="Volume Slide"><code>Dxy</code></abbr> with <abbr title="Tone Portamento memory"><code>G00</code></abbr>. Parameters are used like <code>Dxy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Mxx</code>'''
| Set Channel Volume
| —
| {{Warning|This is not an original Scream Tracker 3 effect.}} Sets the current channel volume, which multiplies all note volumes it encompasses. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Nxy</code>'''
| Channel Volume Slide
| Yes
| {{Warning|This is not an original Scream Tracker 3 effect.}} Similar to <abbr title="Volume Slide"><code>Dxy</code></abbr>, but applies to the current channel's volume.
| class="eff-vol" | Volume
|-
| '''<code>Oxx</code>'''
| Sample Offset
| Yes
| Starts playing the current sample from position <code>xx</code> × 256, instead of position 0. Ineffective if there is no note in the same pattern cell.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Pxy</code>'''
| Panning Slide or Fine Panning Slide
| Yes
| {{Warning|This is not an original Scream Tracker 3 effect.}} Slides the current channel's panning position left or right.
* '''<code>P0y</code>''' slides the panning to the '''right''' by <code>y</code> units on every tick of the row except the first.
* '''<code>Px0</code>''' slides the panning to the '''left''' by <code>x</code> units on every tick of the row except the first.
* '''<code>PFy</code> finely''' slides the panning to the right by only applying <code>y</code> units on the first tick of the row. <code>y</code> cannot be Fh.
* '''<code>PxF</code> finely''' slides the panning to the left by only applying <code>x</code> units on the first tick of the row. <code>x</code> cannot be Fh.
| class="eff-pan" | Panning
|-
| '''<code>Qxy</code>'''
| Retrigger
| Global
| Retriggers the current note every <code>y</code> ticks and changes the volume based on the <code>x</code> value (see the [[#Retrigger Volume|Retrigger Volume table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>Rxy</code>'''
| Tremolo
| Global
| Executes tremolo with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected tremolo waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>S1x</code>'''
| Glissando Control
| <abbr title="Global memory can be called with S00">—</abbr>
| {{Warning|This effect is not widely supported and behaves quirky in OpenMPT.}} Configures whether tone portamento effects slide by semitones or not.
* '''<code>S10</code> disables''' glissando.
* '''<code>S11</code> enables''' glissando.
| class="eff-pitch" | Pitch
|-
| '''<code>S2x</code>'''
| Set Finetune
| <abbr title="Global memory can be called with S00">—</abbr>
| ''Considered a legacy command.'' Overrides the current sample's C-5 frequency with a MOD finetune value.
| class="eff-pitch" | Pitch
|-
| '''<code>S3x</code>'''
| Set Vibrato Waveform
| <abbr title="Global memory can be called with S00">—</abbr>
| Sets the waveform of future Vibrato effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>S4x</code>'''
| Set Tremolo Waveform
| <abbr title="Global memory can be called with S00">—</abbr>
| Sets the waveform of future Tremolo effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>S5x</code>'''
| Set Panbrello Waveform
| <abbr title="Global memory can be called with S00">—</abbr>
| {{Warning|This is not an original Scream Tracker 3 effect.}} Sets the waveform of future Panbrello effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>S6x</code>'''
| Fine Pattern Delay
| <abbr title="Global memory can be called with S00">—</abbr>
| Extends the current row by <code>x</code> ticks. If multiple <code>S6x</code> commands are on the same row, the sum of their parameters is used.
| class="eff-global" | Global (Pattern)
|-
| '''<code>S8x</code>'''
| Set Panning
| <abbr title="Global memory can be called with S00">—</abbr>
| ''<abbr title="Set Panning"><code>Xxx</code></abbr> is a much finer panning effect.'' Sets the current channel's panning position. Ranges from 0h (left) to Fh (right).
| class="eff-pan" | Panning
|-
| '''<code>S9x</code>'''
| Sound Control
| <abbr title="Global memory can be called with S00">—</abbr>
| {{Warning|This is not an original Scream Tracker 3 effect.}} Executes a sound control command (see the [[#Sound Control|Sound Control table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>SAx</code>'''
| High Offset
| <abbr title="Global memory can be called with S00">—</abbr>
| {{Warning|This is not an original Scream Tracker 3 effect.}} Sets the high offset for future <abbr title="Sample Offset"><code>Oxx</code></abbr> commands. <code>x</code> × 65536 (10000h) is added to all offset effects that follow this command.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SB0</code>'''
| Pattern Loop Start
| <abbr title="Global memory can be called with S00">—</abbr>
| Marks the current row position to be used as the start of a pattern loop.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SBx</code>'''
| Pattern Loop
| <abbr title="Global memory can be called with S00">—</abbr>
| Each time this command is reached, jumps to the row marked by <abbr title="Pattern Loop Start"><code>SB0</code></abbr> until <code>x</code> jumps have occurred in total. If <code>SBx</code> is used in a pattern with no <code>SB0</code> effect, <code>SBx</code> will use the row position marked by any previous <code>SB0</code> effect. Pattern loops cannot span multiple patterns. Ranges from 1h to Fh.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SCx</code>'''
| Note Cut
| <abbr title="Global memory can be called with S00">—</abbr>
| Stops the current sample after <code>x</code> ticks. If <code>x</code> is 0, or greater than or equal to the current module Speed, this command is ignored.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SDx</code>'''
| Note Delay
| <abbr title="Global memory can be called with S00">—</abbr>
| Delays the note or instrument change in the current pattern cell by <code>x</code> ticks. If <code>x</code> is 0, or greater than or equal to the current module Speed, the current pattern cell's contents are never played.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SEx</code>'''
| Pattern Delay
| <abbr title="Global memory can be called with S00">—</abbr>
| Repeats the current row <code>x</code> times. Notes are not retriggered on every repetition, but effects are still processed. If multiple <code>SEx</code> commands are on the same row, only the leftmost command is used.
| class="eff-global" | Global (Pattern)
|-
| '''<code>T0x</code>'''
| Decrease Tempo
| Yes
| Decreases the module Tempo by <code>x</code> BPM on every tick of the row except the first.
| class="eff-global" | Global (Timing)
|-
| '''<code>T1x</code>'''
| Increase Tempo
| Yes
| Increases the module Tempo by <code>x</code> BPM on every tick of the row except the first.
| class="eff-global" | Global (Timing)
|-
| '''<code>Txx</code>'''
| Set Tempo
| No
| Sets the module Tempo if <code>xx</code> is greater than or equal to 20h.
| class="eff-global" | Global (Timing)
|-
| '''<code>Uxy</code>'''
| Fine Vibrato
| Yes
| Similar to <abbr title="Vibrato"><code>Hxy</code></abbr>, but with 4 times the precision. Shares memory with <code>Hxy</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Vxx</code>'''
| Set Global Volume
| —
| Sets the global volume. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Wxy</code>'''
| Global Volume Slide
| Yes
| {{Warning|This is not an original Scream Tracker 3 effect.}} Similar to <abbr title="Volume Slide"><code>Dxy</code></abbr>, but applies to the global volume.
| class="eff-vol" | Volume
|-
| '''<code>Xxx</code>'''
| Set Panning
| —
| Sets the current channel's panning position.
* '''<code>XA4</code> enables surround playback''' on the current channel. When using '''stereo''' playback, the right channel of a sample is played with inversed phase (Pro Logic Surround). When using '''quad''' playback, the rear channels are used for playing this channel.
Surround mode can be disabled by using a different <code>Xxx</code> command on the same channel it was enabled on. Ranges from 00h (left) to 80h (right).
| class="eff-pan" | Panning
|-
| '''<code>Yxy</code>'''
| Panbrello
| Yes
| {{Warning|This is not an original Scream Tracker 3 effect.}} Executes panbrello with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected panbrello waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>Zxx</code>'''
| MIDI Macro
| —
| {{Warning|This is not an original Scream Tracker 3 effect.}} Executes a [[Manual: Zxx Macros|MIDI Macro]]. Since MIDI Macros are not stored in S3M files, only the default macro configuration can be used to control the resonant filter.
| class="eff-misc" | Miscellaneous
|}

=== Volume Column ===

The following commands can be entered into the volume column.

All parameter values are '''decimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>pxx</code>'''
| Set Panning
| No
| {{Warning|This is not an original Scream Tracker 3 effect.}} Sets the current channel's panning position to <code>xx</code>. Ranges from 0 to 64 (decimal).
| class="eff-pan" | Panning
|-
| '''<code>vxx</code>'''
| Set Volume
| No
| Sets the current note volume to <code>xx</code>. Ranges from 0 to 64 (decimal).
| class="eff-vol" | Volume
|}

'''† Effect Memory:''' 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''No''' means that the command does nothing.
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>H82</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>H00</code></abbr> on a subsequent row, the <code>H00</code> command recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Global Volume"><code>V00</code></abbr> sets the global volume to 0, <abbr title="Set Panning"><code>X00</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.
* '''Global''' means that the effect calls any previous non-zero parameter in the same column. For example, if the effect <abbr title="Portamento Down by 22h (34) units"><code>E22</code></abbr> is followed by <abbr title="Tremor memory"><code>I00</code></abbr>, the <code>I00</code> command recalls the effect parameter 22h.

=== AdLib / OPL3 Instruments ===
OpenMPT supports AdLib / OPL3 instruments in the S3M format, but not all effects are compatible with them. Below is a list of effects that do not function with AdLib / OPL3 instruments in S3M files:
* <code>Oxx</code> (Sample Offset)
* <code>S9x</code> (Sound Control)
* <code>SAx</code> (High Offset)
* <code>XA4</code> (Enable Surround)

The following effects are not supported in Scream Tracker 3 but work with AdLib / OPL3 instruments in OpenMPT:
* <code>Mxx</code> (Set Channel Volume)
* <code>Nxy</code> (Channel Volume Slide)

Additionally, since AdLib / OPL3 instruments only support hard left, center, and hard right panning, the range of <abbr title="Set Panning"><code>Xxx</code></abbr> and <abbr title="Set Panning"><code>pxx</code></abbr> are effectively restricted to those positions.

== IT Effect Commands ==

Impulse Tracker's IT format uses a command set that expands upon the S3M format's, adding several new effects and improving effect memory usage.

=== Effect Column ===

The following commands can be entered into the effect column.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>Axx</code>'''
| Set Speed
| No
| Sets the module Speed (ticks per row).
| class="eff-global" | Global (Timing)
|-
| '''<code>Bxx</code>'''
| Position Jump
| —
| Causes playback to jump to pattern position <code>xx</code>. <code>B00</code> would restart a song from the beginning (first pattern in the Order List). If <abbr title="Pattern Break"><code>Cxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Cxx</code> jumps in.
| class="eff-global" | Global (Pattern)
|-
| '''<code>Cxx</code>'''
| Pattern Break
| —
| Jumps to row <code>xx</code> of the next pattern in the Order List. If the current pattern is the last pattern in the Order List, <code>Cxx</code> will jump to row <code>xx</code> of the first pattern. If <abbr title="Position Jump"><code>Bxx</code></abbr> is on the same row, the pattern specified by <code>Bxx</code> will be the pattern <code>Cxx</code> jumps in. Ranges from 00h to the next pattern's row length; higher values are treated as 00h.
| class="eff-global | Global (Pattern)
|-
| '''<code>Dxy</code>'''
| Volume Slide or Fine Volume Slide
| Yes
| Slides the current note volume up or down.
* '''<code>D0y</code> decreases''' note volume by <code>y</code> units on every tick of the row except the first. If <code>y</code> is Fh, volume decreases on every tick.
* '''<code>Dx0</code> increases''' note volume by <code>x</code> units on every tick of the row except the first. Volume will not exceed 64 (40h).
* '''<code>DFy</code> finely decreases''' note volume by only applying <code>y</code> units on the first tick of the row. <code>y</code> cannot be Fh.
* '''<code>DxF</code> finely increases''' note volume by only applying <code>x</code> units on the first tick of the row. <code>x</code> cannot be Fh.
| class="eff-vol" | Volume
|-
| '''<code>Exx</code>'''
| Portamento Down or Fine Portamento Down or Extra Fine Portamento Down
| Yes
| Decreases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
* '''<code>EFx</code> finely''' decreases note pitch by only applying <code>x</code> [[#Frequency Units|units]] on the first tick of the row.
* '''<code>EEx</code> extra-finely''' decreases note pitch by applying with 4 times the precision of <code>EFx</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Fxx</code>'''
| Portamento Up or Fine Portamento Up or Extra Fine Portamento Up
| Yes
| Increases current note pitch by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
* '''<code>FFx</code> finely''' increases note pitch by only applying <code>x</code> [[#Frequency Units|units]] on the first tick of the row.
* '''<code>FEx</code> extra-finely''' increases note pitch by applying with 4 times the precision of <code>EFx</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Gxx</code>'''
| Tone Portamento
| Yes
| Slides the pitch of the previous note towards the current note by <code>xx</code> [[#Frequency Units|units]] on every tick of the row except the first.
| class="eff-pitch" | Pitch
|-
| '''<code>Hxy</code>'''
| Vibrato
| Yes
| Executes vibrato with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected vibrato waveform (see the [[#Waveform Types|Waveform Types table]] for more details). Shares memory with <abbr title="Fine Vibrato"><code>Uxy</code></abbr>.
| class="eff-pitch" | Pitch
|-
| '''<code>Ixy</code>'''
| Tremor
| Yes
| Rapidly switches the sample volume on and off. Volume is on for <code>x</code> ticks and off for <code>y</code> ticks. For instrument plugins {{Warning|(ModPlug hack)}}, this command sends note-on and note-off messages instead of modifying the volume.
| class="eff-vol" | Volume
|-
| '''<code>Jxy</code>'''
| Arpeggio
| Yes
| Plays an arpeggiation of three notes in one row, cycling between the current note, current note + <code>x</code> semitones, and current note + <code>y</code> semitones.
| class="eff-pitch" | Pitch
|-
| '''<code>Kxy</code>'''
| Volume Slide + Vibrato
| Yes
| Functions like <abbr title="Volume Slide"><code>Dxy</code></abbr> with <abbr title="Vibrato memory"><code>H00</code></abbr>. Parameters are used like <code>Dxy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Lxy</code>'''
| Volume Slide + Tone Portamento
| Yes
| Functions like <abbr title="Volume Slide"><code>Dxy</code></abbr> with <abbr title="Tone Portamento memory"><code>G00</code></abbr>. Parameters are used like <code>Dxy</code>.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Mxx</code>'''
| Set Channel Volume
| —
| Sets the current channel volume, which multiplies all note volumes it encompasses. Ranges from 00h (off) to 40h (full).
| class="eff-vol" | Volume
|-
| '''<code>Nxy</code>'''
| Channel Volume Slide
| Yes
| Similar to <abbr title="Volume Slide"><code>Dxy</code></abbr>, but applies to the current channel's volume.
| class="eff-vol" | Volume
|-
| '''<code>Oxx</code>'''
| Sample Offset
| Yes
| Starts playing the current sample from position <code>xx</code> × 256, instead of position 0. Ineffective if there is no note in the same pattern cell.
| class="eff-misc" | Miscellaneous
|-
| '''<code>Pxy</code>'''
| Panning Slide or Fine Panning Slide
| Yes
| Slides the current channel's panning position left or right.
* '''<code>P0y</code>''' slides the panning to the '''right''' by <code>y</code> units on every tick of the row except the first.
* '''<code>Px0</code>''' slides the panning to the '''left''' by <code>x</code> units on every tick of the row except the first.
* '''<code>PFy</code> finely''' slides the panning to the right by only applying <code>y</code> units on the first tick of the row. <code>y</code> cannot be Fh.
* '''<code>PxF</code> finely''' slides the panning to the left by only applying <code>x</code> units on the first tick of the row. <code>x</code> cannot be Fh.
| class="eff-pan" | Panning
|-
| '''<code>Qxy</code>'''
| Retrigger
| Yes
| Retriggers the current note every <code>y</code> ticks and changes the volume based on the <code>x</code> value (see the [[#Retrigger Volume|Retrigger Volume table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>Rxy</code>'''
| Tremolo
| Yes
| Executes tremolo with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected tremolo waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>S1x</code>'''
| Glissando Control
| <abbr title="Memory can be called with S00">—</abbr>
| {{Warning|This effect is not widely supported and behaves quirky in OpenMPT.}} Configures whether tone portamento effects slide by semitones or not.
* '''<code>S10</code> disables''' glissando.
* '''<code>S11</code> enables''' glissando.
| class="eff-pitch" | Pitch
|-
| '''<code>S2x</code>'''
| Set Finetune
| <abbr title="Memory can be called with S00">—</abbr>
| ''Considered a legacy command.'' Overrides the current sample's C-5 frequency with a MOD finetune value.
| class="eff-pitch" | Pitch
|-
| '''<code>S3x</code>'''
| Set Vibrato Waveform
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the waveform of future Vibrato effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pitch" | Pitch
|-
| '''<code>S4x</code>'''
| Set Tremolo Waveform
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the waveform of future Tremolo effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-vol" | Volume
|-
| '''<code>S5x</code>'''
| Set Panbrello Waveform
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the waveform of future Panbrello effects (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>S6x</code>'''
| Fine Pattern Delay
| <abbr title="Memory can be called with S00">—</abbr>
| Extends the current row by <code>x</code> ticks. If multiple <code>S6x</code> commands are on the same row, the sum of their parameters is used.
| class="eff-global" | Global (Pattern)
|-

| '''<code>S70</code>'''
| Past Note Cut
| <abbr title="Memory can be called with S00">—</abbr>
| '''Cuts''' all notes playing as a result of New Note Actions on the current channel.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S71</code>'''
| Past Note Off
| <abbr title="Memory can be called with S00">—</abbr>
| '''Sends a Note Off''' to all notes playing as a result of New Note Actions on the current channel.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S72</code>'''
| Past Note Fade
| <abbr title="Memory can be called with S00">—</abbr>
| '''Fades out''' all notes playing as a result of New Note Actions on the current channel.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S73</code>'''
| NNA Note Cut
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the currently active note's New Note Action to '''Note Cut'''.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S74</code>'''
| NNA Note Continue
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the currently active note's New Note Action to '''Continue'''.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S75</code>'''
| NNA Note Off
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the currently active note's New Note Action to '''Note Off'''.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S76</code>'''
| NNA Note Fade
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the currently active note's New Note Action to '''Note Fade'''.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S77</code>'''
| Volume Envelope Off
| <abbr title="Memory can be called with S00">—</abbr>
| '''Disables''' the currently active note's '''volume''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S78</code>'''
| Volume Envelope On
| <abbr title="Memory can be called with S00">—</abbr>
| '''Enables''' the currently active note's '''volume''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S79</code>'''
| Panning Envelope Off
| <abbr title="Memory can be called with S00">—</abbr>
| '''Disables''' the currently active note's '''panning''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S7A</code>'''
| Panning Envelope On
| <abbr title="Memory can be called with S00">—</abbr>
| '''Enables''' the currently active note's '''panning''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S7B</code>'''
| Pitch Envelope Off
| <abbr title="Memory can be called with S00">—</abbr>
| '''Disables''' the currently active note's '''pitch''' or '''filter''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S7C</code>'''
| Pitch Envelope On
| <abbr title="Memory can be called with S00">—</abbr>
| '''Enables''' the currently active note's '''pitch''' envelope.
| class="eff-misc" | Miscellaneous
|-
| '''<code>S8x</code>'''
| Set Panning
| <abbr title="Memory can be called with S00">—</abbr>
| ''<abbr title="Set Panning"><code>Xxx</code></abbr> is a much finer panning effect.'' Sets the current channel's panning position. Ranges from 0h (left) to Fh (right).
| class="eff-pan" | Panning
|-
| '''<code>S9x</code>'''
| Sound Control
| <abbr title="Memory can be called with S00">—</abbr>
| {{Warning|1=Only <abbr title="Surround On"><code>S91</code></abbr> is an original Impulse Tracker command.}} Executes a sound control command (see the [[#Sound Control|Sound Control table]] for more details).
| class="eff-misc" | Miscellaneous
|-
| '''<code>SAx</code>'''
| High Offset
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the high offset for future <abbr title="Sample Offset"><code>Oxx</code></abbr> commands. <code>x</code> × 65536 (10000h) is added to all offset effects that follow this command.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SB0</code>'''
| Pattern Loop Start
| <abbr title="Memory can be called with S00">—</abbr>
| Marks the current row position to be used as the start of a pattern loop.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SBx</code>'''
| Pattern Loop
| <abbr title="Memory can be called with S00">—</abbr>
| Each time this command is reached, jumps to the row marked by <abbr title="Pattern Loop Start"><code>SB0</code></abbr> until <code>x</code> jumps have occurred in total. If <code>SBx</code> is used in a pattern with no <code>SB0</code> effect, <code>SBx</code> will use the row position marked by any previous <code>SB0</code> effect. Pattern loops cannot span multiple patterns. Ranges from 1h to Fh.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SCx</code>'''
| Note Cut
| <abbr title="Memory can be called with S00">—</abbr>
| Stops the current sample after <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, this command is ignored. If <code>x</code> is 0, it will be treated as if it were 1.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SDx</code>'''
| Note Delay
| <abbr title="Memory can be called with S00">—</abbr>
| Delays the note or instrument change in the current pattern cell by <code>x</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, the current cell's contents are not played. If <code>x</code> is 0, it will be treated as if it were 1.
| class="eff-misc" | Miscellaneous
|-
| '''<code>SEx</code>'''
| Pattern Delay
| <abbr title="Memory can be called with S00">—</abbr>
| Repeats the current row <code>x</code> times. Notes are not retriggered on every repetition, but effects are still processed. If multiple <code>SEx</code> commands are on the same row, only the leftmost command is used.
| class="eff-global" | Global (Pattern)
|-
| '''<code>SFx</code>'''
| Set Active Macro
| <abbr title="Memory can be called with S00">—</abbr>
| Sets the current channel's active [[Manual: Zxx Macros#Parametered Macros|parametered macro]].
| class="eff-misc" | Miscellaneous
|-
| '''<code>T0x</code>'''
| Decrease Tempo
| Yes
| Decreases the module Tempo by <code>x</code> BPM on every tick of the row except the first.
| class="eff-global" | Global (Timing)
|-
| '''<code>T1x</code>'''
| Increase Tempo
| Yes
| Increases the module Tempo by <code>x</code> BPM on every tick of the row except the first.
| class="eff-global" | Global (Timing)
|-
| '''<code>Txx</code>'''
| Set Tempo
| No
| Sets the module Tempo if <code>xx</code> is greater than or equal to 20h.
| class="eff-global" | Global (Timing)
|-
| '''<code>Uxy</code>'''
| Fine Vibrato
| Yes
| Similar to <abbr title="Vibrato"><code>Hxy</code></abbr>, but with 4 times the precision. Shares memory with <code>Hxy</code>.
| class="eff-pitch" | Pitch
|-
| '''<code>Vxx</code>'''
| Set Global Volume
| —
| Sets the global volume. Ranges from 00h (off) to 80h (full).
| class="eff-vol" | Volume
|-
| '''<code>Wxy</code>'''
| Global Volume Slide
| Yes
| Similar to <abbr title="Volume Slide"><code>Dxy</code></abbr>, but applies to the global volume.
| class="eff-vol" | Volume
|-
| '''<code>Xxx</code>'''
| Set Panning
| —
| Sets the current channel's panning position. Ranges from 00h (left) to FFh (right).
| class="eff-pan" | Panning
|-
| '''<code>Yxy</code>'''
| Panbrello
| Yes
| Executes panbrello with speed <code>x</code> and depth <code>y</code> on the current note. Modulates with selected panbrello waveform (see the [[#Waveform Types|Waveform Types table]] for more details).
| class="eff-pan" | Panning
|-
| '''<code>Zxx</code>'''
| MIDI Macro
| —
| Executes a [[Manual: Zxx Macros|MIDI Macro]].
| class="eff-misc" | Miscellaneous
|-
| '''<code>\xx</code>'''
| Smooth MIDI Macro
| —
| {{Warning|This effect is a ModPlug hack.}} Executes an interpolated MIDI Macro.
| class="eff-misc" | Miscellaneous
|}

=== Volume Column ===

The following commands can be entered into the volume column.

All parameter values are '''decimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| <code>'''a0x'''</code>
| Fine Volume Slide Up
| Yes
| Functions like <abbr title="Fine Volume Slide Up"><code>DxF</code></abbr> (slides the volume up <code>x</code> units on the first tick).
| class="eff-vol" | Volume
|-
| <code>'''b0x'''</code>
| Fine Volume Slide Down
| Yes
| Functions like <abbr title="Fine Volume Slide Down"><code>DFy</code></abbr> (slides the volume down <code>x</code> units on the first tick).
| class="eff-vol" | Volume
|-
| <code>'''c0x'''</code>
| Volume Slide Up
| Yes
| Functions like <abbr title="Volume Slide Up"><code>Dx0</code></abbr> (slides the volume up <code>x</code> units on all ticks except the first).
| class="eff-vol" | Volume
|-
| <code>'''d0x'''</code>
| Volume Slide Down
| Yes
| Functions like <abbr title="Volume Slide Down"><code>D0y</code></abbr> (slides the volume down <code>x</code> units on all ticks except the first).
| class="eff-vol" | Volume
|-
| <code>'''e0x'''</code>
| Portamento Down
| Yes
| Similar to <abbr title="Portamento Down"><code>Exx</code></abbr>. Compared to <code>Exx</code>, parameters are 4 times more coarse (e.g. <code>e01</code> = <abbr title="Portamento Down by 4 units"><code>E04</code></abbr>).
| class="eff-pitch" | Pitch
|-
| <code>'''f0x'''</code>
| Portamento Up
| Yes
| Similar to <abbr title="Portamento Up"><code>Fxx</code></abbr>. Compared to <code>Fxx</code>, parameters are 4 times more coarse (e.g. <code>f01</code> = <abbr title="Portamento Up by 4 units"><code>F04</code></abbr>).
| class="eff-pitch" | Pitch
|-
| <code>'''g0x'''</code>
| Tone Portamento
| Yes
| Similar to <abbr title="Tone Portamento"><code>Gxx</code></abbr>. Below is a table that translates <code>g0x</code> parameters to <code>Gxx</code> parameters:
{|
|-
|
{| class="wikitable"
|-
! <tt>g0x</tt> !! <tt>Gxx</tt>
|-
| <code>g00</code> || <code>G00</code>
|-
| <code>g01</code> || <code>G01</code>
|-
| <code>g02</code> || <code>G04</code>
|-
| <code>g03</code> || <code>G08</code>
|-
| <code>g04</code> || <code>G10</code>
|}
|
{| class="wikitable"
|-
! <tt>g0x</tt> !! <tt>Gxx</tt>
|-
| <code>g05</code> || <code>G20</code>
|-
| <code>g06</code> || <code>G40</code>
|-
| <code>g07</code> || <code>G60</code>
|-
| <code>g08</code> || <code>G80</code>
|-
| <code>g09</code> || <code>GFF</code>
|}
|}
| class="eff-pitch" | Pitch
|-
| <code>'''h0x'''</code>
| Vibrato Depth
| Yes
| Executes a vibrato with depth <code>x</code> and speed from the last <abbr title="Vibrato"><code>Hxy</code></abbr> or <abbr title="Fine Vibrato"><code>Uxy</code></abbr> command.
| class="eff-pitch" | Pitch
|-
| <code>'''pxx'''</code>
| Set Panning
| —
| Sets the current channel's panning position to <code>xx</code>. Ranges from 0 to 64.
| class="eff-pan" | Panning
|-
| <code>'''vxx'''</code>
| Set Volume
| —
| Sets the current note volume to <code>xx</code>. The behaviour of this command when sent to instrument plugins can be configured in the [[Manual: Instruments#Plugin / MIDI|Instrument Editor]] {{Warning|(ModPlug hack)}}.
| class="eff-vol" | Volume
|}

'''† Effect Memory:''' 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''No''' means that the command does nothing.
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>H82</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>H00</code></abbr> on a subsequent row, the <code>H00</code> command recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Global Volume"><code>V00</code></abbr> sets the global volume to 0, <abbr title="Set Panning"><code>X00</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.

: '''Volume Column Effect Memory:'''
:* All volume slide effects in the volume column share effect memory with each other.
:* <abbr title="Portamento Down"><code>e0x</code></abbr> and <abbr title="Portamento Up"><code>f0x</code></abbr> share effect memory with <abbr title="Portamento Down"><code>Exx</code></abbr> and <abbr title="Portamento Up"><code>Fxx</code></abbr> (respectively).

== MPTM Effect Commands ==

OpenMPT′s MPTM format is heavily based on the IT format and [[#IT Effect Commands|its effect command set]], but it does add several new features.

=== Effect Column ===

OpenMPT's MPTM format generally uses the same effect commands as the IT format. Commands from the IT section that are labeled as ModPlug hacks or unsupported by Impulse Tracker may be freely used in the MPTM format.

The following additional commands, exclusive to the MPTM format, can be entered in the effect column.

All parameter values are '''hexadecimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>S7D</code>'''
| Force Pitch Envelope
| <abbr title="Memory can be called with S00">—</abbr>
| Enables the currently active note's pitch envelope and forces it to act as a pitch envelope (rather than a filter cutoff envelope).
| class="eff-misc" | Miscellaneous
|-
| '''<code>S7E</code>'''
| Force Filter Envelope
| <abbr title="Memory can be called with S00">—</abbr>
| Enables the currently active note's pitch envelope and forces it to act as a filter cutoff envelope (rather than a pitch envelope).
| class="eff-misc" | Miscellaneous
|-
| '''<code>:xy</code>'''
| Note Delay + Cut
| —
| Delays the note in the current pattern cell by <code>x</code> ticks and cuts it after <code>x</code> + <code>y</code> ticks. If <code>x</code> is greater than or equal to the current module Speed, the note will be ignored (and as such, cannot be cut with <code>y</code>). If <code>x</code> + <code>y</code> is greater than or equal to the current module Speed, only the note cut will be ignored.
| class="eff-misc" | Miscellaneous
|-
| '''<code>#xx</code>'''
| Parameter Extension
| —
| Extends the parameter of the last <abbr title="Position Jump"><code>Bxx</code></abbr>, <abbr title="Pattern Break"><code>Cxx</code></abbr>, <abbr title="Sample Offset"><code>Oxx</code></abbr>, <abbr title="Set Tempo"><code>Txx</code></abbr>, <abbr title="Finetune"><code>+xx</code></abbr> or <abbr title="Finetune (Smooth)"><code>*xx</code></abbr> command. If placed after such a command, the parameter values are combined. If there is only one <code>#xx</code> command below the actual command (the limit for <code>Bxx</code>, <code>Cxx</code>, and <code>Txx</code>), the original command is multiplied by 256 and then parameter <code>xx</code> is added to it. For <code>Oxx</code>, up to 4 rows can be combined. The fourth row is multiplied by 1, the third by 256 (100h), the second by 65536 (10000h), and so on.

'''Example:'''
<pattern>
ModPlug Tracker MPT
|C-501...O21
|........#02
|........#01
</pattern>
In this example, the '''hexadecimal''' sample offset is (21h × 10000h) + (2h × 100h) + 1h = 210201h. In '''decimal''', it is (33 × 65536) + (2 × 256) + 1 = 2,163,201.
| class="eff-misc" | Miscellaneous
|-
| '''<code>+xx</code>'''
| Finetune
| —
| Changes the current note’s tuning. <code>+80</code> is center (no change to the tuning), lower values decrease the tuning and higher values increase the tuning. In sample mode, the depth of this command is fixed at ±1 semitone. For sample-based instruments, the depth is defined by the instrument’s [[Manual: Instruments#Plugin / MIDI|pitch bend range]] setting. For plugins, this command directly translates to MIDI pitch bend commands, so the depth is whatever the pitch bend depth of the plugin or MIDI device is set to. This command can be extended by <code>#xx</code> Parameter extensions for even finer control over the tuning.
| class="eff-pitch" | Pitch
|-
| '''<code>*xx</code>'''
| Finetune (Smooth)
| —
| Exactly the same as <abbr title="Finetune"><code>+xx</code></abbr>, but slides from the previous finetune value to the new value on every tick of the row.
| class="eff-pitch" | Pitch
|}

=== Volume Column ===

In addition to all of the IT format's [[#Volume Column_3|volume column commands]], the following commands can be entered in the volume column.

All parameter values are '''decimal'''.

{| class="wikitable sortable"
|-
! <abbr title="Effect">Eff</abbr>
! Name
! <abbr title="Memory">Mem</abbr>†
! Description
! Category
|-
| '''<code>o0x</code>'''
| Sample Cue
| Yes
| Starts playing the current sample from cue point <code>x</code>, instead of position 0. Cue points can be chosen in the [[Manual: Samples#Sample Display Context Menu|Sample Editor]]. Ineffective if there is no note in the same pattern cell. Shares effect memory with <abbr title="Sample Offset"><code>Oxx</code></abbr> and can be [[#Combined Commands|combined]] with that command.
| class="eff-misc" | Miscellaneous
|}

'''† Effect Memory:''' 
Assuming that all available parameters for a given effect (e.g. <code>xx</code>, <code>xy</code>, <code>x</code>, or <code>y</code>) are equivalent to 0:
* '''Yes''' means that the effect calls its own parameter memory. For example, if the effect <abbr title="Vibrato with speed 8 and depth 2"><code>H82</code></abbr> is followed by the effect <abbr title="Vibrato memory"><code>H00</code></abbr> on a subsequent row, the <code>H00</code> command recalls the effect parameter 82h.
* '''—''' means that the value has no special meaning. For example, <abbr title="Set Global Volume"><code>V00</code></abbr> sets the global volume to 0, <abbr title="Set Panning"><code>X00</code></abbr> sets the channel's panning position to hard left, <abbr title="Position Jump"><code>B00</code></abbr> jumps to the first pattern, etc.

=== Combined Commands ===

By combining the volume column <abbr title="Sample Cue"><code>oxx</code></abbr> and effect column <abbr title="Sample Offset"><code>Oxx</code></abbr> commands, two special offset behaviours can be achieved:
* <code>o00</code> + <code>Oxx</code>: A cue point command with a parameter of 0 turns the effect column offset into a percentage offset, i.e. the command jumps to <code>xx</code> × 1/256th of the total sample length. For example <code>o00</code> + <code>O80</code> plays the second half of any sample.
* <code>o0x</code> + <code>Oyy</code>: For <code>x</code> > 0, the effect column <code>Oyy</code> is added on top of the cue point, so <code>o05</code> + <code>O01</code> plays from the 5th cue point of the sample + 256 samples.

=== AdLib / OPL3 Instruments ===
OpenMPT supports AdLib / OPL3 instruments in the MPTM format, but not all effects are compatible with them. Below is a list of effects that do not function with AdLib / OPL3 instruments in MPTM files:
* <code>Oxx</code> (Sample Offset)
* <code>S9x</code> (Sound Control) parameters other than Ch and Dh (Global & Local Filters)
* <code>SAx</code> (High Offset)
* <code>o0x</code> (Sample Cue)

Additionally, since AdLib / OPL3 instruments only support hard left, center, and hard right panning, the range of <abbr title="Set Panning"><code>Xxx</code></abbr> and <abbr title="Set Panning"><code>pxx</code></abbr> are effectively restricted to those positions. Panning Slides like <abbr title="Panning Slide"><code>Pxy</code></abbr> and <abbr title="Panbrello"><code>Yxy</code></abbr> work with the same reduced granularity, but should be best avoided if possible.

=== Parameter Control Events ===

Another feature similar to effects that is only available in MPTM files are [[Manual: Parameter Control Events|Parameter Control Events]], which can be used to automate plugin parameters.

[[Category:Manual|Effect Reference]]
[[de:Handbuch: Effektbefehle]]

Manual: Setup/Keyboard

2025-06-01T14:44:23Z

Saga Musix:

[[Image:Settings Keyboard.png|thumb|350px|Keyboard tab of the settings dialog]]

In this page you can choose or edit keyboard and MIDI shortcuts for many of the actions in OpenMPT. OpenMPT has several built-in keyboard layouts you can choose from, but you can also load and save custom layouts, for example from the <code>ExtraKeymaps</code> folder in OpenMPT’s application folder by clicking on the “Import Key Map...” button near the bottom of the page. The current shortcut configurations are kept in the <code>Keybindings.mkb</code> file in the <code>%APPDATA%\OpenMPT</code> folder (or OpenMPT’s application folder if in portable mode), but here you can save these shortcuts in a separate file for safekeeping or sharing as well.
The following is a description of the various items on the page.

To view or edit keyboard shortcuts, first find the context to which the keypress would be applied by clicking on the Category field at the top. A dropdown list will open and you can choose the context to view. If you wanted, for example, to assign the <kbd>Q</kbd> key to the base octave C when inputting a note in a pattern, this keypress would be needed in the Pattern Editor for the note column. So you would select “Pattern Editor – Note Column” from the popup menu. The list of assignable note messages will be displayed in the field below it. Select the “Base octave C” entry and select it. Alternatively, if you know (parts of) the shortcut name, you can type it into the “Find by Name” box.

Limited support for MIDI message handling is also there: Additionally to computer keyboard keys, MIDI CCs and MIDI note events may be used to trigger shortcuts. To make use of them, first [[Manual: MIDI Reference#Enabling MIDI Input|enable MIDI Input]]. Then, go to this settings dialog, focus the Key input field and send the wanted MIDI CC or note using your MIDI device.

It is possible to assign the same key combination to several shortcuts within the same context by means of the hidden setting [[Manual: Hidden Settings#.5BMisc.5D|Misc.AllowMultipleCommandsPerKey]], but a warning about this potentially unwanted situation is emitted if you are trying to re-use an existing key combination that may be conflicting.

== Shortcut List ==

=== Select Category ===
Shortcuts are sorted into categories, or contexts, in which a shortcut can be activated. The category list shows all available contexts, and clicking this field opens a dropdown list from where you can choose which set of shortcuts you wish to edit.

Generally the same keyboard shortcut can be assigned in multiple contexts, but only the shortcut in the most specific context will be activated when the key is hit.

=== Action List ===
Clicking on one of the entries selects it for key assignment. See the [[Manual: Keyboard Actions|Keyboard Actions]] table for a description of all available actions.

In the right-hand column, you see the currently assigned shortcut(s) for each entry. Double-clicking this column allows you to directly change the primary choice for this entry.

=== Find ===
This can be used to search for a specific shortcut in the complete shortcut list by its name. Instead of searching by name, you can also search by shortcut. Just click on the '''Find by Hotkey...''' button and enter the key combination that you want to find into the edit field that pops up (e.g. pressing <kbd>Ctrl</kbd>+<kbd>C</kbd> would bring up the “Copy” shortcut when using the default configuration). Focus the edit box again to remove the search term.

Pressing the '''Clear''' button cancels any active search filters.

== Key Setup ==

=== Key setup choice ===
This field lets you switch between the choices of key assignments for this action. If there is no key assigned, it will display <code><new></code>; otherwise, the text will read <code>"Choice ''x'' (of ''y'')"</code> where '''''x''''' is the number of the current shortcut and '''''y''''' is the total count of this action’s current key assignments. Clicking in this field will display other choices, where you can select the one to edit.

=== Keys ===
Shows the key assignment for this shortcut. Double-clicking in this field (after choosing an action in the Action List) will “listen” for a new key assignment. Any keypresses or recognized MIDI events will be entered into this field and assigned to the action as a keyboard shortcut. In order to stop “listening” for new key assignments, press the Cancel button right next to it or click on another control.

=== Set / Cancel ===
You can also press the Set button to start “listening” for a new shortcut assignment. It then changes into a Cancel button, in case you want to abort the action and not assign a new key.

=== Restore ===
Clicking on this button resets the key assignments of this action to when the action was first selected.

=== On Key Down/Hold/Up ===
When any of these are checked, the action will be activated at the corresponding event of the keypress, either when the key is pressed down, when it is held down, and / or when the key is released.

=== Delete Choice ===
Clicking on this button deletes the current key assignment. If there were other keyboard shortcuts for this action, they remain.

=== Conflict / Warning Display ===
Shows conflicts between the currently chosen action and any other actions. Conflicts occur when one keypress or combination keypress is already assigned to an action within the same context or a parent context. A problem may also occur when modifier keys (<kbd>Shift</kbd>, <kbd>Ctrl</kbd>, <kbd>Alt</kbd> or the <kbd>Windows</kbd> key) are expected but another key is assigned. In this case, OpenMPT will not allow the non-modifier key to be assigned and a warning is displayed here.

== Miscellaneous ==

=== Repeat Note Keys on Hold ===

This checkbox indicates whether all assigned note keys have the “On Key Hold” property set and allows to toggle it quickly for all of them.

If all assigned note keys have the “On Key Hold” property set, the checkbox is checked; if only some of them have the property set, the checkbox is shown in an indeterminate state. Clicking on the checkbox enables or disables the “On Key Hold” property for all note keys.

=== Chord Detect Interval ===
If you have the Pattern Editor’s Edit Step setting set to some other value than 0 and have a record group set up, OpenMPT will put all notes detected within the Chord Detect Interval on the same row, regardless of the Edit Step setting, i.e. the notes are interpreted as a chord.

=== Import Key Map... ===
Use this button to import an <code>.mkb</code> (OpenMPT keyboard layout) file. This allows you to use an alternate set of pre-defined keyboard assignments. In the side bar of the file dialog, a shortcut to the <code>ExtraKeymaps</code> can be found to quickly jump to the alternative keyboard layouts shipped with OpenMPT.

=== Export Key Map... ===
Use this button to export the current set of keyboard shortcuts to a keyboard layout file. This is helpful not only for multiple users of one OpenMPT setup, but also for testing different setups for ease of use.

=== Restore Default Configuration ===
Clicking on this button restores all keybindings to their default keys. From the dropdown menu, you can choose one of several key map “flavours” that change some of the default keys to be more similar to those of Impulse Tracker or Fast Tracker.

[[Category:Manual|Setup/Keyboard]]
[[de:Handbuch: Setup/Keyboard]]

Manual: WavesReverb Plugin

2025-06-01T13:52:18Z

Saga Musix:

[[Image:WavesReverb Plugin.png|thumb|400px|WavesReverb plugin window]]

The '''WavesReverb''' plugin is a simple reverb processor with few parameters, for adding depth and ambience to the signal while being easy to use.

== Parameters ==

=== In Gain ===
* Controls the input level of the signal. It affects both the dry and wet signal, allowing you to reduce the volume of the final signal, in case it is too loud.
* '''Range''': -96 dB to 0 dB

=== Reverb Mix ===
* Controls the level of the wet reverb signal. Lower, more negative values result in a more subtle reverb effect.
* '''Range''': -96 dB to 0 dB

=== Reverb Time ===
* Sets the decay time of the reverb tail, determining how long the reverberated sound takes to fade away. Shorter reverb times simulate a smaller room, while longer reverb times create the impression of expansive, cathedral-like spaces.
* '''Range''': 0ms to 3,000ms

=== HighFreqRTRatio ===
* The High Frequency Reverb Time Ratio is the ratio between high-frequency and low-frequency decay times in the reverb tail. A ratio of 1 means high frequencies decay at the same rate as low frequencies, creating a bright, artificial reverb. Lower ratios cause high frequencies to decay faster than low frequencies, resulting in warmer, more natural-sounding reverb.
* '''Range''': 0 to 1

[[Category:Manual|WavesReverb Plugin]]
[[Category:Plugins|WavesReverb Plugin]]
[[Category:Built-In Plugins|WavesReverb Plugin]]

Manual: ParamEq Plugin

2025-06-01T13:52:13Z

Saga Musix:

[[Image:ParamEq Plugin.png|thumb|400px|ParamEq plugin window]]

The '''ParamEq''' (Parametric Equalizer) plugin is a simple, single-band equalizer based on a biquad filter.
This effect lets you select the frequency to boost or cut, control the bandwidth of the affected range, and adjust the amount of gain applied.

== Parameters ==

=== Center Frequency ===
* Sets the center of the frequency range that will be boosted or cut as specified by the Gain parameter.
* '''Range''': 80 Hz to 16,000 Hz

=== Bandwidth ===
* '''Range''': 1 to 36 Semitones
* Controls the width of the frequency range affected by the EQ. Narrower bandwidths create precise adjustments that affect only a small frequency range, useful for removing specific resonances or feedback frequencies. Wider bandwidths instead affect larger frequency ranges with a more gentle gain slope.

=== Gain ===
* Determines the amount of boost or cut at the center frequency.
* '''Range''': -15 dB to +15 dB

[[Category:Manual|ParamEq Plugin]]
[[Category:Plugins|ParamEq Plugin]]
[[Category:Built-In Plugins|ParamEq Plugin]]

Manual: SymMOD Echo Plugin

2025-06-01T13:52:09Z

Saga Musix:

[[Image:SymMOD Echo Plugin.png|thumb|400px|SymMOD Echo plugin window]]

The '''SymMOD Echo''' plugin is a specialized echo implementation provided primarily for the accurate playback of SymMOD modules by emulating the echo DSP effect of the Symphonie Pro tracker.
It is a basic echo effect with few options. Its main distinguishing feature is that the echo delay is synchronized to the module’s playback tempo.

== Parameters ==

=== Type ===
* Selects the echo processing mode.
* '''Options''': Off, Normal, Cross, Cross 2, Center
** '''Off''': Pauses the echo effect completely.
** '''Normal''': The delayed signal appears in the same stereo position as the source.
** '''Cross''': Cross-channel echo. The left channel’s echo appears in the right channel and vice versa, creating a ping-pong stereo effect.
** '''Cross 2''': Same as '''Cross''', but changes the Feedback parameter’s range (see below).
** '''Center''': Creates a mono delay signal, mixing the left and right channel.

=== Delay ===
* Sets the delay time measured in ticks, allowing for precise tempo synchronization. The actual delay time depends on the current tempo and speed settings and the [[Manual: Song Properties#Tempo Mode|tempo mode]] of the module. Lower values create short, tight echoes, while higher values produce longer, more spacious delays.
* '''Range''': 0 to 127 Ticks

=== Feedback ===
* Determines how much of the delayed signal is fed back into the delay line to create multiple repetitions. Higher feedback values produce longer echo tails with more repetitions, while lower values create fewer repetitions. Due to the original implementation of this effect in Symphonie Pro using an exponential parameter range, only roughly the first 10% of the total value range result in practical feedback values.
* '''Range''':
** If the '''Type''' is not '''Cross 2''': 100%, 50%, 25%, 12.5%, …
** If the '''Type''' is '''Cross 2''': 50%, 75%, 87.5%, 93.75%, …

[[Category:Manual|SymMOD Echo Plugin]]
[[Category:Plugins|SymMOD Echo Plugin]]
[[Category:Built-In Plugins|SymMOD Echo Plugin]]

Manual: MIDI Input / Output Plugin

2025-06-01T13:52:02Z

Saga Musix:

[[Image:MIDI Input Output Plugin.png|thumb|418px|MIDI Input / Output plugin window]]

The '''MIDI Input / Output Plugin''' is a versatile plugin for sending MIDI data to external devices or receiving MIDI input from external controllers.
This plugin complements OpenMPT’s other [[Manual: MIDI Reference|MIDI capabilities]] by allowing to access multiple devices, creating routings between MIDI devices or plugins and offering an extended version of the [[Manual: Zxx Macros|MIDI Macro]] functionality.

Multiple instances of the plugin can be used to address different devices simultaneously, though most MIDI drivers do not allow a single device to be used by multiple plugin instances at the same time.

== Configuration ==

=== MIDI Input Device ===
Selects the MIDI input device from which the plugin will receive MIDI messages. The received MIDI data can be sent to another plugin (through the [[Manual: General#Mix Settings|plugin routing settings]]), or be recorded as pattern data through the '''Record Parameter Changes''' and '''Record MIDI Out to Pattern Editor''' options available from the plugin editor’s [[Manual: Plugin Window#Options|menu bar]].

=== MIDI Output Device ===
Selects the destination for MIDI data sent by the plugin. This can be any external MIDI device, or virtual MIDI routing ports. The special '''Internal OpenMPT Output''' option sends MIDI data to the next plugin in the chain instead, allowing the extended MIDI macro system of this plugin (see below) to be used with other plugins.

By default, the MIDI data is sent out at roughly the same moment OpenMPT’s output is heard. To synchronize the MIDI data with other sound sources, you can delay the MIDI output further by entering a positive '''Output Latency''' if the MIDI data is heard too early. On the other hand, if the MIDI data is heard too late, you can also enter a negative latency amount, down to OpenMPT’s own [[Manual: Setup/Soundcard#Latency|configured latency]], to compensate for any delays introduced by the MIDI port or target MIDI device.

When the '''Send timing messages''' box is checked, OpenMPT will send the following additional MIDI messages:
* Song Start (<code>FA</code>) and Song Stop (<code>FC</code>).
* Song Position Pointer (<code>F2</code>) on every manual position change or start of new measure, up to the maximum possible PPQ position of 16,383 sixteenth notes.
* MIDI Clock (<code>F8</code>).

=== Initial MIDI Dump ===
This allows you to configure specific MIDI messages to be sent either when the module plays for the first time or every time playback restarts. Typical use cases include sending device-specific SysEx configuration messages to external MIDI devices, or setting up initial patch changes and controller values.

The '''Send Now''' button allows to test the entered MIDI messages immediately during playback.

You can import SysEx dump files (.syx) to avoid manual entry of long MIDI messages using the '''Import Dump...''' button.

=== Parameter Macros ===
1,000 plugin parameters are available to be configured to send arbitrary MIDI messages. These macros offer several advantages over regular [[Manual: Zxx Macros|MIDI Macros]]:

* Obviously, you are no longer limited to just 16 different macros.
* While regular MIDI macros have a 31-character limit, plugin macros can contain MIDI message sequences of any length.

The plugin macros follow the same [[Manual: Macro Configuration#Macro Syntax|macro syntax]] as regular MIDI macros. The '''z''' variable is controlled by the plugin parameter value.

You can use [[Manual: Parameter Control Events|Parameter Control Events]] to control these parameters, or, maybe a bit pointlessly, Zxx MIDI macros.

[[Category:Manual|MIDI Input / Output Plugin]]
[[Category:Plugins|MIDI Input / Output Plugin]]
[[Category:Built-In Plugins|MIDI Input / Output Plugin]]

Manual: LFO Plugin

2025-06-01T13:51:55Z

Saga Musix:

[[Image:LFO Plugin.png|thumb|400px|LFO plugin window]]

The '''LFO''' (Low Frequency Oscillator) plugin is a versatile modulation source that can automatically control parameters of other plugins or send MIDI CC messages.
This allows for smooth and cyclic control of plugin parameters when the target plugin or MIDI device has no built-in LFO, or if its built-in LFO is not flexible enough.

== Parameters ==

=== Amplitude ===
* Controls the depth of the LFO modulation. Higher values create more dramatic parameter changes, while lower values produce more subtle modulation. An amplitude of 0.5 allows to modulate the entire parameter range from 0 to 1, assuming that the offset is 0 (centered).
* '''Range''': 0 to 1

=== Offset ===
* Sets a DC offset that shifts the LFO waveform up or down from its center position, ensuring that the LFO stays within the desired parameter range.
* '''Range''': -1 to +1

=== Frequency ===
* Controls the rate at which the LFO oscillates. When '''Tempo Sync''' is off, this sets the frequency in Hertz. When '''Tempo Sync''' is on, this sets the number of LFO cycles per beat, allowing for musically synchronized modulation that stays in time with the module’s tempo.
* '''Range''':
** If '''Tempo Sync''' is '''Off''': 0 Hz to 63.75 Hz
** If '''Tempo Sync''' is '''On''': 0 to 32 Cycles Per Beat

=== Tempo Sync ===
* Enables or disables tempo synchronization. When set to '''On''', the LFO frequency is synchronized to the module’s tempo and measured in cycles per beat. When set to '''Off''', the LFO runs freely at the specified frequency regardless of tempo changes.
* '''Options''': Off, On

=== Waveform ===
* Selects the shape of the LFO waveform:
* '''Options''': Sine, Triangle, Saw, Square, Noise, Smoothed Noise
** '''Sine''': Smooth modulation.
** '''Triangle''': Linear ramp up and down.
** '''Saw''': Rising sawtooth wave.
** '''Square''': Abrupt switching between minimum and maximum modulation value.
** '''Noise''': Random, stepped modulation.
** '''Smoothed Noise''': Random modulation changing gradually.

=== Invert Polarity ===
* When set to '''Yes''', the LFO waveform is flipped upside down. This allows for example to ramp the Saw waveform down instead of up, or to create an up-down-up-down pattern instead of down-up-down-up with the Square waveform.
* '''Options''': No, Yes

=== Bypass LFO ===
* Allows to temporarily pause the LFO while keeping all settings intact.
* '''Options''': No, Yes

=== Loop Mode ===
* Controls whether the LFO waveform repeats infinitely or stops after one full cycle. '''Looped''' repeats the waveform for continuous modulation. '''One-Shot''' goes through the waveform once and then stops, allowing for a more envelope-like modulation that occurs only at the beginning of a note or phrase.
* '''Options''': Looped, One-Shot

== Output ==
Here you can choose the plugin that should be affected by the LFO’s output. This is equivalent to choosing the output plugin in the regular [[Manual: General#Mix Settings|plugin routing settings]], hence only plugins with a slot ID higher than the current plugin’s slot ID can be chosen.
You can select whether you want to automate a specific plugin parameter, or instead send MIDI CC messages to the specified MIDI channel.

== External Control ==
* The LFO plugin exposes parameter number 8 ('''Set LFO Phase''') which can be used to manually reset the LFO phase at any point through pattern data, for example through [[Manual: Parameter Control Events|Parameter Control Events]]. Setting this parameter to 0 resets the LFO phase to the start of the waveform, setting it to 0.5 (setting the Parameter Control Event parameter to 500) restarts the the waveform halfway through, etc.
* If the LFO plugin is assigned to an instrument with a valid MIDI channel, sending a note to the LFO plugin will reset the LFO’s phase as well.
* All MIDI data sent to the LFO plugin is forwarded to the target plugin.

[[Category:Manual|LFO Plugin]]
[[Category:Plugins|LFO Plugin]]
[[Category:Built-In Plugins|LFO Plugin]]

Manual: I3DL2Reverb Plugin

2025-06-01T13:51:49Z

Saga Musix:

[[Image:I3DL2Reverb Plugin.png|thumb|400px|I3DL2Reverb plugin window]]

The '''I3DL2Reverb''' plugin is an advanced reverberation processor based on the Interactive 3D Audio Level 2 (I3DL2) specification.
This reverb can simulate various acoustic spaces and environments, offering control over early reflections, reverb tail characteristics, and frequency response.
Various presets from the I3DL2 specification are provided as starting points for your own reverb parameter design.

Note that this plugin outputs only the “wet” reverb signal, so enabling the “Dry Mix” option is recommended.

== Parameters ==

=== Room ===
* Controls the overall level of the reverb and thus allows to balance it against the dry signal. Higher values (closer to 0 dB) produce louder reverb, while lower values result in a more subtle reverb effect.
* '''Range''': -100 dB to 0 dB

=== Room HF ===
* Adjusts the level of high-frequency content in the reverb. Lower values create warmer, more muffled reverb by reducing high frequencies, simulating absorption by soft materials like carpet or curtains. Higher values preserve brightness in the reverb tail, sounding more airy and artificial.
* '''Range''': -100 dB to 0 dB

=== RoomRolloffFactor ===
* This parameter does not do anything. It only exists for backwards-compatibility with the original DMO plugin.

=== Decay Time ===
* Sets the time it takes for the reverb to decay by 60 dB. This is the fundamental parameter that determines the size of the simulated space. Shorter reverb times simulate a smaller room, while longer reverb times create the impression of expansive, cathedral-like spaces.
* '''Range''': 0.1s to 20s

=== Decay HF Ratio ===
* Determines the ratio between the decay of high frequencies and low frequencies. Values less than 1 make high frequencies decay faster than low frequencies, creating warmer, more natural-sounding reverb. Values greater than 1 make high frequencies decay slower, creating a brighter, more airy and artificial reverb.
* '''Range''': 0.1 to 2.0

=== Reflections ===
* Sets the level of early reflections, which are the first echoes that reach the listener after bouncing off nearby surfaces, providing spatial cues about room size and shape. Higher values make the space sound more reflective.
* '''Range''': -100 dB to +10 dB

=== Reflections Delay ===
* Controls how long it takes until early reflections are heard. Longer delays suggest larger spaces with more distant walls, while shorter delays indicate a smaller space.
* '''Range''': 0s to 0.3s

=== Reverb ===
* Adjusts the level of the late reverb tail, which is the dense mix of reflections that creates the sustained reverb sound. This parameter controls the prominence of the reverb tail relative to the early reflections and direct signal.
* '''Range''': -100 dB to +20 dB

=== Reverb Delay ===
* Sets the delay between the early reflections and the onset of the late reverb tail. The gap between early reflections and late reverb helps define the perceived size and shape of the environment. Longer delays make the reverb sound more distinct from the source.
* '''Range''': 0s to 0.1s

=== Diffusion ===
* Controls how quickly the echo density builds up in the reverb tail. Higher diffusion values create smoother, more even reverb with less distinct echoes. Lower values preserve more of the individual reflections, which can sound more spacious but less smooth.
* '''Range''': 0% to 100%

=== Density ===
* Determines the spread in time between individual reverb delays, affecting how thick or sparse the reverb sounds. Higher density values create fuller, more lush reverb, while lower values produce thinner, more metallic reverb.
* '''Range''': 0% to 100%

=== HF Reference ===
* Sets the reference frequency that defines what is considered “high frequencies” for the Room HF and Decay HF Ratio parameters.
* '''Range''': 20 Hz to 20,000 Hz

=== Quality ===
* Selects the reverb quality, directly affecting CPU usage by the plugin.
* '''Options''': LQ, LQ+, HQ, HQ+
** '''LQ''': The reverb is downsampled for processing, fewer delay lines are used.
** '''LQ+''': The reverb is downsampled for processing, more delay lines are used.
** '''HQ''': The reverb is processed at the original sample rate, fewer delay lines are used.
** '''HQ+''': The reverb is processed at the original sample rate, more delay lines are used.

[[Category:Manual|I3DL2Reverb Plugin]]
[[Category:Plugins|I3DL2Reverb Plugin]]
[[Category:Built-In Plugins|I3DL2Reverb Plugin]]

Manual: Gargle Plugin

2025-06-01T13:51:43Z

Saga Musix:

[[Image:Gargle Plugin.png|thumb|400px|Gargle plugin window]]

The '''Gargle''' plugin creates a gargling sound effect by rapidly modulating the amplitude (volume) of the input signal.
This effect produces rhythmic pulsations that can range from a simple tremolo to extreme, robotic modulation effects useful for special effects.

== Parameters ==

=== Rate ===
* Controls the frequency of the amplitude modulation, determining how rapidly the volume fluctuates. Lower rates (around 1 to 10 Hz) create slower, tremolo-like effects. High rates sound more robotic and can create ring modulation-like effects.
* '''Range''': 1 Hz to 1,000 Hz

=== Wave Shape ===
* Selects the waveform used for amplitude modulation. '''Triangle''' creates a smooth, gradual volume change, while '''Square''' abruptly switches the signal between full volume and silence, creating a gate effect at low rates and causing even more harmonic distortion at higher rates.
* '''Options''': Triangle, Square

[[Category:Manual|Gargle Plugin]]
[[Category:Plugins|Gargle Plugin]]
[[Category:Built-In Plugins|Gargle Plugin]]

Manual: Flanger Plugin

2025-06-01T13:51:37Z

Saga Musix:

[[Image:Flanger Plugin.png|thumb|400px|Flanger plugin window]]

The '''Flanger''' plugin creates a swooshing, jet-like effect by mixing the original signal with a modulated delayed copy.
It is very similar to the [[Manual: Chorus Plugin|Chorus plugin]], with a slightly different parameter range, and a stereo delay line (as opposed to mono in the Chorus plugin).

== Parameters ==

=== Wet / Dry Mix ===
* Controls the balance between the original (dry) signal and the processed (wet) flanged signal. At 0% wet, only the original signal is heard. At 100% wet, only the flanged signal is audible. Values in between blend the two signals, where values around 50% provide the most pronounced flanging effect due to equal mixing of the signals.
* '''Range''': 0% to 100% wet

=== Wave Shape ===
* Selects the waveform used by the low-frequency oscillator (LFO) for modulation. '''Sine''' smoothly sweeps the frequency of the flanged signal up and down. '''Square''' results in a more abrupt, stepped modulation that can sound more mechanical or rhythmic.
* '''Options''': Square, Sine

=== Frequency ===
* Sets the rate of the low-frequency oscillator (LFO) that modulates the flanger effect. Lower frequencies create a slow, subtle movement, while higher frequencies produce faster, more rapid modulation.
* '''Range''': 0 Hz to 10 Hz

=== Depth ===
* Determines the intensity of the pitch modulation applied to the delayed signal. Higher values create more pronounced flanger effects with greater pitch variation, while lower values produce subtler modulation. The effective depth is limited by the '''Delay''' parameter; if the delay is small, the depth is also more limited.
* '''Range''': 0% to 100%

=== Phase ===
* Sets the phase difference between the left and right channel modulation. This parameter controls the stereo width and movement of the flanger effect. 0° keeps both channels in phase, while ±180° creates maximum stereo separation.
* '''Options''': -180°, -90°, 0°, 90°, 180°

=== Feedback ===
* Controls how much of the processed signal is fed back into the input. Negative values create phase-inverted feedback. Higher absolute values produce more intense, resonating effects.
* '''Range''': -99% to +99%

=== Delay ===
* Sets the delay time for the flanger effect. This determines the timing offset between the original and processed signals. Longer delays create a more spacious sound, while shorter delays produce intense phasing.
* '''Range''': 0ms to 4ms

[[Category:Manual|Flanger Plugin]]
[[Category:Plugins|Flanger Plugin]]
[[Category:Built-In Plugins|Flanger Plugin]]

Manual: Echo Plugin

2025-06-01T13:51:30Z

Saga Musix:

[[Image:Echo Plugin.png|thumb|400px|Echo plugin window]]

The '''Echo''' plugin creates delayed repetitions of the input signal, ranging from subtle slap-back delays to long stereo echoes.
While echos can traditionally be achieved in modules by inserting delayed and attenuated copies of pattern notes, the Echo plugin offers more flexible control over the resulting echo, and avoids having to update echo pattern data any time the original notes are modified, at the expense of not being synchronized to the module’s tempo.

== Parameters ==

=== Wet / Dry Mix ===
* Controls the balance between the original (dry) signal and the delayed (wet) echo. At 0% wet, only the original signal is heard. At 100% wet, only the echo is audible. Intermediate values blend the original and echo signals together.
* '''Range''': 0% wet / 100% dry to 100% wet / 0% dry

=== Feedback ===
* Determines how much of the delayed signal is fed back into the delay line to create multiple repetitions. Higher feedback values produce longer echo tails with more repetitions, while lower values create fewer repetitions. Note that the higher the feedback value, the quieter the initial echo will be.
* '''Range''': 0% to 100%

=== Left Delay ===
* This controls the timing between the original signal and its echo in the left channel.
* '''Range''': 1ms to 2,000ms

=== Right Delay ===
* Sets the delay time for the right channel. When different from the left delay time, this creates a stereo effect where echoes appear to bounce between the left and right channels. Setting both channels to the same delay time creates a centered echo effect instead.
* '''Range''': 1ms to 2,000ms

=== Pan Delay ===
* When set to '''Yes''', the echo bounces between the left and right channels, creating a ping-pong echo effect. When set to '''No''', the left and right channel are not mixed.
* '''Options''': No, Yes

[[Category:Manual|Echo Plugin]]
[[Category:Plugins|Echo Plugin]]
[[Category:Built-In Plugins|Echo Plugin]]

Manual: Distortion Plugin

2025-06-01T13:51:25Z

Saga Musix:

[[Image:Distortion Plugin.png|thumb|400px|Distortion plugin window]]

The '''Distortion''' plugin adds harmonic saturation and overdrive to the audio signal by deliberately clipping and reshaping the waveform.
The resulting effect can range from subtle saturation to aggressive, heavily distorted sounds.

== Parameters ==

=== Gain ===
* Sets the final output gain. If the signal is distorted heavily, it can be helpful to slighty reduce its gain, so that it does not over-power other instruments.
* '''Range''': -60 dB to 0 dB

=== Edge ===
* Determines the character and intensity of the distortion effect. Lower values produce softer distortion with gentle clipping, while higher values create harsher, more aggressive distortion with hard clipping characteristics. This parameter shapes the overall tone and harmonic content of the distorted signal.
* '''Range''': 0 to 100

=== Pre Lowpass Cutoff ===
* Sets the cutoff frequency of the lowpass filter applied to the signal before applying distortion. This filter removes high-frequency content that might cause harsh artifacts when distorted. Lower cutoff frequencies result in warmer, more muffled distortion, while higher frequencies preserve more brightness and edge.
* '''Range''': 100 Hz to 8,000 Hz

=== Post EQ Center Frequency ===
* Sets the cutoff frequency of the resonant lowpass filter applied after the distortion processing. This filter can be used take away some of the high frequencies added by the distortion, and to emphasize specific frequencies in the distorted signal, helping to shape the final tonal character of the sound.
* '''Range''': 100 Hz to 8,000 Hz

=== Post EQ Bandwidth ===
* Controls the bandwidth of the resonant lowpass filter applied after the distortion processing. A narrower bandwidth removes more high frequencies but also boost the filter’s center frequency, while a wider bandwidth results in a softer lowpass filter with less resonance.
* '''Range''': 100 Hz to 8,000 Hz

[[Category:Manual|Distortion Plugin]]
[[Category:Plugins|Distortion Plugin]]
[[Category:Built-In Plugins|Distortion Plugin]]

Manual: DigiBooster Pro Echo Plugin

2025-06-01T13:51:21Z

Saga Musix:

[[Image:DigiBooster Pro Echo Plugin.png|thumb|400px|DigiBooster Pro Echo plugin window]]

The '''DigiBooster Pro Echo''' plugin is a specialized echo implementation provided primarily for accurate playback of DBM modules by emulating the echo DSP effect of the DigiBooster Pro tracker.

== Parameters ==

=== Delay ===
* Sets the delay time of the echo. Setting the delay to the lowest-possible value results in a delay of 334ms instead, emulating a bug in the original DigiBooster Pro DSP code.
* '''Range''': 2ms to 510ms

=== Feedback ===
* Determines how much of the delayed signal is fed back into the delay line to create multiple repetitions. Higher feedback values produce longer echo tails with more repetitions, while lower values create fewer repetitions. Note that the higher the feedback value, the quieter the initial echo will be.
* '''Range''': 0 to 255

=== Wet / Dry Ratio ===
* Controls the balance between the original (dry) signal and the delayed (wet) echo effect. At 0% wet, only the original signal is heard. At 100% wet, only the echo is audible. Intermediate values blend the original and echoed signals together.
* '''Range''': 0% wet / 100% dry to 100% wet / 0% dry

=== Cross Echo ===
* Controls how much the delayed signal is mixed between the left and right channels. At a value of 0, there is no cross-channel mixing and the echo appears in the same channel as the source. As the value increases, more of the echo signal is sent to the opposite channel and less to the source channel. At maximum (255), the echo completely swaps between channels, creating a ping-pong effect.
* '''Range''': 0 (no mixing) to 255 (echo completely swaps between channels)

[[Category:Manual|DigiBooster Pro Echo Plugin]]
[[Category:Plugins|DigiBooster Pro Echo Plugin]]
[[Category:Built-In Plugins|DigiBooster Pro Echo Plugin]]

Manual: Compressor Plugin

2025-06-01T13:51:14Z

Saga Musix:

[[Image:Compressor Plugin.png|thumb|400px|Compressor plugin window]]

The '''Compressor''' plugin reduces the dynamic range of audio signals by automatically lowering the volume of loud sounds and optionally adjusting the overall gain of the compressed signal.
Compressors are an essential tool for achieving consistent volume levels, adding punch to drums, and removing peaks in the signal.

== Parameters ==

=== Gain ===
* Sets the final output gain. Use this for example to compensate for volume reduction caused by compression.
* '''Range''': -60 dB to +60 dB

=== Attack ===
* Determines how quickly the compressor responds to signals that exceed the threshold. Faster attack times (lower values) immediately act on loud transients, while slower attack times allow more of the initial transient to pass through before compression begins.
* '''Range''': 0.01ms to 500ms

=== Release ===
* Controls how quickly or slowly the compressor recovers from compressing the signal after the signal drops below the threshold again. Fast release times restore the signal quickly but may cause undesired pumping effects, while slow release times provide smoother compression but may over-compress subsequent sounds.
* '''Range''': 50ms to 3,000ms

=== Threshold ===
* When the signal level is above the threshold, the signal will be compressed according to the ratio setting. Lower threshold values mean more of the signal will be compressed, while higher values only compress the loudest peaks.
* '''Range''': -60 dB to 0 dB

=== Ratio ===
* Determines the amount of compression applied to signals above the threshold. A ratio of 1:1 means no compression, while higher ratios provide more aggressive compression. A ratio of ''x'':1 means that for every ''x'' dB above the threshold, the compressor increases the output by 1 dB.
* '''Range''': 1:1 to 100:1

=== Predelay ===
* Introduces a small delay between when the compressor “looks” at the input signal to determine whether it is above the threshold or not, and when it applies them to the output signal. This allows the compressor to “look ahead” and begin compression slightly before loud transients occur, resulting in more consistent compression of fast attacks.
* '''Range''': 0ms to 4ms

[[Category:Manual|Compressor Plugin]]
[[Category:Plugins|Compressor Plugin]]
[[Category:Built-In Plugins|Compressor Plugin]]