OpenMPT Wiki - User contributions [en]

Manual: Module formats

2021-12-20T20:26:23Z

Twomoso: /* File formats that can only be read by OpenMPT */ "symmmod" to "symmod"

== File formats that can be read and written by OpenMPT ==

=== The ProTracker MOD format (.mod) ===

The MOD format was the first file format for tracked music on the Commodore Amiga. A very basic version of this format (with only very few pattern commands and short samples supported) was introduced by Karsten Obarski’s Ultimate SoundTracker.
It was designed to use 4 channels each with one voice. Ultimate SoundTracker was soon superseded by NoiseTracker and ProTracker, which allowed for more tracker commands (effects), longer samples, more patterns and other improvements. Later, variants of the MOD format that appeared on the Personal Computer extended the number of channels, added panning commands (the Amiga’s four hardware channels had a pre-defined stereo setup) and expanded the Amiga’s frequency limit, allowing for more octaves of notes to be supported.

Arguably one of the most widespread tracker formats (also due to its use in many computer games and demos), it is also one of the simplest to use, but also only provides few pattern commands to use.
With OpenMPT, you can use up to 99 tracks (the default is 4, and not all applications support that many channels - few support more than 32). Instruments cannot be used in the MOD format, only 8-bit samples with a maximum size of 128 KB per sample and with a limited set of parameters.
Initial tempo, number of rows (always 64), and the “time signature” cannot be defined (always uses the highlight values provided in the [[Manual:_Setup/Display|Display setup]]).
There is limited sample control and few global settings.

=== The Scream Tracker 3 format (.s3m) ===

Scream Tracker 3′s S3M format added sample tuning (defining the exact frequency of the middle C for samples), increased the number of playback channels, made use of an extra column specifically for volume control (which was extended by other trackers to handle panning commands as well), and compressed pattern data for smaller file sizes.
Other improvements include the ability to set the initial tempo and speed (ticks per row), initial global and sample volume as well as initial channel panning. Compared to MOD, there is also a different, expanded set of effect commands.

A unique feature of the S3M format is the ability to make use of samples and synthesized FM instruments (via the Yamaha OPL2 chip) at the same time. OpenMPT can fully emulate this chip in software.

=== The FastTracker 2 format (.xm) ===

With the XM format, Fasttracker 2 introduced the concept of “instruments”, which applied volume and panning envelopes to samples. It also added the ability to map several samples to the same instrument for multi-sampled instruments or drum sets. XM uses instrument-based panning – instrument numbers in patterns always reset the channel’s panning to the current sample’s initial panning.
It uses MOD effect command letters, plus a few of its own for more sound control.
You can define initial tempos and speeds; provide envelopes to samples by assigning them to instruments; set sample looping and apply automatic sample vibrato oscillation; and with OpenMPT, apply VST plugins to instruments, channels, or the whole track to spice up your old XM compositions.

=== The Impulse Tracker format (.it) ===

Impulse Tracker introduced the IT format, which, in comparison to the XM format, allows instruments to also specify the transposition of assigned samples depending on the note being played, applying resonant filters to samples, and defining “New Note Actions” (NNAs) for instruments to release playing notes on a pattern channel while a new note is already playing, which helps to keep the number of pattern channels at a manageable amount while still being able to have a high polyphony. Like S3M files (and contrary to XM files), panning is channel-based, meaning that channels have an initial pan position which can be overridden by panning commands or instruments’ and samples’ default panning settings.
Samples also have decent compression in file storage when saving IT files directly in Impulse Tracker or enabling OpenMPT's [[Manual: Hidden Settings#.5BMisc.5D|experimental IT compression settings]].
IT effect commands use a more advanced set of S3M commands.

=== The OpenMPT format (.mptm) ===

MPTM is OpenMPT’s own format. It is based on the IT format, with added capabilities of [[Manual:_Tuning_Properties|custom sample tunings]], [[Manual:_Parameter_Control_Events|Parameter Control events]], multiple [[Manual:_Patterns#Order_List|Pattern Sequences]], [[Manual: Tempo Swing Settings|tempo swing]], fractional tempos, global resampling settings and many more features. Some features such as VST plugins are currently usable in XM and IT as well but really should only be used in MPTM files. You can find these features by using the [[Manual:_Menus#View|Find Hacks]] functionality in the View menu.

Compared to IT, this format also adds back support for the OPL chip as found in the S3M format with several useful additions, such as being able to apply instrument envelopes to FM instruments or controlling the modulator intensity through sample filter cutoff.

=== The MIDI format (.mid) ===

MIDI files are of course not module files, and OpenMPT is by no means a MIDI editor. MIDI files store note data and timing information in a way that is not easily converted to a pattern-based tracker format.

OpenMPT can import many MIDI-sequenced songs in the MID / RMI format, but it is important to remember that sequencer files are not the same as modules and the data within these files does not translate well to a tracking format. MIDI import is thought of as a tool to import your old MIDI-based projects, remix stems and similar things more than as a way to listen to MIDI files in OpenMPT — there are far better MIDI players out there.

When importing MIDI files, experiment with the File Import settings in the [[Manual: Setup/MIDI|MIDI Setup]]. In particular, try different quantization values if not enough note detail can be imported, or lower the Ticks / Row to get rid of some unnecessary Note Delay and Note Cut effects at the expensive of a less accurate import.

OpenMPT supports the following General MIDI and XG features:
* '''MIDI CCs''': Bank Select, Pan Position, Expression, Channel Volume, Hold Pedal, CC 111 loop points, Mono / Poly Operation, All Controllers / Sounds / Notes Off
* '''RPNs''': Pitch Bend Range, Coarse Tune
* '''System Exclusive''': Master Volume, Master Transpose, GS Drum Kit. XG System On enables drums on bank 127 on any channel.

OpenMPT reads embedded soundfonts in RMI files, and automatically loads patches from soundfonts that carry the same name as the MIDI file, as long as they are placed in the same directory.

=== Choosing a module format ===

Each format supported by OpenMPT has its own strengths and use cases, so sometimes it might not be obvious with format to pick.

If you do not intend to spread your module files, or if compatibility with other software is not a requirement, using OpenMPT’s MPTM format is the most logical choice, as it is the most advanced among the supported formats, and new features are added to the format every now and then.

If you would like to be able to spread your modules and play your music in a wide variety of legacy module players and trackers, the IT format offers the most features and is supported by a lot of software.

Using the MOD, XM and S3M formats is only recommended if you intend to target a platform or software that only supports those formats. For instance, if you want to be able to play your modules on an Amiga computer, a 4-channel ProTracker MOD file would be the most logical choice.

{{NewVersion|3991}}
== File formats that can only be read by OpenMPT ==

The following formats can be imported into OpenMPT. Internally, they are converted to one of the file formats described above.
Depending on the source format, conversion might not always be accurate.

* Composer 669 / UNIS 669 (.669)
* ASYLUM Music Format / Advanced Music Format (.amf)
* Extreme’s Tracker / Velvet Studio (.ams)
* Composer 670 / CDFM (.c67)
* Digi Booster Pro (.dbm)
* Digi Booster (.digi)
* X-Tracker (.dmf)
* DSIK (.dsm)
* Digital Symphony (.dsym)
* Digital Tracker / Digital Home Studio (.dtm)
* Farandole Composer (.far)
* Davey W. Taylor’s FM Tracker (.fmt)
* General Digital Music (.gdm)
* Ice Tracker / SoundTracker 2.6 (.ice / .st26)
* Imago Orpheus (.imf)
* Impulse Tracker Project (.itp) – legacy OpenMPT format with instruments stored in external files rather than directly in the module
* Jazz Jackrabbit 2 Music (.j2b)
* SoundTracker and compatible (.m15 / .stk)
* DigiTrakker (.mdl)
* OctaMED (.med)
* MO3 (.mo3)
* MadTracker 2 (.mt2)
* MultiTracker (.mtm)
* Psycho Pinball / Micro Machines 2 music format (.mus)
* Oktalyzer (.okt)
* OggMod-compressed XM files (.oxm)
* Epic Megagames MASI (.psm)
* Disorder Tracker 2 (.plm)
* ProTracker 3.6 IFF (.pt36)
* PolyTracker (.ptm)
* SoundFX / MultiMedia Sound (.sfx / .sfx2 / .mms)
* Scream Tracker 2 (.stm)
* Scream Tracker Music Interface Kit (.stx)
* Soundtracker Pro II (.stp)
* Symphonie / Symphonie Pro (.symmod)
* UltraTracker (.ult)
* Unreal Music (.umx) ''only from Unreal (Tournament 1), Deus Ex and Jazz Jackrabbit 3D''
* Mod's Grave (.wow)

=== Compressed modules ===
OpenMPT also handles several compression formats, so you do not need to extract modules from these formats to be able to listen to them: Modules in ZIP, RAR, LHA and GZ containers can be opened directly. Modules in ZIP or RAR archives make use of custom file extensions sometimes; Instead of ZIP or RAR, the file extension might be one of the following: MDZ, S3Z, XMZ, ITZ, MPTMZ, MDR. OpenMPT generally does not care about file extensions though, so it does not matter which extension you use for your compressed modules.

OpenMPT cannot save modules into compressed files, you will have to save your work as a normal module first and then compress it e.g. with Windows’ Zip capabilities or other third party compression utilities.

Some module-specific compression routines are also supported, for example MMCMP, XPK (with SQSH compression) and PowerPacker PP20.

Furthermore, OpenMPT can handle MO3 files. [https://www.un4seen.com/mo3.html MO3] is a highly compressed module format with lossy sample compression.
MO3 encapsulates the features of several module formats (IT, MOD, MPTM, MTM, S3M, XM), but with one big difference: MP3 and Ogg compressed samples.
It also has a lossless codec for any samples that do not like lossy encoding, and the whole file structure is compressed too.

[[Category:Manual|Module formats]]

Manual: Setup/Mixer

2021-12-20T20:17:22Z

Twomoso: /* Volume Ramping */ "the Reset to Defaults reverts" to "the Reset to Defaults button reverts"

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

The settings on this page influence how the OpenMPT mixer renders the audio data.

== Resampling ==

OpenMPT needs to resample/interpolate samples when their sampling rate does not match the output rate or when they are played at a different pitch.

=== Filter ===

The default sample interpolation filter can be set here. You can also set the Resampling algorithm separately for each [[Manual: Instruments|Instrument]].

Interpolation is done whenever a sample has to be resampled from one sampling rate for another. For example, playing a 22 kHz sample in a module that is played back at 44 kHz requires the sampling rate of the sample to be doubled. The most primitive resampling algorithm, “no interpolation”, just repeats sampling points (in the example, it doubles them). This is very cheap mathematically, but also introduces unwanted frequencies into the resampled sample that should not be there. This is called aliasing. For lo-fi samples such as in chiptunes, this effect can actually be desired.

All the more sophisticated resampling methods try to get rid of this aliasing noise in different ways. While Linear interpolation (2 taps) is the most primitive in mathematics (apart from "No Interpolation", obviously), it is also the harshest in sound quality. Cubic interpolation (4 taps) sounds slightly better and with the 8-tap Sinc filters, there is a definite improvement. In addition to the regular Sinc filter, Sinc with Low-Pass additionally applies a slight low-pass filter when downsampling which reduces aliasing a bit.

On modern systems, it is recommended to use one of the two higher quality 8 tap filters. If you have a slower system, try cubic interpolation which does not decrease sound quality too much in comparison to the 8 tap filters.
If you care about faithful replay of older module files, you may prefer to use No (especially for Amiga tracks) or Linear Interpolation.

=== Legacy information ===

In OpenMPT 1.28, the names of some of the resampling filters were changed into more generic, less confusing names:
* '''XMMS-ModPlug''' is now '''Sinc'''
* '''Polyphase''' is now '''Sinc + Low-Pass'''

=== Use Amiga resampler for Amiga modules ===

Enabling this option overrides the interpolation filter specified in the previous settings for Amiga modules (e.g. DIGI, ICE, MOD, MED, SFX, ST26, STP, ...) with a resampler that models the output of the Amiga sound chip ([https://en.wikipedia.org/wiki/Amiga#Sound Paula]) more closely, at the expense of a slightly higher CPU consumption compared to other resamplers. The setting does not affect non-Amiga formats.

* For individual modules, the Amiga resampler can be overridden by the Resampling option on the [[Manual: General#Miscellaneous|General Tab]] of the module.
* When enabling this option, the [[Manual: Effect Reference#Effect Column|E0x effect]] can be used in MOD files to toggle the Amiga LED filter.
* When writing new modules in OpenMPT, the Amiga resampler is only available in 4-channel MOD files that solely contain notes in the range C-4 to B-6.
* It is recommended to set the [[Manual: Setup/Soundcard#Sample Rate|sample rate]] to at least 44100 Hz when using the Amiga resampler.
* The filter characteristics of several Amiga models can be emulated: Amiga 500 (dull sound), Amiga 1200 (bright sound), and unfiltered output. In the latter case, the E0x effect does not influence the output.

== Volume Ramping ==

Ramping is applied to samples to avoid clicks at the beginning and the end of the sample in order to avoid unwanted clicks from bad DC offsets. The default ramp settings can be configured here, but they can also be overridden by an instrument-specific setting.

* '''up''' applies “fade-in” to the samples in an effort to dampen the clicks that come with poorly assembled sample waveforms, or from offset commands that “break into” a loud spot in the sample.
* '''down''' fades out the end of a sample that is stopped through note cuts. However, samples that end on their own are not affected by the ramping value, as a different fade-out slope is used there to prevent clicks from samples that do not end on zero level.

Ramping also makes volume slides smoother, so changing volume levels rapidly does not cause clicks.

Using the '''Reset to Defaults''' button reverts both ramping values to their respective default settings.

== Stereo Separation ==

Allows for greater separation of the stereo channels; moving the slider modifies the amount of stereo separation.
On headphones, it may be desirable to set this value to something below 100%, while on a normal speaker setup, stereo separation should be kept at 100%. If your speakers are too close to each other, it might help to increase stereo separation.

== Legacy Options ==

These options are only provided for modules that use legacy mix levels MPT 1.16, 1.17 RC1 and 1.17 RC2. They only affect samples — instrument plugins are not affected, which can lead to problems with modules that use both samples and plugins. If you have such modules which use legacy mix levels, you should not touch these settings.

=== Soft Panning ===

Originally thought of as a special panning mode that sounds more pleasant on headphones, this panning mode is forced when using [[Manual: Song Properties#Mix Levels|RC3 Mix Levels]] and always disabled when using [[Manual: Song Properties#Mix Levels|Compatible Mix Levels]].
As this can drastically alter the sound of stereo modules, it should not be enabled.

=== Pre-Amp ===

An obsolete feature which boosts the volume of all samples. When using [[Manual: Song Properties|RC3]] or [[Manual: Song Properties|Compatible Mix Levels]], the Pre-Amp Level is overridden and a default value is used.

[[Category:Manual|Setup/Mixer]]
[[de:Handbuch: Setup/Mixer]]

Manual: Effect Reference

2021-12-11T06:23:28Z

Twomoso: /* MPTM Effect Commands */ (Effect Column, Combined Commands) Add `abbr` tags

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, most effects only affect samples, not instrument plugins. 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 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
| —
| Sets the finetune value for the current sample. Functions similarly to the same setting in the Sample Editor.
| 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
| —
| Sets the finetune value for the current sample. Functions similarly to the same setting in the Sample Editor.
| 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>A0y</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>Ax0</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, 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
| 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-pitch" | Pitch
|-
| '''<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 the inversed phase instead.
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 ScreamTracker 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-pitch" | Pitch
|-
| '''<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>), <code>xx</code> is added to the parameter of the original command × 256. 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. By default, <code>x</code> × 2048 is used; specific 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: Effect Reference

2021-12-11T06:17:17Z

Twomoso: /* MPTM Effect Commands */ (Effect Column) Add "Pitch" category column to `+xx` & `*xx`

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, most effects only affect samples, not instrument plugins. 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 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
| —
| Sets the finetune value for the current sample. Functions similarly to the same setting in the Sample Editor.
| 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
| —
| Sets the finetune value for the current sample. Functions similarly to the same setting in the Sample Editor.
| 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>A0y</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>Ax0</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, 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
| 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-pitch" | Pitch
|-
| '''<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 the inversed phase instead.
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 ScreamTracker 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-pitch" | Pitch
|-
| '''<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>), <code>xx</code> is added to the parameter of the original command × 256. 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 <code>+xx</code>, 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. By default, <code>x</code> × 2048 is used; specific 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 <code>oxx</code> and effect column <code>Oxx</code> 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: Effect Reference

2021-12-11T06:06:21Z

Twomoso: /* Combined Commands */ "behavious" to "behaviours"

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, most effects only affect samples, not instrument plugins. 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 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
| —
| Sets the finetune value for the current sample. Functions similarly to the same setting in the Sample Editor.
| 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
| —
| Sets the finetune value for the current sample. Functions similarly to the same setting in the Sample Editor.
| 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>A0y</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>Ax0</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, 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
| 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-pitch" | Pitch
|-
| '''<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 the inversed phase instead.
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 ScreamTracker 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-pitch" | Pitch
|-
| '''<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>), <code>xx</code> is added to the parameter of the original command × 256. 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.
|-
| '''<code>*xx</code>'''
| Finetune (Smooth)
| —
| Exactly the same as <code>+xx</code>, but slides from the previous finetune value to the new value on every tick of the row.
|}

=== 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. By default, <code>x</code> × 2048 is used; specific 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 <code>oxx</code> and effect column <code>Oxx</code> 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: Patterns

2021-12-08T11:52:53Z

Twomoso: /* Order List */ Grammar fixes ("oder list" to "order list"; "Separator pattern can be added" to "Separator patterns [...]")

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

{{todo|This article is incomplete. There are still many treasures to be found in the pattern editor that are not documented here.}}

The pattern editor is used to assemble your musical compositions. Every module consists of a set of '''patterns''', which hold the note data, and one or multiple '''sequences''', which are a collection of references to patterns and dictate the playback order of those patterns. The current sequence is always displayed in the '''Order List'''.

Every pattern is represented by a table, consisting of rows (time) and columns (simultaneously playing channels). All patterns have the same amount of channels that is configurable from the [[Manual: Song Properties#Channels|Song Properties dialog]], and depending on the module format, the number of rows can also be changed for each pattern in the [[Manual: Pattern Properties|Pattern Properties]].

Patterns contain note data for triggering samples and instrument plugins, but they can also contain effect commands that change global parameters such as tempo or volume, [[Manual: Parameter Control Events|plugin automation]], pitch-altering effects and many other things. A list of effect commands that can be entered into patterns is available in the [[Manual: Effect Reference|effect reference]].

== Toolbar ==

[[Image:Pattern Toolbar.png]]

* '''New Pattern''': Creates a new empty pattern, using the same number of rows as the current pattern, and adds it to the Order List.
* '''Play Pattern''': Starts playback of the current pattern from the current row and loops the pattern.
* '''Replay Pattern''': Restarts playback of the current pattern from the first row and loops the pattern.
* '''Stop''': Stops playback altogether.
* '''Play Row''': Only plays the currently focussed row of the pattern and steps to the next row.
* '''Record''': Toggles the recording status of the pattern. If recording is disabled, previewed notes can still be heard but will not be entered into the pattern data.
* '''VU Meters''': Toggles display of the channel VU meters. The VU meters do not show the actual volume on the channels, but rather the calculated note volume, i.e. the volume level at which the sample or plugin is played.
* '''Show Plugins''': Toggles display of the channel plugin names below the channel name. Plugins can be assigned to every pattern channel from the [[Manual: General|General Tab]] or by right-clicking this plugin name.
* '''Channel Manager''': Toggles display of the [[Manual: Channel Manager|Channel Manager window]].
* '''Zxx Macros''': Opens then [[Manual: Macro Configuration|Macro Configuration dialog]].
* '''Chord Editor''': Opens the [[Manual: Chord Editor|Chord Editor dialog]].
* '''Undo''': Undoes the last modification to the pattern(s). Changes to the Order List are not covered by this action.
* '''Pattern Proprerties''': Opens the [[Manual: Pattern Properties|Pattern Properties dialog]], if supported by the current module format.
* '''Expand Pattern''': Doubles the length of the current pattern by adding an additional empty row after every row.
* '''Shrink Pattern''': Halves the length of the current pattern by removing every other row.
* '''Low Pattern Detail''': Only the note and instrument column are displayed in the pattern editor.
* '''Medium Pattern Detail''': Only the note, instrument and volume column are displayed in the pattern editor.
* '''High Pattern Detail''': All channel columns are displayed in the pattern editor.
* '''Toggle Overflow Paste''': When enabled, pasting will continue to the next pattern if the data overflows the current pattern.

Next to the toolbar is the '''sequence selector''' which is used to switch to another sequence or change the name of the current sequence.

== Edit Controls ==

[[Image:Pattern Edit Controls.png]]

* '''Main Instrument''': Shows the instrument (or sample) that is used to input notes. If [[Manual: Keyboard Split|Keyboard Split]] is used, the main instrument is used to play the upper part of the keyboard.
* '''Plugin''': If the main instrument is associated with a plugin, the plugin’s editor can be opened from here. <kbd>Shift</kbd>-clicking the button closes all other open plugin editors.
* '''Edit Step''': The amount of rows that is skipped after entering a note into the pattern. If Row Spacing is set to 0, the cursor stays in the same row, if it is set to 1, it advances to the next row, etc.
* '''Loop Pattern''': If checked, pattern playback will restart from the top of the pattern if the end of the pattern is reached.
* '''Follow Song''': If checked, the cursor position moves with the currently played row as the pattern plays.
* '''Pattern Name''': Here you can change the name of the current pattern.

== Order List ==

[[Image:Order List.png]]

The Order List is a playlist containing the pattern references of the current sequence. It determines in which order the patterns are played. There are several types of Order List entries:

* '''Pattern reference''': Represented by '''numbers'''. A pattern can be played several times if its reference number is used in multiple order list slots.
* '''Separator pattern''': Represented by '''+++'''. Separator patterns are simply skipped, i.e. they have no content. They can be used to keep your Order List tidy and structured. You could, for example, add a separator pattern after each group of four patterns, or after each transition from verses to the chorus, etc...
* '''Stop pattern''': Represented by '''---'''. If a stop pattern is encountered, playback is continued at the [[Manual: General#Restart / Loop|Restart Position]] if [[Manual: General#Restart / Loop|Loop Song]] is enabled or stopped otherwise.

Even if the edited module format does not support more than one sequence, it is possible to put several “songs” into the same Order List by separating them through stop patterns (and / or by putting a position jump effect at the end of the last pattern of each “song”). This technique is commonly used in game music, where the same set of instruments and samples is used for several related songs.

The pattern play order can be modified by ''position jump'' [[Manual: Effect Reference|effect commands]].

=== Usage ===

* '''Currently edited patterns''' (shown in the pattern editor below the Order List) are marked with a '''dashed border'''.
* '''Currently played patterns''' have a line above the pattern reference number.
* '''Queued patterns''' are underlined. A pattern can be queued and de-queued by middle-clicking or <kbd>Ctrl</kbd>-clicking its pattern reference. Queued patterns are played as soon as the currently played pattern has finished playing, i.e. when the play cursor has reached the last line of that pattern or when a position jump / pattern break command is encountered in that pattern.
* '''Locked patterns''' are shown with a grey background. Patterns can be locked from the context menu.
* '''Non-existent Patterns''' are greyed out. That is, if there is a pattern 8 in the order list, but the module only has 4 patterns, pattern 8 would be greyed out.
* '''Order selections''' can be made by clicking on the first order and Select-clicking (by default, the selection key is <kbd>Shift</kbd>) on the last order that should be selected. If only one order should be selected, the second step can of course be omitted. It is also possible to create order selections using the keyboard by holding down the selection key (<kbd>Shift</kbd>) and using the cursor / home / end keys.
* Orders can be '''moved''' and '''copied''' by dragging the order selection around using the mouse. By default, the order selection is moved, but it can also be copied to the new selection if the selection key is held down when dropping the order selection (releasing the mouse button).
* Order items can be entered using the '''keyboard'''. To add or edit a pattern reference, simply enter the number of the pattern in one of the Order List slots. Separator patterns can be added by pressing <kbd>S</kbd> and stop patterns by pressing <kbd>Space</kbd>.
* Patterns can be dragged from the current module’s song folder in the [[Manual: Tree View#Song Folders|Tree View]] to the order list. The pattern reference is then inserted at the drop position.

=== Order List Context Menu ===

Right-clicking the Order List offers these options:

* '''Insert Pattern''': Inserts the selected pattern reference numbers after the current selection.
* '''Insert Separator''': Inserts a separator pattern (+++) at the selection position, if it is available in the current module format.
* '''Remove Pattern''': Removes the selected patterns from the Order List. Note that the actual patterns are ''not'' deleted; only the references to those patterns are removed.
* '''Create New Pattern''': Places a new blank pattern in the Order List where you clicked. The new pattern will have the same number of rows as the selected pattern.
* '''Duplicate Pattern''': Copies the contents of the selected patterns into new patterns, and inserts the numbers of those new patterns after the selected patterns.
* '''Copy Pattern(s)''': Copies the pattern data of all selected patterns into the clipboard. If there is more than one selected pattern, the order list selection is also copied.
* '''Copy Orders''': Copies the selected order items, i.e. only the pattern ''numbers'', '''not''' the pattern ''contents'', for example for reusing them in another sequence.
* '''Cut Patterns''': Copies the selected Orders and their pattern data into the clipboard and removes the selection from the Order List. This option appears only if multiple orders are selected.
* '''Paste Pattern(s)''': Places the pattern data in the clipboard into the selected pattern, replacing any data in the pattern. If there is more than one pattern in the clipboard, the current pattern is not modified, but new patterns are inserted.
* '''Merge Patterns''': Creates a new pattern containing a combination of the selected patterns, and replaces the Orders of the selected patterns with one referring to the new pattern. The new, merged pattern is equivalent to the selection's first pattern with every other selected pattern appended (increasing the row length accordingly).
* '''Pattern Properties''': Opens the [[Manual: Pattern Properties|Pattern Properties dialog]], if supported by the current module format.
* '''Restart Position''': Sets the restart position of this sequence to the selected pattern.
* '''Sequences''': This sub menu is only available in MPTM files, and you can choose from the following items:
** '''Sequence List:''' The first items are a list of all the Sequences in the module. Selecting one switches to that Sequence.
** '''Duplicate Current Sequence:''' Creates a new Sequence at the end of the Sequence List, and copies the Orders of the current Sequence into it.
** '''Create Empty Sequence:''' Creates a new Sequence at the end of the Sequence List without any Orders.
** '''Delete Current Sequence:''' Deletes the current Sequence, but not any Patterns that it may contain. There is no Undo for this action, so you are prompted for confirmation after selecting this option.
* '''Lock Playback to Selection:''' Song playback is locked to the patterns in the current order selection. Locked playback positions are greyed out. If “Follow Song” is enabled, manually selecting a different pattern for playback will remove the lock.
* '''Unlock Playback:''' If playback has been limited to an order selection before, the playback lock can be removed here.
* '''Render to Wave''': Opens the [[Manual: Saving and exporting#Stream Export|Wave Export dialog]] for the selected patterns.

== Pattern Editor ==

=== Overview ===

[[Image:Pattern Layout.png|right]]

Every pattern consist of a number of rows and channels. Channels are divided into several columns: Note Column, Instrument Column, Volume Column, Effect Column. By default, the currently edited cell of the pattern is highlighted in black, and the respective row is highlighted in dark grey. If follow song is disabled and you have a song playing, the currently played row is highlighted in bright yellow. By default, the song’s time signature is indicated by light grey row highlights; the first row of each beat and measure is displayed in a darker colour.

At the top of the editor, you see the '''channel headers''', which display the channel name and, optionally, note volume. Several edit options are [[Manual: Patterns#Channel Header Context Menu|available]]. Click the pattern number in the upper-left corner (reading ''#0'' or similar) to open the [[Manual: Pattern Properties|Pattern Properties dialog]] if supported by the current module format.

==== Note Column ====

The '''Note Column''' is used to trigger notes and to stop them in one way or another. Note events consist of a key and an octave, for example "C-5" (which is the Middle-C). By default, the "QWERTY" keyboard row triggers the fourth octave, the "ASDF" row triggers the fifth octave and the "ZXCV" row triggers the sixth octave. There are also more “traditional” keymaps in Fasttracker 2 and Impulse Tracker style available from the [[Manual: Setup/Keyboard|Keyboard Settings Dialog]] if you want to try a different layout. You can use the numeric keys to access other octaves or use <kbd>Ctrl</kbd>+(<kbd>Shift</kbd>)+<kbd>A</kbd>/<kbd>Q</kbd> to transpose a note up or down by a tone or a full octave. The available note range depends on the format used. By default, every octave consists of twelve notes: C C♯ D D♯ E F F♯ G G♯ A A♯ and B when using sharps, or C D♭ D E♭ E F G♭ G A♭ A and B when enabling [[Manual: Setup/Display#Accidentals|flat accidentals]]. By using [[Manual: Tunings|custom tunings]] it is possible to have different note names and different amount of notes per octave.

Depending on the song format, several ways are available to stop a playing note from the note column. These actions affect sample playback, instrument envelope playback and VSTi playback in various ways described in the following table.

{| class="wikitable"
|-
! Action !! [[Manual: Samples|Sample]] Properties !! [[Manual: Instruments|Instrument]] Properties !! VSTi Properties
|-
| <tt>^^</tt> ('''Note Cut''') || Instantly cuts playing sample || Instantly stops instrument’s envelopes || Stops all notes of the playing VSTi, send MIDI All Notes Off (CC#123) / All Sounds Off (CC#120) (use with care, this can congest some plugins’ MIDI buffer!)
|-
| <tt>==</tt> ('''Note Off, IT / MPTM''') || Releases the sample’s sustain loop, continues in normal loop if enabled || Releases the instrument envelopes’ sustain loops, continues in normal loops if enabled || Sends MIDI Note Off
|-
| <tt>==</tt> ('''Note Off, XM''') || Instantly cuts playing sample iff associated instrument has no volume envelope || Releases all envelopes’ sustains points and fades the sample out || Sends MIDI Note Off
|-
| <tt>~~</tt> ('''Note Fade''') || — || Fades out sample || Sends MIDI Note Off
|}

Instrument properties are only applied if the song has any instruments. This means that for example <tt>~~</tt> does nothing in sample mode, because Fade-Out is an instrument property.

As the MOD format supports none of the actions described in the table, the only ways to cut a playing sample in this format is to use a volume effect (<tt>C00</tt>) or note cut effect (<tt>EC0</tt>). Trying to enter any of the note-off commands automatically converts them to a <tt>C00</tt> effect.

==== Instrument Column ====

A note alone will of course not produce any sound, so in order to tell the program which instrument or sample should be played with the note, the instrument’s (if there are instruments) or sample’s (if there are only samples) index must be entered next to a note. For example, <tt>C-5 01</tt> will play the Middle-C of the first sample or instrument. If there is no instrument number next to a note, the previously used sample or instrument is recalled using the previous volume and panning settings. Lone instrument numbers (without a note) will reset the instrument’s or sample’s properties like volume (this is often used together with the volume slide effect to create a gated sound). In the IT / MPTM format and the MOD format (if the “On-the-fly sample swapping” [[Manual:_Compatible_Playback#MOD_compatibility_settings|compatibility option]] is enabled), you can switch to a different instrument this way without having to enter the same note again. This is often used in chiptunes to create pulse width modulation effects.

==== Volume Column ====

This column is generally used to enter volume changes, but it can also be used for a couple of other effects in some formats. Not all formats support this column. Most notably, you cannot enter anything here in the MOD format. The [[Manual: Effect Reference|Effect Reference]] lists all supported commands for each format.

==== Effect Column ====

This is the most versatile column and can be used to enter a variety of commands that either affect the current note (such as pitch or volume changes), all notes on the channel (e.g. channel volume) or all channels (like tempo or global volume changes). This column is supported by all formats, but the number of supported commands varies between module formats. The [[Manual: Effect Reference|Effect Reference]] lists all supported commands for each format.

=== Editing ===

Navigation in the pattern happens by using the mouse or the appropriate cursor keys. Combinations of <kbd>Ctrl</kbd>, <kbd>Alt</kbd> and Cursor / <kbd>Home</kbd> / <kbd>End</kbd> keys can be used to navigate by beats and measures in the default key configurations.

By default, you can use <kbd>Shift</kbd> to draw pattern selections. Selections can be moved, copied, amplified, transposed, interpolated, doubled or halved in size. Most editing actions are available either from the context menu or through shortcuts.

Double-clicking a pattern cell or hitting the <kbd>▤ Application</kbd> key brings up the [[Manual: Note Properties|Note Properties dialog]], which shows you all possible commands and parameters that can be entered into the pattern cell.

=== Paste Modes ===

The default paste mode overwrites the paste area completely, so if the copied pattern data contains empty cells, they will overwrite any existing pattern data. However, there are several other ways to paste data, available from the '''Paste Special''' context menu:

[[Image:Mix Paste.png|right]]

* '''Mix Paste''': Transfers a copy of the clipboard contents where the cursor is located, overwriting any fields within the bounds of the pasted data '''only if''' there is no data in the correlating fields. The difference between '''Mix Paste''' and '''Mix Paste (IT Style)''' is that the former overwrites effect parameters if they are 00, while the latter leaves effect commands untouched, even if they have a 00 parameter. Also, the first three columns (note, instrument and volume) are seen as one entity when using IT Style, so if any of the three contains some data in the source channel, none of the two other columns are ever overwritten. Have a look at the graphic on the right for a better understanding of the two Mix Paste modes: The first channel is the target channel in which we will be mix-pasting the clipboard data (second channel). In the third channel, you can see the result of a '''Mix Paste''' action, and in the fourth channel, we have used '''Mix Paste (IT Style)''' instead. See rows 4, 8, 13 and 14 for the differences.
* '''Paste Flood''': The same as standard paste, except that the pasted data is continually pasted until the end of the pattern is reached (ignoring Overflow mode).
* '''Push-Forward Paste''': '''Inserts''' the data into the pattern rather than overwriting it, pushing all data it affects farther down the pattern. Any data at the end of the affected channels is lost.

When pasting more than one pattern, new patterns are created for the pasted content by default. If you would like to paste into existing patterns instead, execute a '''Mix Paste'''. To continue the paste operation past the end of the current pattern, '''Overflow Paste''' must be enabled.

=== Quick Cursor Copy and Paste ===

In the Pattern Editor, OpenMPT also makes use of its “Quick” clipboard, which can hold a copy of a single pattern event. For example,
{| class="wikitable"
|-
| C-5 || 01 || v32 || A04
|}
shows the four columns of a pattern event that are stored in the Quick clipboard.
You can quick-copy every column by placing the cursor appropriately and using the Quick Copy keyboard shortcut (by default, this is <kbd>Enter</kbd>).
To re-use the data, place the cursor in any of an event’s four columns and use the shortcut key for Quick Paste (<kbd>Space</kbd>); the data in the Quick clipboard will be pasted in that field only (except if the cursor is in the note column, in which case the note and '''also''' its instrument will be pasted). You can only copy and paste in one field at a time.

Note that using Quick Copy on the instrument column also has a special secondary meaning: It will set the copied instrument as the current main instrument.

=== Channel Header Context Menu ===

* '''Mute Channel''': Disables all audio output from this channel. In the S3M format, this also prevents any global effects (e.g. tempo changes) from this channel to be executed. The mute status of a channel can also be toggled by clicking on the '''channel name''' area.
* '''Solo Channel''': Mutes all channels except this one. The solo status of a channel can also be toggled by holding the <kbd>Alt</kbd> key and clicking on the '''channel name''' area.
* '''Unmute All''': Enables audio output from all channels.
* '''Transition Actions''': Will apply one of these actions the next time the playback position reaches another order item. The actions are Mute (disable audio from the selected channel), Unmute All (enable audio from every channel), or Solo (disable audio from all except the selected channel).
* '''Reset Channel''': Stops the processing of all notes in this channel, as well as reverts to the initial channel settings, such as those for pan position, volume, etc.
* '''Record Select''': Toggles this channel for the first pattern record group. The record status of a channel can also be toggled by holding the '''<kbd>Shift</kbd>''' key and clicking on the '''channel name''' area.
* '''Split Record Select''': Toggles this channel for the second pattern record group.
* '''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 selected channel to this new channel.
* '''Add Channel''': Adds an empty channel before or after the selected channel.
* '''Remove Channel''': Removes the selected channel or opens a dialog from which you can select the channels to remove.

Middle-clicking or <kbd>Ctrl</kbd>-right-clicking a channel header brings up the [[Manual: Quick Channel Settings|Quick Channel Settings dialog]], which can be used to adjust the channel’s initial volume and panning properties as well as updating its name. Channels can be moved around by dragging their channel header. Holding <kbd>Shift</kbd> after starting the dragging will duplicate the channel at the drop position.

=== Pattern Context Menu ===

Many of the menu items in this context menu may not be available / visible based on what the selection contains. To show all menu items, even if they do not apply, check the “Old-style Pattern Context Menu” option in the [[Manual: Setup/General|General]] page of the [[Manual: Setup|Setup dialog]]; the unavailable items will be greyed out.

* '''Select Channel''': Select all data within the selected channel.
* '''Select Pattern''': Select all data within the current pattern.
* '''Cut''': Executes a Copy action on the selected region, then erases all data from it.
* '''Copy''': Copies the pattern selection to the clipboard. OpenMPT uses the operating system’s regular text clipboard for pattern data, so you can easily paste pattern contents into a different application (e.g. a website).
* '''Paste''': Transfers a copy of the clipboard contents where the cursor is located, overwriting any data within the bounds of the pasted data. This will begin in the same event as the cursor location, even if the cursor is not in the first column of the event.
* '''Paste Special''': Various other paste modes are available from this sub menu. They are described [[#Paste Modes|above]].
* '''Undo''': Repeals the last action taken. Navigation cannot be un-done.
* '''Clear Selection''': Erases all data in the selected region.
* '''Interpolate Effect''': Interpolates the effect data between the first and last row in the effect column of the selection if they contain the same effect, filling in any blank fields in the affected cells. If there is no effect on either the first or last row, the effect value on the last or first row respectively is repeated throughout the whole selection.
* '''Interpolate Volume Column''': Interpolates the effect data between the first and last row in the volume column of the selection in the same fashion as “Interpolate Effect”.
* '''Interpolate Instrument''': Interpolates between the instrument numbers in the first and last row of the selection in the same fashion as “Interpolate Effect”.
* '''Interpolate Note''': Interpolates between the notes in the first and last row in the volume column of the selection in the same fashion as “Interpolate Effect”, with the difference that existing notes are overwritten.
* '''Transpose''': Changes the pitch of all notes within the selection up or down by one octave, one semitone, or a custom amount.
* '''Change Instrument''': Assigns a chosen instrument to '''all''' notes within the selection. “Current Instrument” uses the instrument shown in the Main Instrument field), “Current Instrument (only overwrite existing)” applies the main instrument only to instrument cells where an instrument number has already been placed. This menu item will appear only if the right-click is on a note event.
* '''Amplify''': Opens the [[Manual: Amplify|Amplify dialog]], which can be used to amplify and fade the current cell or a whole selection by inserting the appropriate volume commands.
* '''Visualize Effect''': Opens the [[Manual: Parameter Editor|Parameter Editor window]] for visualizing either the effect column data or the Parameter Control Event data in the current selection (so will not work if no selection has been made).
* '''Change Plugin:''' From this menu, you can select the plugin for a [[Manual: Parameter Control Events|Parameter Control Event]] to control. This menu item is only available if the cursor is placed on a Parameter Control Event.
* '''Change Plugin Parameter:''' From this menu, you can select a plugin parameter that should be automated. This menu item is also only available if the cursor is placed on a Parameter Control Event.
* '''Toggle Plugin Editor:''' Opens the [[Manual: Plugin Window|Plugin Window]] of the plugin that is associated to the selected Parameter Control Event or instrument.
* '''Grow Selection''': Extends the selection by inserting a blank row after every row in the selection, so the length of the selection is doubled. This will overwrite any rows in those channels below the selection.
* '''Shrink Selection''': Shrinks the selection by merging row pairs into a single row in the selection, effectively halving the length of the selection.
* '''Show Row Play Time''': Displays an estimate of the time from the song start to the selected row.
* '''Split Pattern at Row <tt>x</tt>''': Splits the current pattern in two halves, the first containing every row leading up to row '''<tt>x</tt>''', and the second containing row '''<tt>x</tt>''' and all subsequent rows. The first half of the split replaces the current pattern (overwriting the contents), while the second half is placed into a new pattern and added directly after the current Order in the Order List (if the pattern being split is in the Order List).
* '''Lock Playback to Selection''': Restricts pattern playback to the rows of the current selection.
* '''Reset Playback Lock''': If no selection was made, this option is available to reset playback locks created by the previous menu item.
* '''Insert Row''': Offers several ways of inserting one or more rows:
** '''Insert Row (Selection)''': 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 (All Channels)''': 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 (Selection, Global)''': 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 (All Channels, Global)''': 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.
* '''Delete Row''': Offers several ways of deleting one or more rows:
** '''Delete Row (Selection)''': 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 (All Channels)''': 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 (Selection, Global)''': Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; this also affects all following patterns as no empty rows are inserted.
** '''Delete Row (All Channels, Global)''': Deletes the same amount of rows as the selection, on all channels; this also affects all following patterns as no empty rows are inserted.
* '''Quantize Settings''': Opens a dialog to set up live record quantization. If this value is zero, no quantization is applied; any other value shifts recorded notes up or down to the closest row that is a multiple of the quantize value. This applies to both live recording through MIDI as well as when using the computer keyboard. If quantization is applied, [[Manual: Setup/General#Automatic delay commands|automatic delay commands]] are not inserted. Quantize settings are remembered when OpenMPT is closed.

[[Category:Manual|Pattern Tab]]
[[Category:Tabs|Pattern Tab]]
[[de:Handbuch: Patterns]]

Manual: Samples

2021-12-07T01:49:38Z

Twomoso: /* Sample Display */ "sample sample display" to "sample display"

[[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, 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.

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, OpenMPT is in Pitch Shifting mode.

=== Pitch Shifting ===

Pitch shifting is done using [http://en.wikipedia.org/wiki/Short-time_Fourier_transform Short-time Fourier Transform] (STFT). Three parameters are available for configuration:

* '''Pitch''': The amount of semitones the sample should be shifted upwards or downwards.
* '''Quality''': The oversampling factor which also determines the overlap between adjacent STFT windows. Higher values usually provide better results, at the cost of more processing time.
* '''FFT Size''': The size of one FFT frame used for processing. Depending on the frequency content of the sample, higher or lower values may sound better.

=== Time Stretching ===

By clicking the '''Time Stretching''' checkbox, the Time Stretching mode is enabled. The following parameters are available:

* '''Parameters''': A string which contains a SoundTouch configuration. The numbers are, from left to right:
** '''Default sequence length''': This is the default length of a single processing sequence in milliseconds which determines how the original sound is chopped in the time-stretch algorithm. Larger values mean fewer sequences are used in processing. In principle a larger value sounds better when slowing down the tempo, but worse when increasing the tempo and vice versa. A value of 0 (default) lets the algorithm choose this parameter automatically.
** '''Default seeking window length''': The seeking window default length in milliseconds is for the algorithm that seeks the best possible overlapping location. This determines from how wide a sample "window" the algorithm can use to find an optimal mixing location when the sound sequences are to be linked back together. The bigger this window setting is, the higher the possibility to find a better mixing position becomes, but at the same time large values may cause a "drifting" sound artifact because neighboring sequences can be chosen at more uneven intervals. If there's a disturbing artifact that sounds as if a constant frequency was drifting around, try reducing this setting. A value of 0 (default) lets the algorithm choose this parameter automatically.
** '''Overlap length''': Overlap length in milliseconds. When the sound sequences are mixed back together to form again a continuous sound stream, this parameter defines how much the ends of the consecutive sequences will overlap with each other.
* '''Ratio''': Defines how much the sample is stretched, ranging from 50% (double speed) to 200% (half speed).
* '''Time Stretch Calculator''': By clicking the button next to the stretch ratio, the [[Manual: Time Stretch Calculator|Time Stretch Calculator dialog]] is opened, where you can calculate the correct time stretch ratio for a given tempo and pattern setup.

== 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. Right-click the timeline to change the unit used for display. Right-clicking a cue point allows you to delete that cue point.

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.
* '''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.
* '''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.
* '''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 selection) to the clipboard. You can then paste this sample data into another sample slot; some third-party applications (including many popular 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''': 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

2021-12-07T01:46:33Z

Twomoso: /* General Context */ "differnt" to "different"

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

== Global Keys ==

Global keyboard shortcuts work on most parts of OpenMPT as long as one of the program’s windows is focussed. '''Note''': Some keyboard shortcuts are ignored when the input focus is within a text field.

{| 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/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/Compatibility Export || || Exports the current track without any [[Manual: Saving and exporting#Compatibility Export|file format hacks]] to its original format.
|-
| 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).
|-
| 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]].
|-
| Play Song / Pause Song || <kbd>F5</kbd> || Toggles the playback of the current track. The playback pointer is not reset when using this toggle; that is, it plays from where the pointer left off when it was last pressed.
|-
| 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 || <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 || || 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 and VST 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> || 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 Main toolbar.
|-
| Toggle Tree View || <kbd>Ctrl</kbd>+<kbd>F2</kbd> || Shows / hides [[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]].
|-
| 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.
|-
| Previous Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad/</kbd>, <kbd>Ctrl</kbd>+<kbd>Up</kbd> || Changes the current instrument to the previous one in order.
|-
| Next Instrument || <kbd>Ctrl</kbd>+<kbd>Numpad*</kbd>, <kbd>Ctrl</kbd>+<kbd>Down</kbd> || Changes the current instrument to the next one in order.
|-
| 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.
|-
| Dummy Shortcut || || OpenMPT automatically assigns the default shortcuts found in this table, if they are not used yet by a user-defined shortcut and if no other custom shortcut has been chosen for the command. For example, as long as you did not assign <kbd>F5</kbd> to do something else, it will always start and pause playback if you did not choose a replacement key for that command. If you would like some default shortcuts to not be assigned automatically, you can assign them to this dummy shortcut instead.
|-
|}

== 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.
|-
| 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.
|-
|}

=== 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>Shift</kbd>+<kbd>Left</kbd>, <kbd>Shift</kbd>+<kbd>Backspace</kbd> || Shows the channel settings for the previous channel.
|-
| Next Channel || <kbd>Shift</kbd>+<kbd>Right</kbd>, <kbd>Shift</kbd>+<kbd>Enter</kbd> || Shows the channel settings for the next 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).
|-
| 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.
|-
| 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.
|-
| 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.
|-
| 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 channel 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, this shortcut behaves 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).
|-
| 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.
|-
| Open Effect Visualizer || <kbd>Alt</kbd>+<kbd>B</kbd> || Opens the Params Editor dialog.
|-
| 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.
|-
| 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.
|-
| 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.
|-
| 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.
|-
| Jump to Previous Entry in Column || || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column above the current cursor position.
|-
| Jump to Next Entry in Column || || Moves the cursor to the next non-empty cell (note, instrument, etc.) of the currently selected column below the current cursor position.
|-
| Enable Recording || <kbd>Ctrl</kbd>+<kbd>Space</kbd> || Toggles the Event Record feature. When enabled, patterns may be edited.
|-
| Play Row || <kbd>Ctrl</kbd>+<kbd>Enter</kbd> || Process and play only the events in the current row where the cursor is located.
|-
| 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.
|-
| 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.
|-
| 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.
|-
| Show Chord Editor || || opens the [[Manual: Chord Editor|Chord Editor]] dialog.
|-
| Split Keyboard Settings Dialog || <kbd>Ctrl</kbd>+<kbd>E</kbd> || Opens the [[Manual: Keyboard Split|Keyboard Split]] dialog.
|-
| Toggle Loop Pattern || <kbd>Shift</kbd>+<kbd>F11</kbd> || Toggles the Loop Pattern feature.
|-
| 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 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).
|}

=== 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> || Enters a note in the octave indicated in the Octave field.
|-
| Base Octave +1 [note] || <kbd>A</kbd> || Enters a note in the next higher octave indicated in the Octave field.
|-
| Base Octave +2 [note] || <kbd>Z</kbd> || Enters a note two 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 Off || <kbd>=</kbd> || Enters a Note Off command (==).
|-
| Note Fade || <kbd>Shift</kbd>+<kbd>=</kbd> || Enters a Note Fade command (~~).
|-
| Parameter Control || <kbd>Shift</kbd>+<kbd>-</kbd> || Enters an absolute [[Manual:_Parameter_Control_Events|Parameter Control event]] (PC).
|-
| Parameter Control (Smooth) || <kbd>-</kbd> || Enters a smooth sliding Parameter Control event (PCs).
|-
|}

=== 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.
|-
| 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.
|-
|}

=== 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 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 next 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 or .xi 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.
|-
| Preview 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.
|-
| 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 select 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.
|}

[[Category:Manual|Keyboard Actions]]

Manual: Module formats

2021-12-07T01:42:38Z

Twomoso: /* File formats that can only be read by OpenMPT */ Add missing parenthesis

== File formats that can be read and written by OpenMPT ==

=== The ProTracker MOD format (.mod) ===

The MOD format was the first file format for tracked music on the Commodore Amiga. A very basic version of this format (with only very few pattern commands and short samples supported) was introduced by Karsten Obarski’s Ultimate SoundTracker.
It was designed to use 4 channels each with one voice. Ultimate SoundTracker was soon superseded by NoiseTracker and ProTracker, which allowed for more tracker commands (effects), longer samples, more patterns and other improvements. Later, variants of the MOD format that appeared on the Personal Computer extended the number of channels, added panning commands (the Amiga’s four hardware channels had a pre-defined stereo setup) and expanded the Amiga’s frequency limit, allowing for more octaves of notes to be supported.

Arguably one of the most widespread tracker formats (also due to its use in many computer games and demos), it is also one of the simplest to use, but also only provides few pattern commands to use.
With OpenMPT, you can use up to 99 tracks (the default is 4, and not all applications support that many channels - few support more than 32). Instruments cannot be used in the MOD format, only 8-bit samples with a maximum size of 128 KB per sample and with a limited set of parameters.
Initial tempo, number of rows (always 64), and the “time signature” cannot be defined (always uses the highlight values provided in the [[Manual:_Setup/Display|Display setup]]).
There is limited sample control and few global settings.

=== The ScreamTracker 3 format (.s3m) ===

Scream Tracker 3′s S3M format added sample tuning (defining the exact frequency of the middle C for samples), increased the number of playback channels, made use of an extra column specifically for volume control (which was extended by other trackers to handle panning commands as well), and compressed pattern data for smaller file sizes.
Other improvements include the ability to set the initial tempo and speed (ticks per row), initial global and sample volume as well as initial channel panning. Compared to MOD, there is also a different, expanded set of effect commands.

A unique feature of the S3M format is the ability to make use of samples and synthesized FM instruments (via the Yamaha OPL2 chip) at the same time. OpenMPT can fully emulate this chip in software.

=== The FastTracker 2 format (.xm) ===

With the XM format, Fasttracker 2 introduced the concept of “instruments”, which applied volume and panning envelopes to samples. It also added the ability to map several samples to the same instrument for multi-sampled instruments or drum sets. XM uses instrument-based panning – instrument numbers in patterns always reset the channel’s panning to the current sample’s initial panning.
It uses MOD effect command letters, plus a few of its own for more sound control.
You can define initial tempos and speeds; provide envelopes to samples by assigning them to instruments; set sample looping and apply automatic sample vibrato oscillation; and with OpenMPT, apply VST plugins to instruments, channels, or the whole track to spice up your old XM compositions.

=== The Impulse Tracker format (.it) ===

Impulse Tracker introduced the IT format, which, in comparison to the XM format, allows instruments to also specify the transposition of assigned samples depending on the note being played, applying resonant filters to samples, and defining “New Note Actions” (NNAs) for instruments to release playing notes on a pattern channel while a new note is already playing, which helps to keep the number of pattern channels at a manageable amount while still being able to have a high polyphony. Like S3M files (and contrary to XM files), panning is channel-based, meaning that channels have an initial pan position which can be overridden by panning commands or instruments’ and samples’ default panning settings.
Samples also have decent compression in file storage when saving IT files directly in Impulse Tracker or enabling OpenMPT's [[Manual: Hidden Settings#.5BMisc.5D|experimental IT compression settings]].
IT effect commands use a more advanced set of S3M commands.

=== The OpenMPT format (.mptm) ===

MPTM is OpenMPT’s own format. It is based on the IT format, with added capabilities of [[Manual:_Tuning_Properties|custom sample tunings]], [[Manual:_Parameter_Control_Events|Parameter Control events]], multiple [[Manual:_Patterns#Order_List|Pattern Sequences]], [[Manual: Tempo Swing Settings|tempo swing]], fractional tempos, global resampling settings and many more features. Some features such as VST plugins are currently usable in XM and IT as well but really should only be used in MPTM files. You can find these features by using the [[Manual:_Menus#View|Find Hacks]] functionality in the View menu.

Compared to IT, this format also adds back support for the OPL chip as found in the S3M format with several useful additions, such as being able to apply instrument envelopes to FM instruments or controlling the modulator intensity through sample filter cutoff.

=== The MIDI format (.mid) ===

MIDI files are of course not module files, and OpenMPT is by no means a MIDI editor. MIDI files store note data and timing information in a way that is not easily converted to a pattern-based tracker format.

OpenMPT can import many MIDI-sequenced songs in the MID / RMI format, but it is important to remember that sequencer files are not the same as modules and the data within these files does not translate well to a tracking format. MIDI import is thought of as a tool to import your old MIDI-based projects, remix stems and similar things more than as a way to listen to MIDI files in OpenMPT — there are far better MIDI players out there.

When importing MIDI files, experiment with the File Import settings in the [[Manual: Setup/MIDI|MIDI Setup]]. In particular, try different quantization values if not enough note detail can be imported, or lower the Ticks / Row to get rid of some unnecessary Note Delay and Note Cut effects at the expensive of a less accurate import.

OpenMPT supports the following General MIDI and XG features:
* '''MIDI CCs''': Bank Select, Pan Position, Expression, Channel Volume, Hold Pedal, CC 111 loop points, Mono / Poly Operation, All Controllers / Sounds / Notes Off
* '''RPNs''': Pitch Bend Range, Coarse Tune
* '''System Exclusive''': Master Volume, Master Transpose, GS Drum Kit. XG System On enables drums on bank 127 on any channel.

OpenMPT reads embedded soundfonts in RMI files, and automatically loads patches from soundfonts that carry the same name as the MIDI file, as long as they are placed in the same directory.

=== Choosing a module format ===

Each format supported by OpenMPT has its own strengths and use cases, so sometimes it might not be obvious with format to pick.

If you do not intend to spread your module files, or if compatibility with other software is not a requirement, using OpenMPT’s MPTM format is the most logical choice, as it is the most advanced among the supported formats, and new features are added to the format every now and then.

If you would like to be able to spread your modules and play your music in a wide variety of legacy module players and trackers, the IT format offers the most features and is supported by a lot of software.

Using the MOD, XM and S3M formats is only recommended if you intend to target a platform or software that only supports those formats. For instance, if you want to be able to play your modules on an Amiga computer, a 4-channel ProTracker MOD file would be the most logical choice.

{{NewVersion|3991}}
== File formats that can only be read by OpenMPT ==

The following formats can be imported into OpenMPT. Internally, they are converted to one of the file formats described above.
Depending on the source format, conversion might not always be accurate.

* Composer 669 / UNIS 669 (.669)
* ASYLUM Music Format / Advanced Music Format (.amf)
* Extreme’s Tracker / Velvet Studio (.ams)
* Composer 670 / CDFM (.c67)
* Digi Booster Pro (.dbm)
* Digi Booster (.digi)
* X-Tracker (.dmf)
* DSIK (.dsm)
* Digital Symphony (.dsym)
* Digital Tracker / Digital Home Studio (.dtm)
* Farandole Composer (.far)
* Davey W. Taylor’s FM Tracker (.fmt9)
* General Digital Music (.gdm)
* Ice Tracker / SoundTracker 2.6 (.ice / .st26)
* Imago Orpheus (.imf)
* Impulse Tracker Project (.itp) – legacy OpenMPT format with instruments stored in external files rather than directly in the module
* Jazz Jackrabbit 2 Music (.j2b)
* SoundTracker and compatible (.m15 / .stk)
* DigiTrakker (.mdl)
* OctaMED (.med)
* MO3 (.mo3)
* MadTracker 2 (.mt2)
* MultiTracker (.mtm)
* Psycho Pinball / Micro Machines 2 music format (.mus)
* Oktalyzer (.okt)
* OggMod-compressed XM files (.oxm)
* Epic Megagames MASI (.psm)
* Disorder Tracker 2 (.plm)
* ProTracker 3.6 IFF (.pt36)
* PolyTracker (.ptm)
* SoundFX / MultiMedia Sound (.sfx / .sfx2 / .mms)
* Scream Tracker 2 (.stm)
* Scream Tracker Music Interface Kit (.stx)
* Soundtracker Pro II (.stp)
* Symphonie / Symphonie Pro (.symmmod)
* UltraTracker (.ult)
* Unreal Music (.umx) ''only from Unreal (Tournament 1), Deus Ex and Jazz Jackrabbit 3D''
* Mod's Grave (.wow)

=== Compressed modules ===
OpenMPT also handles several compression formats, so you do not need to extract modules from these formats to be able to listen to them: Modules in ZIP, RAR, LHA and GZ containers can be opened directly. Modules in ZIP or RAR archives make use of custom file extensions sometimes; Instead of ZIP or RAR, the file extension might be one of the following: MDZ, S3Z, XMZ, ITZ, MPTMZ, MDR. OpenMPT generally does not care about file extensions though, so it does not matter which extension you use for your compressed modules.

OpenMPT cannot save modules into compressed files, you will have to save your work as a normal module first and then compress it e.g. with Windows’ Zip capabilities or other third party compression utilities.

Some module-specific compression routines are also supported, for example MMCMP, XPK (with SQSH compression) and PowerPacker PP20.

Furthermore, OpenMPT can handle MO3 files. [https://www.un4seen.com/mo3.html MO3] is a highly compressed module format with lossy sample compression.
MO3 encapsulates the features of several module formats (IT, MOD, MPTM, MTM, S3M, XM), but with one big difference: MP3 and Ogg compressed samples.
It also has a lossless codec for any samples that do not like lossy encoding, and the whole file structure is compressed too.

[[Category:Manual|Module formats]]

Talk:Manual: Keyboard Actions

2020-10-06T05:21:39Z

Twomoso:

There's some inconsistencies between the keyboard action names in this page and in OpenMPT's UI. For example, in the global keys section:
{| class="wikitable"
|-
! Manual !! OpenMPT
|-
| File/Export '''to''' MIDI || File/Export '''as''' MIDI
|-
| Play Song / Pause '''S'''ong || Play Song / Pause '''s'''ong
|-
| Mix Paste (IT Style) || Mix Paste ('''old''' IT Style)
|-
| Previous '''i'''nstrument || Previous '''I'''nstrument
|-
| Next '''i'''nstrument || Next '''I'''nstrument
|}
I considered editing this page to match OpenMPT itself, but some of the names in OpenMPT seem to be erroneous (such as "Play Song / Pause song" above, or "Clear row" and "Delete Row(s)"). What's the best course of action? Opening an issue on the bug tracker (assuming there are indeed errors in OpenMPT), editing the manual to exactly match OpenMPT, or something else? 
-- [[User:Twomoso|Twomoso]] ([[User talk:Twomoso|talk]]) 04:11, 10 May 2020 (CEST)

: Generally we should be using Title Case (i.e. Play Song / Pause Song would be correct). I know it's not being used consistently in OpenMPT but that is being fixed whenever I stumble upon such a case (Play Song / Pause song has been corrected). Other differences in wording are incorrect and should be made consistent with OpenMPT. However, I dropped the "old" in the Mix Paste command as it is not consistent with the rest of the UI. [[User:Saga Musix|Saga Musix]] ([[User talk:Saga Musix|talk]]) 15:49, 10 May 2020 (CEST)

<hr />
: This page also lists the "move envelope point" left/right actions differently than OpenMPT; OpenMPT's order is left, right, left (coarse), right (coarse), while the manual is left, left (coarse), right, right (coarse). Up/down, however, are the same between OpenMPT and the manual (each direction immediately followed by coarse equivalent). I'm not sure which format is preferable, and since it's inconsistent even in OpenMPT alone, I've left the manual unedited.
: [[User:Twomoso|Twomoso]] ([[User talk:Twomoso|talk]]) 00:14, 11 May 2020 (CEST)

<hr />
I noticed some keyboard actions in OpenMPT are missing from the manual:

'''Pattern Editor - General'''
* Select Beat
* Select Measure

'''Sample Editor'''
* Slice at cue points

'''Instrument Editor'''
* Remove All Samples

They are actually quite old, it seems. According to [https://openmpt.org/release_notes/History.txt History.txt], "Select Beat" and "Select Measure" were added in 1.19.01.00, from 2011:

<code>- [New] <js> The new keyboard shortcuts "Select beat" and "Select measure" can be used to automatically extend the current selection to the beat / measure boundaries.</code>

Entries related to sample slicing at cue points and removing all sample map samples are respectively in the sections for 1.25.02.00 and 1.25.03.00 (both from 2015), but they don't explicitly mention keyboard shortcuts being added.

Is there any particular reason these aren't listed, or did they just happen to slip by? 
-- [[User:Twomoso|Twomoso]] ([[User talk:Twomoso|talk]]) 00:14, 11 May 2020 (CEST)

: They were just forgotten. [[User:Saga Musix|Saga Musix]] ([[User talk:Saga Musix|talk]]) 18:07, 11 May 2020 (CEST)

<hr />
Just a note: it looks like this page might be erroneously missing [[Template:NewVersion]]. [[Special:Diff/3984|The last revision]] added the keyboard actions for moving channels left and right (present in [https://source.openmpt.org/browse/openmpt/?op=revision&rev=13654 r13654 of OpenMPT]), but they don't appear to be in the latest OpenMPT release (1.29.04.00) and aren't mentioned in [https://openmpt.org/openmpt-1-29-04-00-released the website's "OpenMPT 1.29.04.00 released" article] or [https://openmpt.org/release_notes/History.txt History.txt]. 
-- [[User:Twomoso|Twomoso]] ([[User talk:Twomoso|talk]]) 07:21, 6 October 2020 (CEST)

Manual: Saving and exporting

2020-10-06T01:10:14Z

Twomoso: grammar fixes; /* Format */ "32 Bit" -> "32 bit"

OpenMPT can save and export songs in various ways. Exporting is different from saving in that it does not change the file in its current format, but instead saves the file in a different format. You can export to a number of different formats — as a lossless [[#Stream Export|streaming audio file]] (WAV, FLAC, AU and Raw), lossy audio streams (MP3 / Ogg Vorbis / Opus), a [[#MIDI Export|MIDI]] sequence file, or an “unhacked” version of the module format the track is in ([[#Compatibility Export|compatibility export]]).

== Saving tracks ==

Saving your track is done the same way as with most Windows applications; these functions are found under the “File” menu. 
Optionally, OpenMPT can back up your old song version automatically when overwriting a previously saved song by setting the “Create Backup File” checkbox in the [[Manual: Setup/General|Path / Auto Save Options]]. There, you can also set up OpenMPT to automatically save copies of your work in intervals.

Saving always happens in the same format the track is currently in. To convert a track to another format, open the [[Manual: Song Properties|Song Properties dialog]] and choose the new format. The file can then be saved in the new format using the above instructions.

== Stream Export ==

[[Image:Wave Convert.png|thumb|300px|Setting up lossless or lossy export for a module]]

This dialog allows exporting to a lossless or lossy streaming format.

=== Format ===

* '''Encoder''': Selects the encoder and format to be used (e.g. WAV, FLAC, Opus, Vorbis, MP3, etc.).
* '''Sample Rate''': Selects the sample rate used for exporting. Note that some encoders will only support a small set of sample rates. Also keep in mind that some plugins do not like their sample rate to be changed, so if you choose a different sample rate than the one from the [[Manual: Setup/Soundcard|Soundcard settings]], some plugins may produce strange output.
* '''Channels''': Selects the number of audio channels for export, depending on what is supported by the specified encoder.
* '''Dither''': Selects the [[Manual:_Setup/Soundcard#Dithering|dither algorithm]] used when rendering to a lower bit depth.
* '''Audio Format''': Selects the bit depth for lossless formats (e.g. 32 bit) or the bit rate of lossy formats (e.g. 256 kbit).

OpenMPT provides two MP3 encoding options. In addition to the default option, “Compatible MP3” will generate the most compatible form of MP3 files possible in order to ensure compatibility with very old players. Compatible MP3s have slightly reduced quality per bitrate compared to normal MP3s, can only contain ID3v1 tags instead of ID3v2 tags and do not support sample-exact lengths.

As the maximum length of a WAV file is limited (to 2 or 4 GB depending on the application that is used to handle the file), large uncompressed exports can be done in the AU format instead.

=== Render ===

* '''Player Options''': When exporting to audio, '''all''' of the player settings including the Equalizer will be applied. Click on this button to change the options or to disable these settings.
* '''Channel Mode''': If you check the Channel Mode box, each pattern channel is exported separately. Muted channels are not exported.
* '''Instrument Mode''': Similar to the Channel Mode option, this will export every instrument separately. Muted instruments are not exported. Note that Channel Mode and Instrument Mode are complementary, i.e. they cannot be used at the same time.
* '''Normalize Output''': Checking this box allows OpenMPT to boost or attenuate the overall audio volume so that the peak volume is at 0dB (the highest possible volume without distortion).
* '''Write cue points''': If supported by the format, OpenMPT can write cue points (markers) at every pattern transition, which can be used e.g. for synchronizing the audio to something else.

=== Plugin Quirks ===

These options are only available if there are any plugins being used in the exported module. They are there to circumvent bugs that can be found in some audio plugins.

* '''Slow Render''': Plugins that use Direct-from-Disk sample streaming (and also a couple of broken SynthMaker plugins) may not cope with OpenMPT’s export speed and thus output might not sound as intended. If you are using one of these plugins, enable this option and the export process will be slowed down automatically. Do not enable this option if it is not needed by the plugins you use, as all it really does just slows down the export process.
* '''Clear Plugin Buffers''': Despite being required by the VST standard, many plugins do not reset their internal audio buffers when playback is stopped or paused. In this case, if you attempt to export audio after stopping playback, any “leftover” audio (e.g. a reverb tail) will be output to the file at the beginning of the audio file. To remedy this, OpenMPT silently renders up to 20 seconds of silence before starting export.

=== Limit ===

* '''Limit Song Length''': Check this box to limit the export based on the file size in seconds. Fill in the number of seconds in the box. This option can be used e.g. for creating previews of your track.
* '''Play''': You have one of three options on how to output the track to its audio file — either a number of specified '''sequences''' (one file per sequence), the '''entire current sequence''' (repeated one or multiple times) or just a section of the song. If you want to save part of the song, click the '''From Position''' radio button, and fill in the start and end pattern positions (inclusive) to output.

=== Tags ===

Some audio formats support song metadata (“tags”). OpenMPT can export the most common tags such as Song Title, Artist Name, Genre and Year. Note that OpenMPT writes out ID3v2.4 tags for MP3 files, which are currently not recognized by various applications like Windows Explorer - more compliant audio players will have no problems with reading ID3v2.4 tags, though.

=== Render To Sample ===

Instead of rendering into a regular file, it is also possible to render the audio data into a sample slot. This can be achieved by selecting the appropriate radio button at the bottom-left of the dialog. By default, an empty sample slot is chosen, but a specific sample slot can be chosen from the sample list as well.

== MIDI Export ==

[[Image:MIDI Conversion Setup.png|thumb|300px|Setting up a module for MIDI conversion]]

With MIDI Export, you can save your track as an equivalent MIDI file. Every instrument is exported to a separate MIDI track.

You will first be prompted for the export location, then the MIDI Export dialog will be shown. Here you can go through each instrument you have set up and define which MIDI instrument will substitute for it.

When doing a MIDI conversion, it is important to keep in mind that the world of sample-based modules and MIDI are fundamentally different:
* There is no standardized way to change the volume of an already playing note, so things like volume slides will not be exported.
* MIDI has a limited pitch-bend range, which is set to 12 semitones for sample-based instruments. For plugin-based instruments, the already configured number of semitones is used instead.
* Pitch-bend events affect all notes on the same MIDI channel, even if they appear on different MIDI tracks. Thus, keep in mind:
** When exporting instruments to '''Melodic (Any)''', they will share some MIDI channels.
** When exporting an instrument to a specific MIDI channel, all notes will be affected by a pitch-bend event.
* Currently, tone portamento commands are treated as with instrument plugins, i.e. the previous note keeps playing and the note does not slide.
* MIDI files are exported at a resolution of 480 pulses per quarter note, which should be more than enough for most modules.

<div style="padding:6px; border:1px solid #a00; background:#ffa;">
OpenMPT’s MIDI export is not intended for perfect module-to-MIDI conversions. Think of it more as a tool for creating remix stems and similar purposes.
</div>

With this in mind, the export dialog works as follows:
* '''Instrument''': Shows the current instrument to apply the MIDI conversion to. Clicking on the field opens a popup menu listing all of the instruments in the track.
* '''MIDI Channel''': The MIDI channel to play the instrument on. There are 16 MIDI channels, to which all instruments have to be distributed. If you have more than 16 instruments, you need to decide which of them should share a MIDI channel. In General MIDI specifications, channel 10 is reserved for drums. This channel is used when picking '''Percussions''' from the list. '''Melodic (Any)''' will export the instrument to any of the remaining channels. Any of the other options map the instrument to a fixed melodic MIDI channel.
* '''MIDI Program''': The MIDI program (instrument) that the track instrument will be transferred to.
** Note that if '''No Program Change''' is selected, mixing this instrument with other instruments on the same MIDI channel that have a MIDI program set will make it use the other instrument’s MIDI program.
** On the percussion channel, this lets you choose a drum key instead. Choose '''Mapped''' to map pattern notes directly to the corresponding drum key instead (e.g. triggering a C-3 in the pattern with this instrument will trigger a bass drum). '''Note''': Drum keys below 35 (Acoustic Bass Drum) and above 81 (Open Triangle) are not entirely standardized. Depending on the application or device used to play the exported MIDI file, they may or may not turn out as the desired percussion.
* '''Allow instruments to overlap on same MIDI channel''': If enabled, instruments won′t be aware of other instruments on the same MIDI channel, i.e. there will be no MIDI program change messages and notes from more than one instrument may be playing at the same time. This mode is useful when there are more than 16 instruments playing concurrently and the result is imported into a <abbr title="Digital Audio Workstation">DAW</abbr> where each MIDI track can be routed to a different MIDI device or plugin.

== Compatibility Export ==

Past developers of ModPlug Tracker added various feature extensions (“hacks”) to some module formats in an effort to incorporate desired functionality. While they allow more flexibility for OpenMPT to edit and play these formats, they cause problems or are ignored in other tracking software, including many popular players.

Exporting to the track’s original format specifications is called Compatibility Export, and removes the OpenMPT hacks for that format. Depending on the used extension, this may alter the sound of the track in more or less subtle ways.
Compatibility Export only works with XM and IT files, as MOD and S3M files are never saved with hacked-on extra information.
Note that there are some features which are not directly supported in the original tracker (such as stereo samples in IT and S3M files), but they have been defined in the original file specifications and are supported by a number of other applications. Such features are retained in files saved with compatibility export.

Below is a list of OpenMPT’s file format extensions and their differences in Compatibility Export:

=== ModPlug Extensions for IT tracks ===

{| class="wikitable"
|-
! !! '''Default Save''' !! '''Compatibility Export'''
|-
| '''Channel Limit''' || Up to 127 channels || Up to 64 channels
|-
| '''Sample Limit''' || 256 Samples (Sample Mode) / 4000 Samples (Instrument Mode) || 99 Samples
|-
| '''Instrument Limit''' || 256 Instruments || 99 Instruments
|-
| '''Sample Amplification Range''' || 0 - 2000 || Limited to 0 - 128
|}

A number of song properties is not saved to compatible IT files as well. Default values that are assumed when re-opening the file are noted in parentheses.
* Artist Name
* Extended Filter Range
* Pattern and Channel Names
* Plugin List and Configuration
* VST instrument volume (48)
* Mix Levels (Compatible Mix Levels)
* [[Manual: Compatible Playback#IT compatibility settings|Compatibility Settings]] (default settings for this OpenMPT version)
* Tempo Mode (Classic Tempo Mode)

Some instrument settings are also omitted. Again, default values are noted in parentheses:
* Ramping (default)
* Resampling (default)
* Plugin settings (no plugin)
* Duplicate Note Check type “Plugin” (no duplicate note check)
* Cutoff variation (0), Resonance variation (0)
* Velocity handling (Use note volume)
* Volume handling (None)
* Force Filter Mode (Channel default)

Also, the following pattern commands are removed completely when saving a compatible IT file:
* Smooth MIDI Macro (\)
* Parameter Extension (#)
* Volume Column Offset (o)

=== ModPlug Extensions for XM tracks ===

{| class="wikitable"
|-
! !! '''Default Save''' !! '''Compatibility Export'''
|-
| '''Channel Limit''' || Up to 127 channels || Up to 32 channels
|-
| '''Sample Assignment''' || Up to 32 samples per instrument || Up to 16 samples per instrument
|-
| '''Stereo Samples''' || Saved as stereo || Converted to mono
|}

A number of song properties is not saved to compatible XM files as well. Default values that are assumed when re-opening the file are noted in parentheses.
* Artist Name
* Extended Filter Range
* Song Comments
* MIDI Configuration (Default MIDI configuration)
* Pattern and Channel Names
* Plugin List and Configuration
* Default VST instrument volume (48), Sample volume (48)
* Mix Levels (Compatible Mix Levels with FT2 Pan Law)
* [[Manual: Compatible Playback#XM compatibility settings|Compatibility Settings]] (default settings for this OpenMPT version)
* Rows Per Beat / Measure (default Rows Per Beat / Measure)

Some instrument settings are also omitted. Again, default values are noted in parentheses:
* Ramping (default)
* Resampling (default)
* Plugin settings (no plugin)

Also, the following pattern commands are removed completely when saving a compatible XM file:
* Command X extensions (X5x, X6x, X7x, X9x, XAx)
* Panbrello (Y)
* MIDI Macro (Z)
* Smooth MIDI Macro (\)
* Parameter Extension (#)
* In the volume column, slide commands with a 00 parameter (use last value) are removed, i.e. they have no slide memory.

== Sharing files and track portability ==

When composing in OpenMPT, you may wish to share the track file itself (rather than the audio version of the file) so that other people can see the work involved. Other people might be using different versions of ModPlug Tracker or a completely different software altogether with different playback or audio settings, which may alter playback in one way or another. Ideally, Compatibility Export should be used to minimize the risk of running into incompatibilities. There have always been compatibility issues between different tracking applications and as long as you know what these issues are, you can work around it when you are composing with OpenMPT. Often, they have to be figured out manually, though.

[[Category:Manual|Saving and exporting]]
[[de:Handbuch: WAV-Export]]

Manual: Plugin Manager

2020-07-22T20:50:26Z

Twomoso: grammar correction ("support" > "supports")

[[Image:Plugin Manager.png|thumb|300px|Plugin Manager window]]

The Plugin Manager dialog can be found from the [[Manual: Menus#View|View]] menu or a song′s [[Manual: General#General|General Tab]] and allows you to register new plugins with OpenMPT and load them into the current track. It lists all plugins in a folder list, where any folder can be opened and viewed by clicking on the + next to it. Effect plugins are shown with a speaker symbol next to them, while Instrument plugins show a keyboard symbol.
If you want to remove the current plugin assignment, select "No plugin" from the list.

* '''Plugin Filter''': Input a few letters to filter which plugins are shown. Only plugins whose name, vendor name or tags contain that character sequence are shown. Erase the contents of this field to show all plugins again. Several tags can be searched for at the same time by separating them with spaces.
* '''Plugin List''': Shows all plugins that have been loaded into OpenMPT. DirectX plugins that have been registered properly in Windows show up automatically in this list. Other plugins have to be added manually by using the "New Plugin" or "Scan Folder" button.
* '''Put in FX Slot''': Click on this button to load the selected plugin into the current plugin slot of the current module. When opening the Plugin Manager by a shortcut key or from the main menu, the slot number given will be the first available slot.
* '''Cancel''': Closes the window without adding or removing any plugins to the current module.

The '''Tags''' field can be used to enter arbitrary space-separated tags to facilitate finding your favourite plugins.

For managing the list of known plugins, the following options are available:
* '''New Plugin''': Opens a file picker so you can locate one or more plugins to load into OpenMPT’s list of known plugins. OpenMPT supports plugins that follow the [https://en.wikipedia.org/wiki/Virtual_Studio_Technology Virtual Studio Technology] 1.x and 2.x standard (commonly abbreviated VST).
* '''Scan Folder''': Scans a complete folder (including sub folders) for new plugins.
* '''Remove''': Removes the selected plugin from the list of known plugins.

== Plugin Bridge ==

For plugins that do not run natively in OpenMPT (e.g. 32-bit plugins cannot run in a 64-bit instance of OpenMPT), a plugin bridge is provided. It is automatically used for plugins that require it, but can also be enabled manually. This is usually not necessary, but can be used with plugins that tend to crash OpenMPT. If they crash within the plugin bridge, they will only stop outputting sound, but OpenMPT itself will still work.

The Plugin Bridge may also be used to avoid an issue in Windows versions prior to Windows 10 version 1903, where in the worst case only up to 64 different plugins could be loaded at once; bridging some of the plugins bypasses this limitation.

It is recommended to only make use of this feature if required, though, as every bridged plugin adds latency, which can easily add up to an amount that makes low-latency audio processing impossible.

* '''Use Plugin Bridge''': If checked, the plugin is loaded into the plugin bridge instead of the main OpenMPT process. For plugins that cannot be loaded natively, this option is always enabled.
* '''Share Bridge between all Instances''': Some plugins (e.g. sidechain compressors such as SideKick) can only work if all of their instances are loaded into the same process. Enabling this option will load all instances of the selected plugin into the same bridge process. Otherwise, every instance is loaded into its own process. Sharing a bridge process can also speed up plugin loading, but if one plugin instance crashes, it may break all other instances of the same plugin, too.

[[Category:Manual|Plugin Manager]]
[[Category:Windows|Plugin Manager]]
[[Category:Plugins|Plugin Manager]]
[[de:Handbuch: Plugin Manager]]

Manual: SFZ Implementation

2020-06-16T00:04:28Z

Twomoso: grammar corrections

It is possible to load SFZ instruments through the [[Manual: Instruments|Instrument Editor]].

[https://sfzformat.com SFZ] is a loosely standardized text-based instrument format with external sample files, and is the recommended format for instrument interchange with other applications. OpenMPT tries to support as many SFZ opcodes as possible, including some that are specific to other vendors; its sampler only supports a fraction of the features of a full-fledged SFZ player, though.

The following SFZ opcodes are supported:

== <control> ==

* <tt>default_path</tt>: The default path to search sample files in.
* <tt>note_offset</tt>: Global transposition in semitones.
* <tt>octave_offset</tt>: Global transposition in octaves.

== <global>, <master>, <group>, <region> ==

* <tt>sample</tt>: The sample filename, relative to the SFZ file or <tt>default_path</tt>, if specified. This can also be one of the following values to generate a synthesized sample: <tt>*sine</tt>, <tt>*square</tt>, <tt>*triangle</tt> / <tt>*tri</tt>, <tt>*saw</tt>, <tt>*silence</tt>, <tt>*noise</tt>.
* <tt>lokey</tt>: The lowest key this region is mapped to, either as a MIDI note index (0 to 127, 60 is middle-C) or scientific pitch designation (C, C#/Db, D, D#/Eb, E, F, F#/Gb, G, G#/Ab, A, A#/Bb or B, followed by an octave number; 4 is the middle octave, so C4 is middle-C).
* <tt>hikey</tt>: The highest key this region is mapped to, in the same format as <tt>lokey</tt>.
* <tt>pitch_keycenter</tt>: The pitch at which the sample is played at its original sample rate, in the same format as <tt>lokey</tt>.
* <tt>key</tt>: Sets <tt>lokey</tt>, <tt>hikey</tt> and <tt>pitch_key_center</tt> to the specified value, which is in the same format as <tt>lokey</tt>.
* <tt>bend_up</tt> / <tt>bendup</tt>: Sets the MIDI pitch-bend depth in cents.
* <tt>pitchlfo_fade</tt>: Sets the sample auto-vibrato sweep in seconds (approximately).
* <tt>pitchlfo_depth</tt>: Sets the sample auto-vibrato depth.
* <tt>pitchlfo_freq</tt>: Sets the sample auto-vibrato rate.
* <tt>volume</tt>: Sets the sample global volume, ranging from -144dB to +6dB.
* <tt>amplitude</tt>: Sets the sample global volume, ranging from 0 to 100.
* <tt>pan</tt>: Sets the sample pan position, ranging from -100 (left) to +100 (right).
* <tt>transpose</tt>: Transposes the region up or down by the specified amount of semitones.
* <tt>tune</tt>: Detunes the sample by the specified amount of cents, ranging from -100 to +100.
* <tt>end</tt>: Trims the sample to the specified length.
* <tt>offset</tt>: Starts playing the sample at the specified offset. OpenMPT completely removes any leading waveform data.
* <tt>loop_start</tt> / <tt>loopstart</tt>: Start of the sample loop.
* <tt>loop_end</tt> / <tt>loopend</tt>: End of the sample loop.
* <tt>loop_mode</tt> / <tt>loopmode</tt>: One of the following sample loop modes:
** <tt>loop_continuous</tt>: Normal sample loop.
** <tt>one_shot</tt>: Treated like <tt>loop_continuous</tt>.
** <tt>loop_sustain</tt>: Sustain loop.
** <tt>no_loop</tt>: Disable loop completely.
* <tt>loop_type</tt> / <tt>looptype</tt>: One of the following sample loop types:
** <tt>forward</tt>: Normal forward loop.
** <tt>backward</tt>: Reverse loop.
** <tt>alternate</tt>: Ping-pong loop.
* <tt>loop_crossfade</tt>: Crossfades the loop start and end. The fade length is specified in seconds.
* <tt>cutoff</tt>: Sets the filter cutoff frequency in Hz.
* <tt>fil_random</tt>: Random cutoff variation in cents.
* <tt>resonance</tt>: Sets the filter resonance in dB.
* <tt>fil_type</tt> / <tt>filtype</tt>: One of the following filter types:
** <tt>lpf_1p</tt> / <tt>lpf_2p</tt> / <tt>lpf_4p</tt> / <tt>lpf_6p</tt>: All treated as internal two-pole low-pass filter.
** <tt>hpf_1p</tt> / <tt>hpf_2p</tt> / <tt>hpf_4p</tt> / <tt>hpf_6p</tt>: All treated as internal two-pole high-pass filter.
* <tt>polyphony</tt>: The allowed maximum polyphony for this sample. Only a value of 1 is supported, in which case the Duplicate Note Check is set to Note Cut.
* <tt>phase</tt>: Setting this to <tt>invert</tt> inverts the sample phase.
* Envelopes: <tt>ampeg_…</tt> (volume envelope), <tt>fileg_…</tt> (filter envelope), <tt>pitcheg_…:</tt> (pitch envelope):
** <tt>…eg_start</tt>: Start level of the envelope, ranging from -100 to +100.
** <tt>…eg_delay</tt>: Delay, in seconds, until the attack phase of the envelope starts.
** <tt>…eg_attack</tt>: Duration of the attack phase in seconds.
** <tt>…eg_hold</tt>: Duration of the hold phase in seconds.
** <tt>…eg_decay</tt>: Duration of the decay phase in seconds.
** <tt>…eg_sustain</tt>: Sustain level of the envelope, ranging from -100 to +100.
** <tt>…eg_release</tt>: Duration of the release phase in seconds.
** <tt>…eg_depth</tt>: The depth of the envelope in cents. Only applies to pitch and filter envelopes.
* <tt>region_name</tt>: Sets the sample name.
* Flex EGs: <tt>eg01_…</tt> through <tt>eg99_…</tt>:
** <tt>…timeX</tt>: Time of the X-th envelope point in seconds, relative to the previous envelope point.
** <tt>…levelX</tt>: Level of the X-th envelope point, between -1 and +1.
** <tt>…points</tt>: Number of points in the envelope.
** <tt>…sustain</tt>: The index of the sustain point, 0 being the first.
** <tt>…amplitude</tt> / <tt>…ampeg</tt>: Specifies how much the envelope influences the amplitude, 100 being the full volume range.
** <tt>…pan</tt>: Specifies how much the envelope influences the panning, 100 being the full pan range.
** <tt>…pitch</tt>: Specifies how much the envelope influences the pitch, in cents.
** <tt>…cutoff</tt>: Specifies how much the envelope influences the filter cutoff, in cents.

== Miscellaneous ==

* <tt>#define</tt> macros are supported. Macro names must start with a <tt>$</tt>, e.g. <tt>#define $duration 0.5</tt>
* Other SFZ files can be included into the current file via <tt>#include "filename.sfz"</tt>
* Sample files can be of any type supported by OpenMPT’s sample editor (WAV, FLAC, Ogg, Opus, MediaFoundation codecs, etc.)
* Loop points are read from sample files (as far as they are supported by OpenMPT) if a region’s <tt>loop_mode</tt> is set but no loop points are provided.

[[Category:Manual|SFZ Implementation]]

Manual: MIDI Reference

2020-06-15T23:54:48Z

Twomoso: grammar corrections; (source) remove unnecessary ` ` tag

== Overview ==

In 1982, a protocol was standardized to allow the use of commands or other digital messages to manage synthesizer data in a more-or-less universal format. It was dubbed the ''Musical Instrument Digital Interface'', or MIDI for short. MIDI transmissions are only event messages rather than audio signals, and are designed so that synthesizers may each produce and process audio in their own way, but also allow external control through a system ideally understood by all relevant devices. Playing notes, bending their pitch, controlling panning position, and synchronizing timers between synthesizers of different makes and models were possible, all within a single set of short messages.

In the 1980s, MIDI allowed for digital composition to be done on computers or specialized electronic devices called ''sequencers''. Sequencing used the MIDI language to make it easy to record and edit events that would control MIDI synthesizers, and even trigger it to play back audio which could be recorded to an appropriate medium. While file sizes were small and commands could be understood by any MIDI-compatible device, the disadvantage was that a song was likely to sound different on different synthesizers, because each had its own means of producing sounds.

''General MIDI'', or GM, was an attempt to address this problem. It is a simple set of pre-defined “preset” instrument programs and control messages any sequencer file can use to produce a synthesizer-independent playback sound (differences in instruments' timbre across synths aside). The GM standard not only assigned specific instruments to particular program numbers, but also mapped many MIDI controllers to important synth effects and set minimums for polyphony and number of channels. GM is still in use today, and has even been expanded into different formats like Roland’s GS and Yamaha’s XG, as well as the more recent GM2 specifications present in many newer synthesizers.

Many of the synthesizer parameters that can be manipulated are done so using MIDI messages that work in each one of 16 channels, with each of those channels assigned one instrument. In effect, this means only 16 instruments can be played at a time, but Program Change messages can be used to switch instruments out for others in real-time. MIDI channel messages such as these are only a few bytes in length, which make for excellent translation speed between the event and the parameter control.

For an action as simple as playing a note on a MIDI keyboard, the following could (and in many cases does) happen:

* The '''Note On''' message is sent, which is a data package that contains the note (within a range of 0 to 127, the range of notes on the MIDI keyboard) and ''key velocity'', the strength at which the key was struck.
* '''Aftertouch''' is activated (if pressure to the synth keys is held), which sends messages that may affect each key (''poly pressure'') or the entire keyboard (''channel pressure'').
* The '''Note Off''' message is sent, which contains the key’s release velocity, the strength at which the key was released.

Not all synthesizers pass or understand all of these parameters; the only ones that are truly universal are the note values for Note On and Note Off messages. Furthermore, many synthesizers offer ways of affecting the instrument settings as they are being processed, such as Pitch Bend and Modulation wheels, joysticks, data sliders, knobs and buttons, foot controllers and pedals, breath controllers, and ribbon controllers. All of these send their own messages using their own controller numbers, which can sometimes be assigned by the user, depending on the synth model.

== MIDI Messages ==

The data blocks commonly referred to as MIDI Messages are sent serially in one-way paths from one MIDI device’s “MIDI Out” connector to the other device’s “MIDI In” connector (“MIDI Thru” passes on the MIDI In signal to another device). The messages are simple but specific, often taking the form of commands that not only control various synth settings like pitch, volume, key pressure, and filters, but also change programs or banks, or toggle arpeggiations or on-board effects. Many of these messages have a universal scope of application, but not all do; each company can set its own use for the MIDI controller messages, and even different devices from the same company will use the same controller assignments to manipulate different parameters.

At a basic level, there are eight types of MIDI messages:

* '''Notes''': MIDI has 128 notes represented, from C-1 to G9 (scientific pitch, the equivalent of C-0 to G-10 in OpenMPT’s octave range; notes above B-9 are not available), or 0 to 127. Assuming Western tuning, this is the range from 8.176 Hz to 12,544 Hz.
: Sending a note value with velocity greater than 0 is considered a Note On message.
* '''Key Pressure''': An aftertouch message is sent when active notes are under continuous, non-static pressure.
: Most keyboards still use Channel Pressure messages that apply aftertouch to the entire keyboard, while some more expensive keyboards send Poly Pressure (also called ''Polyphonic Aftertouch'') messages from each pressed key. These two types of aftertouch are usually not found together in the same controller.
* '''Pitch Bend''': In OpenMPT, this is called portamento and increases or decreases the pitch of the note in 64ths of a semitone, while in MIDI, pitch bends are defined to work in a given pitch wheel range. These messages bend the synthesizer notes by a pre-defined amount of semitones up or down in one event.
: There is a standardized but not universally supported way of controlling the pitch bend range through General MIDI Registered Parameter Number messages; relatively few MIDI devices understand this mechanism. In OpenMPT, you have to define the synth’s pitch bend range to properly utilize portamento effects with MIDI gear and instrument plugins.
* '''Control Change''': For all other instrument parameters that can be manipulated, MIDI CC messages are assigned by the manufacturer to control certain settings. While there is a standardized set of controls, there is a certain amount of flexibility by each synth maker, so do not assume that a standard CC command will control a listed parameter. Read the synthesizer’s MIDI implementation table to find out which MIDI CCs it responds to.
* '''Program Change''': These special messages call up another program (or patch) from the synthesizer’s current bank. Many synths also support a MIDI CC to change banks. One bank may contain up to 128 programs.
* '''System''': These are specialized messages such as MIDI clock ticks or Active Sense that keep inactive MIDI devices connected to each other.
* '''System Exclusive (SysEx)''': These messages usually contain data dumps or device settings that each manufacturer defines for its devices.
: This type of message is often used for transmitting entire patches or banks (e.g. for backup purposes), or synth parameters that exceed the complexity provided by Control Changes (such as tuning scale setup). Some synths also use SysEx messages instead of MIDI CCs to update their parameters.
* '''Real-Time System Exclusive''': These are the newer type of MIDI messages that control the interaction and communication of MIDI-compatible equipment which activate lights or other devices, usually designed for stage shows and concerts.

== OpenMPT Setup ==

=== Enabling MIDI Input ===

[[Image: Preferences Icon.png|thumb|Setup icon]]
[[Image: MIDI Record Icon.png|thumb|MIDI Record icon]]

# Plug your MIDI device into your computer.
#* Unless the device has a PC-specific port (serial or USB), or your computer has a MIDI-specific input, you will probably need a special converter plug to transfer MIDI messages between the two. Check your device’s manual to make sure you have the correct connection. Many newer computer models no longer use serial ports, but some older MIDI synths provided them.
#* If you are planning to purchase a MIDI device for use with OpenMPT, it is advisable to get one with USB connections; they are generally better supported and have higher data exchange speed and reliability.
# Click on the Setup icon in the Main toolbar, or alternatively, select the Setup menu item from the [[Manual: Menus#View|View]] menu). The [[Manual: Setup|Setup dialog]] will open.
# Click on the MIDI tab to see the [[Manual: Setup/MIDI|MIDI Setup]] page.
# In the “MIDI Input Device” list, make sure the correct input for your MIDI device is selected.
# In the Main Toolbar, select the “MIDI Record” button, depicted on the right. Check '''Enable MIDI recording''' in the MIDI Setup to have this enabled by default.
# Now, while editing in the [[Manual: Patterns|Pattern Editor]], keys played on your MIDI keyboard will result in the corresponding notes being placed into the pattern.

To control plugin parameters using incoming MIDI data, you can set up parameter routing from the [[Manual: MIDI Mapping|MIDI Mapping dialog]].

It's also possible to quickly switch between several MIDI input devices from the main toolbar by clicking the drop-down button next to the MIDI Record icon.

=== Enabling MIDI Output ===

The '''MIDI Input / Output''' plugin is built into OpenMPT to allow for easy MIDI routing.

This plugin is more than just an instrument plugin to send out MIDI data; as the name suggests, it can also be used to capture incoming MIDI events. While this might seem redundant at first, in some cases it has advantages over the default MIDI input:

* Several plugin instances can be opened at once, allowing multiple MIDI inputs.
* The incoming MIDI events are ''only'' routed to the next chained plugin.

Combining these two previous points, one can use the plugin to control another instrument plugin exclusively using the MIDI data from the MIDI plugin. Only the selected output plugin of the MIDI plugin will receive this input. MIDI events captured by this plugin can also be recorded to the pattern editor by toggling the '''Record MIDI Out to Pattern Editor''' setting in the plugin window’s [[Manual: Plugin Window#Options|Options menu]].

Plugin chains can be set up with several MIDI processing plugins. For example, MIDI events captured by this plugin can be sent to an arpeggiator plugin, followed by the arpeggiated MIDI data generated by that plugin being sent to another instance of the MIDI Input / Output plugin to control external gear that has no built-in arpeggiator.

[[Image: MIDI Input Output Plugin.png|thumb|300px|Interface of the MIDI Input / Output plugin]]

Here is a short tutorial on setting up the MIDI Input / Output plugin to control external MIDI:

# Open or create a track in the XM, IT, or MPTM format (preferably MPTM).
# In the Plugin section at the bottom half of the [[Manual: General#Plugin Setup|General]] page, make sure the current plugin is empty, and click the “Select” button next to it. The “Plugin Manager” window will open.
# Select the MIDI Input / Output plugin in the instruments category and click the top button, “Put in FX01” (substitute “01” with the slot number you want to place the plugin into).
# Click the Edit button to see its interface, shown on the right, and then click the dropdown list under “MIDI Output Device” to choose the MIDI port to route MIDI data to.
# OpenMPT automatically creates an [[Manual: Instruments|instrument]] to control the plugin. You can then use the newly created instrument to send note data to the MIDI Input / Output plugin on a specified MIDI channel, which in turn will send it to the port where your MIDI instrument receives its data. This should play the MIDI instrument.
# To assign a MIDI controller to a macro for output (so that you can manipulate MIDI parameters of an external MIDI device during playback), see the section on [[Manual: Zxx Macros|Zxx Macros]].

'''Note''': “Output Latency” delays the MIDI output relative to OpenMPT’s own audio output latency. A default value of 0 ms sends the MIDI signals at the same time as OpenMPT’s audio output. A positive value will delay the MIDI signals (in case they can be heard too early in comparison to the other audio), while a negative value (down to the duration of OpenMPT’s own output latency) will send the MIDI signals before the other audio (to compensate for any delays induced by the MIDI port or target MIDI device).

The following MIDI messages are transmitted when “Send timing messages” is checked:

* '''Start''' (FA)
* '''Stop''' (FC)
* '''MIDI Clock Tick''' (F8)

[[Category:Manual|MIDI Reference]]
[[Category:Plugins|MIDI Reference]]
[[Category:MIDI|MIDI Reference]]
[[de:Tutorial: MIDI-In und MIDI-Out]]

Manual: Zxx Macros

2020-06-15T23:32:23Z

Twomoso: grammar corrections; (introduction) add bold styling to first mention of macro types

Zxx Macros are MIDI messages that can be sent to plugins or used to control internal parameters, such as the built-in resonant filter for samples or plugin parameter automation (“turning a knob” of a plugin). Macros are executed in patterns using the Zxx (MIDI Macro) or \xx (Smooth MIDI Macro) commands, hence the name. Macros can be used in the XM, IT and MPTM formats and are set up from the [[Manual: Macro Configuration|Macro Configuration dialog]]. For plugin parameter automation, the MPTM format also offers special [[Manual: Parameter Control Events|Parameter Control Events]] with higher granularity than MIDI macros. Depending on the parameter of the Z command, a different macro is processed. Every macro can comprise one or more MIDI messages.

Every macro may contain one or more MIDI messages. Multiple messages can be joined simply by writing them one after another (e.g. <code>Bc0Az Bc0Bz</code> to execute MIDI CC 10 and 11 using the same macro). There is no need to separate the messages with a space character (but it improves readability), however it is important to properly finish MIDI messages: <code>Bc0A0</code> (set MIDI CC 10 to value 0) works if it is the only MIDI message in a macro (as it is automatically finalised by the program), but if another MIDI message follows, you would have to add another 0 at the end, as the example message contains only 5 nibbles.

OpenMPT employs two types of macros: '''parametered''' and '''fixed''' macros. While fixed macros always transmit the same MIDI message, parametered macros depend on the parameter of the Zxx command. Fixed macros, however, are not necessarily completely static. They can for example depend on the current instrument’s volume and panning settings.

== Parametered Macros ==

[[Image:Macro Switching Example.png|thumb|102px|Example of switching macros on a channel]]
There are 16 parametered macros. Only one of those 16 parametered macros can be active on a channel at a time, and it is controlled using the commands Z00 through Z7F. Parametered macros can be switched by using the SFx command in IT-type tracks and EFx in XM tracks. SF0 / EF0 activates the first parametered macro, SF1 / EF1 the second and so on. By default, the first macro is active, but if you want to switch to a different parametered macro on a channel, you first have to put the appropriate SFx / EFx effect on a row above the first usage of the macro.

In the example on the right, the third macro is recalled on the first row, and some Zxx and \xx commands on the subsequent rows execute this parametered macro. Row 6 switches back to the first macro, which is then applied on row 7.

== Fixed Macros ==

There are 128 fixed macros which can be called by the commands Z80 through ZFF (and \80 through \FF respectively). By default, The macros Z80 through Z8F control the resonant filter′s resonance amount and Z90 through ZFF do nothing. In theory, all of the 128 fixed macros can do something completely different, while all 128 instances (Z00 through Z7F) of the same parametered macros do the same thing, just with a different parameter. For example, you could configure the fixed macros Z80 through Z8F to control the resonance of the resonant filter, Z90 to activate the lowpass filter (<code>F0F00200</code>), Z91 to activate the highpass filter (<code>F0F00210</code>), Z92 to set the Dry/Wet ratio of the current plugin to 100% Dry (<code>F0F00300</code>), Z93 to set it to 100% Wet (<code>F0F0037F</code>), and so on. You can even configure a single macro to change a number of parameters at once. For example, you could set a plugin’s first parameter to 0 and its Dry/Wet ratio to 50% (<code>F0F08000 F0F00340</code>).

== Macro Types ==

Some of the MIDI messages that can be generated through a macro are handled internally by OpenMPT, others are directly sent to plugins. Here is an overview of all macro types.

[[Image:Sample Filtering.png|thumb|250px|Spectrum analysis of a saw wave. First, the unfiltered saw sample, then the same sample with a lowpass filter applied and the same sample with a highpass filter applied.]]

=== Resonant Filter Control ===

OpenMPT′s resonant filter can be controlled through internal macros. They can be used for setting the cutoff frequency, resonance amount and filter type. The resonant filter is only applied to samples — it does not affect the output of plugins. If you want to filter the output of a plugin, you will have to route its output to a filter or equalizer plugin.

The following MIDI messages modify OpenMPT′s resonant filter:

* '''F0 F0 00 xx''': Set cutoff frequency, where xx is a hexadecimal number between 00h (lowest cutoff frequency) and 7Fh (highest cutoff frequency). The highest cutoff frequency is determined by the [[Manual: Song Properties#Extended Filter Range|Extended Filter Range]] option, which can be found in the Song Properties. For AdLib / OPL3 instruments, this macro sets the modulator intensity, which effectively works like a lowpass filter on most instruments.
* '''F0 F0 01 xx''': Set filter resonance, where xx is a hexadecimal number between 00h (no resonance) and 7Fh (full resonance). The higher the resonance, the more the cutoff frequency is “stressed” or “accented” — it resonates.
* '''F0 F0 02 00''': Activate lowpass filter. Frequencies above the cutoff frequency are reduced, and frequencies below the cutoff frequency are not affected. A low cutoff frequency makes the sample sound muffled, and a higher cutoff frequency reduces the effect. Look at the second spectrum graph on the right for an example.
* '''F0 F0 02 10''': Activate highpass filter. Frequencies below the cutoff frequency are reduced, and frequencies above the cutoff frequency are not affected. A high cutoff frequency makes the sample sound thinner, and a lower cutoff frequency reduces the effect. Look at the third spectrum graph on the right for an example.

The filter type settings (lowpass / highpass) are mutually exclusive, i.e. you can only '''either''' cut off high frequencies '''or''' low frequencies.

The default parametered macro controls cutoff frequency and the default fixed macros control the resonance amount. Note that all these filter settings can also be set up for each [[Manual: Instruments#Filter|instrument]].

By default, no sample needs to be playing to apply filter macros; they will be applied to whatever sample is playing next, unless the instrument settings would override the macro′s functionality. However, if [[Manual: Effect Reference#Sound Control|Local Filters]] are enabled, the filter is disabled on every new note. The filter can also be disabled manually for the next note by setting the cutoff to 7Fh and the resonance to 00h.

=== Plugin Dry/Wet Ratio ===

This is another internal macro that is handled by OpenMPT. It adjusts a plugin′s Dry/Wet ratio (which can otherwise be set from the [[Manual: General|plugin setup]] on the General Tab) of the currently active plugin on the channel the macro is executed. The MIDI message for this macro type is '''F0 F0 03 xx''', where xx is a hexadecimal number between 00h (0% Wet / 100% Dry) and 7Fh (100% Wet / 0% Dry).

Only the first plugin in a plugin chain is affected by this macro, and channel plugins are generally preferred over instrument plugins.

=== Plugin Parameter Control ===

Plugin Parameter Control is another internal macro type that is handled by OpenMPT. It sets a given parameter of a plugin to a given value. However, this parameter control is limited to the first 384 parameters and is very coarse. Parameter control is not bound to a specific plugin, but rather changes the given parameter of whatever plugins is currently active on the channel the macro is executed.

The first 128 plugin parameters (0 through 127) can be controlled by the MIDI message '''F0 F0 xx yy''', where xx is the parameter number + 80h and yy is the parameter value, ranging from 00h to 7Fh. Parameters 128 through 383 can be controlled by the MIDI message '''F0 F1 xx yy''', where xx is the parameter - 80h and yy is the parameter value.

In the MPTM format, this macro type is superseded by [[Manual: Parameter Control Events|Parameter Control Events]], which provide finer control of more parameters (the first 1,000 parameters of any plugin can be controlled).

Only the first plugin in a plugin chain is affected by this macro, and channel plugins are generally preferred over instrument plugins.

=== External Messages ===

Any macro that is not covered by the above macro types is an '''external''' message, i.e. it is not handled or interpreted by OpenMPT itself but is rather sent to plugins. External messages include MIDI CCs, Channel and Polyphonic Aftertouch, note events and generally any kind of MIDI event.

Since OpenMPT can neither know the meaning of such external messages, nor their previous parameter state (which is necessary for interpolation), '''\xx only has limited support''' for those messages. When using \xx commands to execute external messages, it interpolates from the previous Zxx or \xx parameter used on the same channel.

The MIDI message is only sent to the first plugin in a plugin chain, and channel plugins are generally preferred over instrument plugins.

{{todo|More content from the OHM}}

[[Category:Manual|Zxx Macros]]
[[Category:Plugins|Zxx Macros]]
[[Category:MIDI|Zxx Macros]]

Tutorial: Getting Started

2020-06-15T23:12:33Z

Twomoso: /* Setting up the sound card */ grammar corrections

== 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?34036 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 or DirectSound (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”. 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: Setup/Soundcard

2020-06-15T23:09:25Z

Twomoso: /* Sound Device */ grammar corrections ("ofter" > "often"; remove nested parentheses)

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

OpenMPT automatically detects installed sound devices on your computer, and in this page you can assign settings based on your computer's capabilities.
If you are having trouble with playback, you may want to alter these settings so that OpenMPT uses less processing power for rendering audio.
For more tips on fixing audio issues, check the [[Manual: Setup/Soundcard#Troubleshoot|troubleshooting section]] further below.

== Soundcard Options ==

=== Sound Device ===

Shows the current audio device and driver that OpenMPT is using.
Clicking on this field will open a list where you can choose another device. The new device is used as soon as you apply all changes in the dialog.

OpenMPT is currently phasing out support for some older sound APIs (like MME, often also referred to as WaveOut, and DirectSound) which will be removed in a future version. If you still want to use these, you can check the '''Show deprecated devices''' checkbox.

If a new audio device is plugged into the computer while OpenMPT is running, the '''Rescan''' button can be used to refresh this list.

OpenMPT defaults to using the shared mode WASAPI audio API, which provides a good compromise between low latency and compatibility and is the standard audio API in Windows. For low-latency and device-exclusive audio playback, WASAPI exclusive mode, as well as support for ASIO and WaveRT kernel streaming are also available.

Some ASIO drivers may not be able to play several audio streams at once (exclusive access). This may lead to some unwanted consequences described in the [[Manual: Frequently Asked Questions#Audio and MIDI|FAQ]]. One such driver is the popular ASIO4All driver. WaveRT is always exclusive.

It is recommended to use the default WASAPI shared mode. If you can afford having OpenMPT access your audio device exclusively (i.e. no other application may play any sound while OpenMPT is playing), it is recommended to use either ASIO (if available) or WASAPI exclusive mode, or WaveRT if very low latency is a major concern and ASIO is not available.

=== Setup Device ===

Brings up the system sound control panel (WASAPI devices) or the ASIO control panel (ASIO devices).

=== Latency ===

Here you can specify the suggested output latency of your sound device. Basically the Latency setting describes the timing difference between any kind of user input and the audio output, so generally this value should be as low as possible. Too small values can introduce unwanted audio artefacts such as clicks and drop-outs. A slow CPU or usage of plugins that require a lot of processing time may force you to pick a higher setting.

Some drivers may automatically pick a suitable latency setting regardless of the user’s choice (such as WASAPI in exclusive mode or certain ASIO drivers), or they will just pick a latency setting that is as close as possible to the settings suggested by the user.

=== Period ===

This setting sets the suggested period (or interval) the sound output buffer gets updated by OpenMPT. The smaller the period is, the better the chance that the sound buffer does not drain empty which would result in audible crackling. This setting currently also affects the accuracy (jitter) and speed of GUI updates, note inputting, MIDI recording and similar actions. Shorter periods slightly increase the CPU usage, but any computer should be able to handle an update interval of 5ms, so try starting from there when configuring this value.

As with the latency setting, this value is considered just a suggestion to the driver and the actual value used might deviate a bit from the selected value.

Since the number of audio buffers is fixed for ASIO drivers, the period option is not available with such drivers. In that case, the period is always half the latency.

In general, you do not have to care much about this setting, but it should be as low as possible for obvious reasons.

=== Direct Mode / Use Device Exclusively / Use Primary Buffers ===

==== Use Device Exclusively (WASAPI) ====

Opens the driver in exclusive mode, i.e. no other application is allowed to access the sound card while OpenMPT uses it. This bypasses the whole Windows audio mixing and buffering stack. It can thus be used to reduce latency.

==== Direct Mode (MME) ====

This setting demands the Windows audio stack to not perform any further conversion of the audio data (i.e. the number of channels, the sample rate and the sample format should not be changed and the device should be set exactly to the requested settings). Current Windows versions ignore this setting. It is useful on some Wine setups though when the Wine-internal sample conversion has poor performance and Wine should just forward the audio data as is to the underlying system backend.

==== Use Primary Buffers (DirectSound) ====

Avoids a secondary buffering layer in DirectSound emulation. It can thus be used to slightly improve latency.

=== Boost Thread Priority ===

If enabled, the audio rendering thread is given a higher processing priority, so that it is less likely to produce drop-outs. Disabling this setting might result in audible crackling even when your system gets only slightly busy.

Unless you experience problems, it is recommended to leave this setting enabled.

=== Hardware Timing ===

ASIO drivers can provide exact sound device output timestamps to OpenMPT. If you want OpenMPT to rely on those and not do its own timing measurements, enable this option. However, if the driver misbehaves and reports wrong timing information, this will cause severe problems with GUI updates, recording and VST plugins.

=== Output Format ===

Shows the sample rate in the first field, number of channels in the second and the bit depth in the third field and dithering in the last field.
Clicking on either of these opens a list where you can choose another setting.

==== Sample Rate ====

OpenMPT defaults to 48000 Hz. However, some broken VST plugins expect 44100 Hz sampling rate and do not work correctly with any other rate. Windows systems and most audio devices however, by default, use 48000 Hz internally for all audio processing. If you are not using a WASAPI exclusive mode, ASIO, or WaveRT device, this results in all audio to be resampled to the Windows internal sampling rate anyway.
Lowering the sample rate reduces CPU usage almost proportionally and may thus be an option for slower systems in order to reduce CPU usage.
It is recommended to use 48000 Hz or, if you are using broken VST plugins, 44100 Hz.

==== Channels ====

The number of output channels OpenMPT will use.
It is recommended to leave this at "stereo" unless you have 4 (or more) speakers attached and want to have quad surround output.

==== Bit Depth ====

For devices which OpenMPT accesses directly, this setting allows changing the output bit depth (and thus dynamic range) of the audio device. For devices which get routed to the system audio stack, OpenMPT will choose the best possible bit depth and not allow changing it. It is recommended to use either 24-Bit, 32-Bit, or Float 32-Bit for exclusively accessed devices. Since OpenMPT’s mixing always code works with 32-Bit precision, using a lower output bit depth does not gain performance.

==== Dithering ====

When reducing bit depth, dithering can be applied to the audio signal in order to transform harmonic distortion of quantization into a more uniform noise floor.
It is recommended to leave this value at the default.

=== Channel Mapping ===

A lot of professional audio devices support more than 2 channels and have a lot of different output jacks. These are almost always presented as a single ASIO device to applications. With this setting, you can map each OpenMPT channel to one specific channel of your ASIO device.
Please note that some drivers only provide meaningful names for the output channels when the device is already running.

== General Options ==

=== When Playback Is Stopped ===

* '''Close Driver''': Normally, OpenMPT closes the audio device when the playback is stopped. Some ASIO drivers however take a very long time to open or close, in which case this results in undesirable delays.
* '''Pause Driver''': OpenMPT will just pause the ASIO driver. Some ASIO drivers do not allow other applications to use the device in this state.
* '''Play Silence''': Even more ASIO drivers will not allow other applications to use the device in this state. This setting also causes additional power consumption even when playback is stopped, which might be undesirable on mobile computers.

If you do not care about power consumption or about concurrent access to the audio device with other applications, it is recommended to select "play silence". Otherwise you have to trade power consumption and concurrent access versus potential delays when starting and stopping playback.

=== Open Device At Startup ===

Opens the audio device directly when OpenMPT starts. This moves a potential delay during audio device initialization from the first time you play a sound in OpenMPT to the time OpenMPT starts.

== Statistics ==

At the bottom of this setup page, you can see the actual number of buffers, the period and the real latency used for playback. These values are shown as long as OpenMPT is outputting sound, otherwise the box will stay empty.

== Troubleshoot ==

If you find that your track “stutters” during playback, you may be trying to process more audio than your computer can handle. To troubleshoot, try doing the following in this order.
* Try a WASAPI device without '''Use device exclusively'''.
* Use Period of 5ms or 10ms.
* Increase Latency in 5-10ms steps.
* When working with plugins, verify that you mostly use plugins that have the same “bitness” as the hosts (e.g. use 32-bit plugins when using OpenMPT 32-bit and 64-bit when using OpenMPT 64-bit). Every bridged plugin adds latency to the mixing process, hence there should be as few bridged plugins as possible.
* Reduce the Sample Rate one step at a time to a minimum of 44100 Hz. Anything less than this can create a vast difference between what you hear and what will be recorded when you export the file to audio.
* If you still encounter stuttering in playback and you are using plugins, you should try to reduce the number of plugins used in your song. If you use an instrument plugin that plays only a few notes or less, consider rendering the notes and importing these notes as samples (more info on rendering is found in the [[Manual:_Saving_and_exporting|Saving and Exporting]] section). Sample playback requires '''much''' less processing power than instrument plugin processing. Also, many plugins have very high CPU usage and can soak up a large percentage of your processing power.

[[Category:Manual|Setup/Soundcard]]
[[de:Handbuch: Setup/Soundcard]]

Manual: About OpenMPT

2020-06-15T23:06:03Z

Twomoso: /* Feature Overview */ grammar correction (remove redundant "and")

== 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 127 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 (sample and bit rates), 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).
* 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.
* 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]]

Manual: Effect Reference

2020-06-04T00:35:22Z

Twomoso: (`Oxx` effect descriptions) refer to parameter as `xx` instead of `x`; /* IT Effect Commands */ (`Ixy` effect) add line break before "For instrument plugins..." sentence (like XM section) /* MPTM Effect Commands */ (introduction) change link formatting

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>).

It should be noted that although the MOD and XM formats share a similar set of effects, the S3M, IT, and MPTM formats share a very different set of effects (even if they duplicate many of the features from the MOD and XM formats).

Currently, most effects only affect samples, not instrument plugins. 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.

=== 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 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
| —
| Sets the finetune value for the current sample. Functions similarly to the same setting in the Sample Editor.
| 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 Commands
| —
| {{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
| —
| Sets the finetune value for the current sample. Functions similarly to the same setting in the Sample Editor.
| 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>A0y</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>Ax0</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, 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
| 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-pitch" | Pitch
|-
| '''<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 the inversed phase instead.
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 ScreamTracker 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-pitch" | Pitch
|-
| '''<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> or <abbr title="Set Tempo"><code>Txx</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>), <code>xx</code> is added to the parameter of the original command × 256. 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
|}

=== 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. By default, <code>x</code> × 2048 is used; specific 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>.
| 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.

=== 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.

=== 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: Compatible Playback

2020-06-03T23:48:22Z

Twomoso: grammar corrections; /* Playback Compatibility Settings */ expand contraction; (in source) change inconsistent whitespace; /* XM compatibility settings */ remove period after a setting's name

== 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 compatiblity 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 portmento 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.
* '''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.
* '''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.

=== 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.

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.

=== 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's 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.

=== 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 ScreamTracker 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 ScreamTracker 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.
* '''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 ScreamTracker 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.

=== 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.
* '''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.

[[Category:Manual|Compatible Playback]]

Manual: Known Issues

2020-05-30T22:49:36Z

Twomoso: /* Roland (Edirol) Orchestral */ grammar corrections

This chapter is devoted to addressing compatibility issues that OpenMPT has with certain plugins.
The list is by no means complete, and it certainly is not our goal to compile a general list of buggy plugins.
Keep in mind that there are many plugins out there that only work with a couple of plugin hosts (because the plugin author was lazy, did not conform to the VST “standard”, only tested their plugin with one host, etc.).
The best way to test if a plugin is buggy or just not compatible with OpenMPT is to load the plugin into a similar host (Renoise, Psycle, MadTracker, etc.) and check if they behave identically.

== General ==

=== Plugins with hundreds of parameters ===
Plugins like Boris K.′s INTRO or Novaflash′s Oxytocin have too many controls for use with MIDI macros. Macros can only be used to control the first 384 parameters.

'''Workaround:''' If you need to automate plugin parameters, use these plugins only in [[Manual:_Module_formats#The OpenMPT format (.mptm)|MPTM]] format and access the controllers with Parameter Control Events, in which the limit is 1000.

=== SynthEdit 1.4 plugins ===
Plugins made with SynthEdit 1.4 versions before February 2020 may crash when loading two different SynthEdit 1.4 plugins consecutively and opening both plugins′ editor panels.

'''Workaround:''' Use OpenMPT’s built-in plugin bridge, and ask the plugin author to recompile their plugin with the latest SynthEdit version.

=== SynthMaker plugins ===
Some plugins made with SynthMaker, such as Angular Momentum Freehand or SynthSchool Odyssey, will not render parameter or pitch wheel changes correctly during export (most notably, automation will happen in much more coarse steps), even though the track itself will play perfectly during normal playback.

'''Workaround:''' Use a recording plugin like [https://www.voxengo.com/product/recorder/ Voxengo Recorder] and put it at the end of your master plugin chain. Then, play the complete song in the tracker (do not use the export feature). Using [[Manual:_Saving_and_exporting#Plugin_Quirks|slow render]] may also improve (but not completely remedy) the situation.

=== Plugins that make use of the full MIDI note range ===
Some instrument plugins, notably drum plugins such as Toontrack EZDrummer, make full use of the 128 MIDI note range, but OpenMPT cannot access the highest 8 notes, which has the side effect of not being able to play the highest octave of the instrument plugins.

'''Workaround:''' You can use MIDI macros to send arbitrary notes to plugins. For example, you could use the parametered macro <tt>9c z v</tt> to trigger any of the 128 MIDI notes and <tt>9c z 0</tt> to stop it.

=== Crackling and clicking plugins ===

With some plugins like Synful Orchestra and older versions of jBridge, semi-random clicks can be heard when using the plugin. This problem does also occur in other VST hosts that use a varying plugin buffer length.

'''Workaround:''' None. Notify the plugin authors of the problem. Upgrade to the latest version of jBridge or use OpenMPT′s own plugin bridge.

=== Copy-protected plugins ===

Some plugins like SampleTank will only work if you run OpenMPT in administrator mode, most likely due to their copy protection.

'''Workaround''': Do what you should never do - run OpenMPT in administrator mode.

== Specific Plugins ==

=== Farbrausch V2 ===
While the V2 can be automated through VST parameters, parameter changes are not made visible in the plugin GUI instantly. Likewise, OpenMPT does not get notified of parameter changes made through the plugin GUI, so recording parameter changes does also not work. Furthermore, the V2 is very unstable when being used together with other plugins (for example it might freeze the host when closing the module), or when loading multiple instances of V2. Those problems are true for all other hosts as well, due to the way V2 works.

'''Workaround:''' Use OpenMPT’s built-in plugin bridge to separate V2 from other plugins. If you cannot use the bridge, only ever load one V2 instance (several instances of the plugin’s “single” version will also work). If you want to use V2′s sounds in songs together with other plugins, [[Manual: Saving and exporting#Stream Export|render its output to a sample slot]] from a separate module.

=== Genny Beta ===
This plugin uses parameter values outside the nominal 0...1 range without notifying the host about it, so some parameters cannot be automated properly.

'''Workaround:''' Different parameter sets can be used by copying the patch to another preset slot and assigning each copy to a different MIDI channel.

=== Kontakt 2 ===
Kontakt might have many issues when being used from OpenMPT, including GUI, rendering, and “dropped” output over several notes. However, it seems like more recent versions of Kontakt behave more stable in OpenMPT, even without resorting to “host plugins” like Chainer. (Note: Since these issues have been reported, VST support in OpenMPT has been revamped considerably, so they might be no longer true).

'''Workaround:''' Use the latest version of Kontakt to avoid problems. Also, for rendering problems, set the “Slow Render” checkbox in the Wave Export dialog. Users have also suggested using Xlutop′s Chainer VST for older versions, and loading Kontakt into one of its slots; Chainer will then process the VST instrument and send its output to OpenMPT.

=== MDE-X ===

Some effects in Korg’s legacy DSP collection (in particular the mastering limiter) may crash under random conditions which depend on the sound card latency and period settings.

'''Workaround:''' Try varying the latency and period settings until the plugin no longer crashes.

=== Roland (Edirol) Orchestral ===
This plugin does not make use of the VST parameter mechanism, so plugin settings have to be adjusted using MIDI CCs instead. Furthermore, the performance data (plugin settings) is not saved, so re-opening a module using Orchestral will not recall the previous settings (this is a plugin issue, not an issue of OpenMPT).

'''Workaround:''' Use MIDI messages to transmit controller data. Read the plugin′s manual to see its MIDI Implementation Chart. In most cases you can <kbd>Ctrl</kbd>-click on the target GUI control to see which MIDI CC# the control is accessed by, then assign the MIDI CC to a macro.

=== RS-MET Plugins ===

Several older RS-MET plugins have been found to be incompatible with Windows 10.

'''Workaround:''' Find up-to-date replacements, or set the OpenMPT / Plugin Bridge executable′s compatibility settings to Windows 8 or older.

=== Synth1 ===

Due to a bug in the 64-bit version of Synth1, it must be used through OpenMPT’s plugin bridge on Windows 8 and newer.

'''Workaround:''' Use the plugin bridge for Synth1 64-bit, or use the 32-bit version of the plugin.

[[Category:Manual|Known Issues]]
[[Category:Plugins|Known Issues]]

Manual: Parameter Control Events

2020-05-30T22:40:33Z

Twomoso: some changes to formatting to better match other wiki pages; /* Usage */ changes to link formatting and capitalization

Parameter Control Events (sometimes also referred to as “PC Events” or “PC Notes”) are meant as a straight-forward replacement for [[Manual: Zxx Macros#Plugin Parameter Control|Zxx MIDI Macros]] to automate plugin parameters in the MPTM format. The key advantages over Zxx Macros are:

* '''More parameters''': The first 1,000 parameters of each plugin can be automated.
* '''Increased granularity''': The coarse 7-bit automation range is extended to 1,000 discrete values.
* '''No complicated setup''': There is no need to configure a Zxx Macro, and more than 16 macros can be used.
* '''Can be used anywhere''': Parameter Control Events work anywhere in a pattern. No macro change command has to be called before executing a Parameter Control Event. They do not need to be placed on a specific channel to work, although it is generally recommended to reserve some extra channels in your patterns that you only use for automating plugin parameters—it simply looks tidier and more organised.

== Usage ==

Parameter Control Events are entered into the pattern the same way as normal note events, but they always occupy a whole pattern cell:

[[Image: Parameter Control Event.png]]

* The '''note''' column ('''<code>PC</code> / <code>PCs</code>''') indicates that this is a Parameter Control Event (instead of a normal Note Event). There are two possible values for this column:
** '''<code>PC</code>''': '''Absolute''' parameter change. The specified parameter value is '''directly set''' on the first tick of the row.
** '''<code>PCs</code>''': '''Smooth (interpolated)''' parameter change. The specified parameter value is '''interpolated''' from the previous value to the current over the course of a whole row.
: If there is no key assigned to Parameter Control Events in your [[Manual: Setup/Keyboard|keyboard map]], you can double-click the note column to open the [[Manual: Note Properties#Note Tab|Note Properties window]] and change the note type to “PC” or “PCs”.
* The '''instrument''' column ('''<code>xx</code>''') contains the plugin ID, which can be obtained [[Manual: General#Plugin Setup|through the General tab]], [[Manual: Tree View#Song Folders|from the tree view]], or by right-clicking the pattern cell that holds the Parameter Control Event and choosing “Change Plugin”.
* The '''volume''' column ('''<code>yyy</code>''') contains the zero-based index of the parameter (in decimal notation) that should be controlled. This, too, can be obtained [[Manual: General#Factory Preset|from the General tab]], or by right-clicking the pattern cell that holds the Parameter Control Event and choosing “Change Plugin Parameter”.
* The '''effect''' column ('''<code>zzz</code>''') contains the parameter value (also in decimal notation). It ranges from <code>000</code> to <code>999</code>.

Deleting a Parameter Control Event can be accomplished by entering a different note into its note column, or by pressing the “Delete” shortcut key in same column.

Additionally, Parameter Control Events can be inserted into patterns automatically either by using the “Record Parameter Changes” option in the [[Manual: Plugin Window#Options|Plugin Window]] menu, or by setting up a [[Manual: MIDI Mapping|MIDI Mapping]].

=== Interpolate Effect ===
You can use the “Interpolate Effect” action on any column in a selection of Parameter Control Events. This will interpolate the parameter value (in the effect column) between the first and last event, replacing previous Parameter Control Event, filling in any blanks, and writing over note events.

[[Category:Manual|Parameter Control Events]]
[[Category:Plugins|Parameter Control Events]]
[[de:Param Control-Noten]]

Manual: Plugin Window

2020-05-30T22:25:20Z

Twomoso: grammar corrections

[[Image:Plugin Editor Standard.png|thumb|250px|Default Plugin Window]]

[[Image:Plugin Editor Custom.png|thumb|250px|Custom Plugin Window]]

Plugins can be controlled through their plugin window. Many plugins come with a custom user interface (GUI) which is merely supported by OpenMPT′s menu bar, but there is also a variety of plugins which do not bring their own GUI. In this case, OpenMPT provides a default GUI, shown in the first screenshot on the right, which allows for controlling all plugin parameters. Custom plugin GUIs often provide better access to parameters, because they can be grouped visually, but at the same time they can get very complex and bloated.

== Menus ==

=== File Menu ===

* '''Copy Preset''': Copies the current preset to the clipboard, so that it can be pasted into another instance of the same plugin.
* '''Paste Preset''': Pastes a preset from the clipboard.
* '''Load Preset / Bank''': This allows you to load a single preset (FXP files) or preset bank (FXB files).
* '''Save Preset / Bank''': This allows you to export the current preset / patch to a FXP file, or the complete bank to an FXB file.
* '''Create instrument from plugin''': This command creates an [[Manual: Instruments|instrument]] that is linked to this plugin.
* '''Randomize Parameters''': This command randomizes all plugin parameters by a user-provided amount.

=== Presets ===

If the plugin comes with a set of presets, you can choose one from this menu. Some plugins do not expose their presets to the host, in which case you can only change them from the plugin GUI or assigning a [[Manual: Instruments#Plugin / MIDI|MIDI program]].

=== Info ===

* In the '''Inputs''' sub menu, you can view all plugins that send their output to the current plugin′s input. Click any of the menu items to open the listed plugin′s editor. Additionally, all instruments which send sample and note data to this plugin are listed. If more than one instrument is assigned to the plugin, you can choose which instrument′s plugin settings should be used when triggering notes in the plugin editor by clicking the appropriate entry.
* Similarly, the '''Outputs''' sub menu shows which plugins receive the output of the current plugin.
* The '''Macros''' sub menu contains a list of all [[Manual: Zxx Macros#Parametered Macros|parametered Zxx macros]]. Macros that do not affect this plugin are greyed out, in contrast to macros that can be used to automate a parameter of this plugin. Currently unassigned macros are labeled with '''Learn Param'''. Plugin parameters can be assigned to such a macro by clicking its menu entry and then modifying the parameter in the plugin GUI — for example by clicking a knob, dragging a slider or whatever kinds of controls the plugin may offer.

=== Options ===

* '''Bypass Plugin''': This option excludes the plugin from the processing chain. No audio is routed through the plugin if the option is checked.
* '''Record Parameter Changes''': When changing a plugin parameter from the GUI, this change is written to the pattern using either Smooth MIDI Macros (\xx command in XM and IT tracks) or Parameter Control Events (in MPTM tracks). This is most useful when playing the module with the “Follow Song” option turned on.
* '''Record MIDI Out to Pattern Editor''': For plugins that output MIDI data, this option can be used to route this MIDI data to OpenMPT’s pattern, sample and instrument editor.
* '''Pass Keys to Plugin''': Some plugins need to process keyboard input, for example for entering a serial number or for typing in a preset name. Whenever this is necessary, you can enable this option to bypass OpenMPT′s keyboard handling.

=== Preset Switcher ===

If the plugin has any presets, the plugin switcher buttons can be used for quickly navigating between presets. Normal arrows dial the next or previous preset, while double arrows jump ten presets forward or backward.

Next to the switcher arrows, the current preset′s name is displayed. Clicking on it allows you to rename the preset. Note that not all plugins support this, and sometimes entering a new preset name has no effect.

== Miscellaneous ==

=== Note Preview ===
Instrument plugins can be previewed directly in the plugin editor using the same note keys as in the pattern, sample and instrument editors. The instrument notes are sounded as long as you hold the appropriate note key. Additionally, an external MIDI device can send MIDI events to a focussed plugin window if the appropriate option is enabled in the [[Manual: Setup/MIDI#Pass MIDI to Active Plugin|MIDI Setup]].

=== Controlling through external MIDI hardware ===
Plugin parameters may also be controlled by external MIDI hardware through [[Manual: MIDI Mapping|MIDI Mapping]]. The MIDI Mapping dialog can be opened automatically by pressing <kbd>Shift</kbd> while modifying a parameter on the plugin′s editor.

=== Minimizing Plugin Windows ===
If you want to keep a plugin window ready for editing but do not want to have the actual editor cluttering your screen, you can double-click the window’s title bar to minimize it to its title bar. Double-clicking it another time restores it to its full size.

[[Category:Manual|Plugin Window]]
[[Category:Windows|Plugin Window]]
[[Category:Plugins|Plugin Window]]

Manual: Plugin Manager

2020-05-30T22:17:48Z

Twomoso: add "Plugin Bridge" header (since there's quite a bit of plugin bridge information already present)

[[Image:Plugin Manager.png|thumb|300px|Plugin Manager window]]

The Plugin Manager dialog can be found from the [[Manual: Menus#View|View]] menu or a song′s [[Manual: General#General|General Tab]] and allows you to register new plugins with OpenMPT and load them into the current track. It lists all plugins in a folder list, where any folder can be opened and viewed by clicking on the + next to it. Effect plugins are shown with a speaker symbol next to them, while Instrument plugins show a keyboard symbol.
If you want to remove the current plugin assignment, select "No plugin" from the list.

* '''Plugin Filter''': Input a few letters to filter which plugins are shown. Only plugins whose name, vendor name or tags contain that character sequence are shown. Erase the contents of this field to show all plugins again. Several tags can be searched for at the same time by separating them with spaces.
* '''Plugin List''': Shows all plugins that have been loaded into OpenMPT. DirectX plugins that have been registered properly in Windows show up automatically in this list. Other plugins have to be added manually by using the "New Plugin" or "Scan Folder" button.
* '''Put in FX Slot''': Click on this button to load the selected plugin into the current plugin slot of the current module. When opening the Plugin Manager by a shortcut key or from the main menu, the slot number given will be the first available slot.
* '''Cancel''': Closes the window without adding or removing any plugins to the current module.

The '''Tags''' field can be used to enter arbitrary space-separated tags to facilitate finding your favourite plugins.

For managing the list of known plugins, the following options are available:
* '''New Plugin''': Opens a file picker so you can locate one or more plugins to load into OpenMPT’s list of known plugins. OpenMPT support plugins that follow the [https://en.wikipedia.org/wiki/Virtual_Studio_Technology Virtual Studio Technology] 1.x and 2.x standard (commonly abbreviated VST).
* '''Scan Folder''': Scans a complete folder (including sub folders) for new plugins.
* '''Remove''': Removes the selected plugin from the list of known plugins.

== Plugin Bridge ==

For plugins that do not run natively in OpenMPT (e.g. 32-bit plugins cannot run in a 64-bit instance of OpenMPT), a plugin bridge is provided. It is automatically used for plugins that require it, but can also be enabled manually. This is usually not necessary, but can be used with plugins that tend to crash OpenMPT. If they crash within the plugin bridge, they will only stop outputting sound, but OpenMPT itself will still work.

The Plugin Bridge may also be used to avoid an issue in Windows versions prior to Windows 10 version 1903, where in the worst case only up to 64 different plugins could be loaded at once; bridging some of the plugins bypasses this limitation.

It is recommended to only make use of this feature if required, though, as every bridged plugin adds latency, which can easily add up to an amount that makes low-latency audio processing impossible.

* '''Use Plugin Bridge''': If checked, the plugin is loaded into the plugin bridge instead of the main OpenMPT process. For plugins that cannot be loaded natively, this option is always enabled.
* '''Share Bridge between all Instances''': Some plugins (e.g. sidechain compressors such as SideKick) can only work if all of their instances are loaded into the same process. Enabling this option will load all instances of the selected plugin into the same bridge process. Otherwise, every instance is loaded into its own process. Sharing a bridge process can also speed up plugin loading, but if one plugin instance crashes, it may break all other instances of the same plugin, too.

[[Category:Manual|Plugin Manager]]
[[Category:Windows|Plugin Manager]]
[[Category:Plugins|Plugin Manager]]
[[de:Handbuch: Plugin Manager]]

Manual: Tempo Swing Settings

2020-05-30T22:06:28Z

Twomoso: grammar corrections / rephrasing; ("main advantage" bullet points) changes to tense

[[Image:Tempo Swing Settings.png|thumb|409px|Tempo Swing Settings dialog]]

Tempo Swing allows to change the duration of each individual row of a beat in [[Manual: Song Properties#Tempo Mode|modern tempo mode]]. Tempo Swing can be configured globally for the whole module (in the [[Manual: Song Properties#Tempo Mode|Song Properties]] dialog) or per pattern (in the [[Manual: Pattern Properties|Pattern Properties]] dialog).

Tempo Swing makes it easy to add swing (or shuffle) to a track without having to manually enter lots of tempo change commands or note delays in the pattern. The main advantages are:
* Independence of the current tempo and speed settings; Tempo Swing still works after a tempo change.
* The duration of all rows ''always'' adding up to the intended tempo.
* VST plugins receiving a steady tempo instead of constant tempo changes which sometimes confuse the internal delay lines of plugins.
* Always being synced to the start of a beat in the pattern.
* No need to fill patterns with tempo change commands which can be moved around accidentally, etc.
* Finer control than tempo change commands.

This dialog shows as many sliders as there are rows in a beat. The number of rows is configured in either the Song Properties (global) or Pattern Properties (per pattern) dialog. Move sliders to the right to extend the length of a row and to the left to shorten it.

Enabling the '''edit group''' will divide the sliders into two groups of the specified size. All sliders belonging to the same group are moved at once. So if the edit group size is set to 1, every other row is moved together, if it is 2, every other group of two sliders is moved, etc.

When editing the swing settings of a single pattern, the '''Use Global Settings''' button can be used to copy the global swing settings to this pattern.

[[Category:Manual|Tempo Swing Settings]]
[[Category:Windows|Tempo Swing Settings]]

Manual: Scale Envelope Points

2020-05-30T21:49:44Z

Twomoso: "Scale Points..." > "Scale Envelope Points..." (like OpenMPT); "are be multiplied" > "are multiplied", "in the first field in this" > "...of this"

[[Image:Scale Envelope Points.png|thumb|300px|Scale Envelope Points Dialog]]

[[Manual: Instruments|Instrument envelopes]] can be scaled both horizontally (x-axis) and vertically (y-axis) when choosing “Scale Envelope Points...” from their contextual menu.

On the x-axis, the envelope points are multiplied by the factor in the first field of this dialog window.
Entering 2, for example, will double the width of the envelope (shifting its points respectively), while 0.5 will halve it.

You can also increase or decrease the values of the envelope points by scaling the y-axis in the same way.
A factor of 2 will double the values (expanding the envelope up) and 0.5 will halve the values.
Due to their nature, the pan and pitch envelopes (the latter only when '''not''' being used as a filter envelope) have their x-axis centered; this means that entering values greater than 1 will increase the panning / pitch range of the envelope, values less than 1 will decrease it.

You may also use negative numbers for the y-axis scaling factor, which will flip the envelope vertically.

After scaling, a vertical offset may also be applied to the envelope. This shifts the scaled envelope up or down by the specified amount of envelope units.

[[Category:Manual|Scale Envelope Points]]
[[Category:Windows|Scale Envelope Points]]

Manual: Tuning Properties

2020-05-30T21:43:16Z

Twomoso: /* Tuning */ grammar corrections

[[Image:Tuning Properties.png|thumb|320px|Tuning Properties dialog]]

The Tuning Properties dialog is used to create and edit advanced [[Manual: Tunings|sample tunings]].

== Collection List ==

This is the big list on the left side of the window. It keeps all the tunings that you have imported into OpenMPT. There are two categories in this list:
* If you create a new tuning or import a single tuning, it will be added to the '''Tunings''' category. Tunings in this list can be used in your module.
* Loading legacy tuning collection files (.tc files) adds a new category for each tuning collection. Such imported tunings cannot be used in the module until you copy them to the '''Tunings''' directory by dragging them there with the mouse.

Tunings can be moved and copied between categories by dragging them to the wanted category. When releasing the mouse button, a popup menu is displayed from which you can choose the desired action — moving or copying the tuning.

Below the tuning list, the following buttons are found:
* '''New''': Adds a new tuning to the '''Tunings''' category.
* '''Load...''': Imports an OpenMPT tuning (.tun), OpenMPT tuning collection (.tc) or Scala scale file (.scl).
* '''Save As...''': Saves the selected tuning as an OpenMPT tuning (.tun) or Scala scale file (.scl).
* '''Remove''': Unloads the selected tuning.

== Tuning Types ==

Right-clicking the '''Tunings''' category or clicking the '''New''' buttons allows you to add a new tuning. The following tuning types exist:
* '''Group Geometric''' allows pitches to be independent within a group (octave). The pitch of notes outside the group size is determined by the '''Group Ratio''' factor.
* '''Geometric''' calculates by number of pitches in an “octave” (called a group size), and the pitch change in the “octave”. Using this method applies the equal temperament algorithm (based on an integer root of 2), but there is a lot less flexibility in naming notes.
* '''General''' is a tuning type with no enforced symmetry where all note pitches have to be entered manually. While the obvious disadvantage of this type is that you have to set the pitch for every note manually, this setting is especially useful for unpitched, strangely-pitched, or unusually-named notes, such as experimental tones or drum sets.

== Tuning ==

* '''Name''': Here, you can give your tuning a name that is shown in the tuning collection.
* '''Tuning Type''': Shows the selected [[#Tuning Types|Tuning Type]] of the current tuning. Once a tuning type has been chosen, it cannot be edited.
* '''Group Size''': The number of notes in this tuning's “octave” (which does not have to be an octave in the classic sense at all). You can enter a number in this field to define how many notes are in a note group (the Western European chromatic octave has 12 notes, the diatonic has 7, and the whole note scale has 6).
* '''Group Ratio''': The frequency multiplier between the base note and the note one “octave” higher. This value does not need to be an integer number. The default octave is 2.
* '''Finetune Steps''': The number of divisions that are between notes that will be used in portamento. In other words, the higher this setting, the higher the portamento value must be to bend the pitch by one note. The number of portamento finesteps needed to advance a step in the tuning is this value + 1, so the default of 15 + 1 = 16 finesteps needed. If this value is 0, finesteps equals note steps, which is the same as a glissando effect, using the pitches in the note list.
* '''Multiply all ratios by''': This allows the ratios of all notes to be multiplied by a constant factor. This is not available for Geometric tunings, where the first note of the middle octave always has a ratio of 1 and the other ratios are derived through the group size.

* '''Note List''': Shows all notes that can be played (C-0 to B-9) and the corresponding pitch ratio and cents. Clicking on any note centers the selection in the window, and shows the note attributes below the window, where the note name and ratio can be edited. For Geometric tunings, the ratios cannot be edited because they are derived through the group size.

[[Category:Manual|Tuning Properties]]
[[Category:Windows|Tuning Properties]]

Manual: Sample Tuner

2020-05-30T21:33:22Z

Twomoso: grammar corrections

[[Image:Sample Tuner.png|thumb|Sample Tuner dialog]]

The sample tuner can be used to tune melodic instrument samples to a given note. Applying the sample tuner to all melodic samples of the same module can help get rid of detuned samples.

== Considerations ==

In order to use the sample tuner successfully, it is important to know how it basically works:
* The whole sample (or a selection) is analysed using [https://en.wikipedia.org/wiki/Autocorrelation autocorrelation] to find its fundamental frequency. Thus, if you have a sample that consists of more than one distinct note in some way (e.g. a whole melody), you should reduce the sample selection to exactly one note for analysis — otherwise, the algorithm cannot decide properly which of the notes is the base note that should be considered for finding the fundamental frequency, as there will be several predominating frequencies.
* The sample tuner does no resampling - it merely changes the middle-C frequency of the sample.
* Finding the fundamental frequency may not work well if the sample frequency is too low. If the results are not satisfactory, increase the sample frequency and try again.

== Using the Sample Tuner ==

If the above instructions are considered, the sample tuner is easy to use: simply select a '''target note''' to which the sample should be tuned and a '''pitch reference'''. In most cases, you would not want to change the pitch reference, since many real-world instruments are already tuned to 440 Hz, but if you wish to use a different tuning, you can of course do so.

[[Category:Manual|Sample Tuner]]
[[Category:Windows|Sample Tuner]]

Manual: Time Stretch Calculator

2020-05-30T21:23:53Z

Twomoso: (Ratio bullet point) grammar correction / rephrase

[[Image:Time Stretch.png|thumb|312px|Time Stretch Calculator]]

The Time Stretch Calculator is used to modify the length of samples and can be accessed from the [[Manual: Samples|Sample Editor]]. The new length of the sample can be calculated in several ways:

* '''Sample Length''': Shows the original length of the sample in sample data points, and the new length which you can enter in its field.
* '''Time Length''': Shows the original length of the sample in milliseconds (when played at middle C), and the editable length.
* '''Tempo Settings''': You can fit the sample to play within a certain number of rows. For this, the target ticks per row (speed) and tempo must be known. By default, the current tempo settings are used, but they can be overridden here. The exact meaning of the speed and tempo values depends is determined by the song’s [[Manual:_Song_Properties#Tempo_Mode|Tempo Mode]].
* '''Playback Length''': Shows the original length of the sample in rows (based on the Speed and Tempo settings), and the new length which you can enter in its field.
* '''Ratio''': Shows the amount of lengthening in percent that will occur based on the given data above. This is updated when you change any of the previous settings, but you can enter your own value directly into the field.

[[Category:Manual|Time Stretch Calculator]]
[[Category:Windows|Time Stretch Calculator]]

Manual: Keyboard Split

2020-05-30T21:16:55Z

Twomoso: remove unneeded comma

[[Image:Keyboard Split Settings.png|thumb|316px|Keyboard Split Settings Dialog]]

You can apply a different instrument based on which note is entered into the Pattern Editor by “splitting the keyboard.”
To activate the split, set any of the parameters in this dialog to non-default settings.

Entering a note in the Pattern Editor that is '''below''' the split point will apply the alternate instrument, volume and transpose settings provided in this dialog. From the split point upwards, the main instrument is applied without any transposition or default volume commands.
Keep in mind that you may end up with two instruments in the same channel (unless you navigate to another channel), and may affect playback from the notes running into each other.

* '''Split Note''': If you input a note below this note (the split point), the alternate instrument will be entered instead of the current “main” instrument. Clicking on the note field opens a list of notes to choose from.
* '''Instrument''': If you choose an instrument from this list, it is applied when entering a note below the split point. By default, the main instrument is used.
* '''Volume''': If you choose a number from this list, a corresponding volume change command is entered with notes below the split point. You can use this setting to automatically add a volume command to all notes entered into the Pattern Editor by setting the Split Point to the highest possible value. This will actually apply the split settings, including volume, to all but the very highest note. If you do this, it is a good idea to not set an alternate instrument or apply transpose settings.

* '''Transpose''': If enabled, all notes entered below the split point are transposed up or down by the chosen amount. This is useful e.g. for keeping the split notes in the same range as the main instrument. For example, if the Split Point is C-5, set the transposition of the alternate instrument to “Octave +2”. Then when you press the keys for notes C-3 through B-4, they will be entered as C-5 through B-6 automatically.

The following example demonstrates which parts of the keyboard are assigned to which instrument if the split note is C-5:

[[Image:Keyboard Split Example.png]]

When working with two record groups, notes belonging to the default instrument are automatically written to the first record group and notes belonging to the alternative instrument are written to the second record group. This can be very useful for example when recording both a bass and a lead melody from an external MIDI keyboard simultaneously.

[[Category:Manual|Keyboard Split]]
[[Category:Windows|Keyboard Split]]

Manual: Amplify

2020-05-30T21:11:28Z

Twomoso: "Sample Display" > "Sample tab" (with Manual: Samples link)

[[Image:Amplify.png|right]]

The Amplify Dialog is used to amplify section of a pattern or a sample.

* '''Amplify Amount''': The percentage to amplify the selected data. When using this dialog from the [[Manual: Samples|Sample tab]], you can enter negative amounts, which will both invert the sample phase of the selection as well as perform the amplification.
* '''Fade Type''': Check one or both of the Fade Type boxes to have a ramped amplification enabled. When doing a Fade In, the amplification data is interpolated from the specified percentage to the amplified amount within the selection; Fade Out goes the opposite way.
* '''Fade Curve''': When applying a fade, one of these fade curves can be used to define the shape of the fade:

<gallery>
Image:FadeLinear.png|Linear
Image:FadeExp.png|Exponential
Image:FadeSqrt.png|Square Root
Image:FadeLog.png|Logarithmic
Image:FadeQuarterSine.png|Quarter Sine
Image:FadeHalfSine.png|Half Sine
</gallery>

[[Category:Manual|Amplify]]
[[Category:Windows|Amplify]]

Manual: Quick Channel Settings

2020-05-30T21:01:44Z

Twomoso: "is floating" > "floats"

[[Image:Quick Channel Settings.png|thumb|372px|Quick Channel Settings dialog]]

Middle-clicking or <kbd>Ctrl</kbd>-right-clicking a channel header (the boxes that hold the channel names and VU meters) in the [[Manual: Patterns|Pattern Editor]] brings up the quick channel setings, where a channel’s basic settings can be adjusted without having to go back to the [[Manual: General|General Tab]]. The dialog floats on top of the pattern editor and can be closed by clicking the pattern editor again.

* '''Channel Name''': The edit box at the top of the dialog is used to edit the channel name.
* '''Previous / Next Channel''': Next to the channel name are two arrow buttons for switching to the previous or next channel.
* '''Initial Volume''': Depending on the current module format’s capabilities, you can adjust the channel’s initial volume here and toggle the mute status.
* '''Initial Pan''': Depending on the current module format’s capabilities, you can adjust the channel’s initial panning position and surround status here.

The channel plugin assignment can be edited directly from the pattern editor and is thus not available from this dialog.

[[Category:Manual|Quick Channel Settings]]
[[Category:Windows|Quick Channel Settings]]

Manual: Chord Editor

2020-05-30T20:50:41Z

Twomoso: "to define to configure" > "to define"

[[Image:Chord Editor.png|thumb|300px|Chord Manager window]]

The Chord Editor is used to define the preset chords that can be entered into the [[Manual: Patterns|Pattern Editor]] by holding the chord modifier key.

* '''Shortcut Key''': The note that, when input, will trigger the chord input. The displayed octave is relative to the base octave; i.e. C-0 is the lowest octave on your keyboard, and pressing this note together with the chord modifier key (<kbd>Shift</kbd> by default) will enter the notes from the following fields.
* '''Base Note''': The base note of the chord; however, it doesn’t have to be the lowest note of the chord. There are two possible modes for the base note:
** '''Relative''': The base note is taken as the note in the pattern position where the chord is entered. All notes in the chord are relative to that note. If the pattern cell is empty, the previous base note is used instead.
** '''Note''': Any other base note value uses the chosen note as the base note and adds the base octave.
* '''Notes 1 – 3''': The alternate notes that will be input in the other channels being recorded into.
* '''Chord Diagram''': The piano keyboard representation of the chord, with a light red dot indicating the base note and the bright red dots indicating the remaining notes belonging to the chord. You can drag the dots around to change existing notes, or click on an empty key to add another note to the chord (up to 4 at a time). To remove a note from the chord, click on the red dot so it is deleted (not possible for the base note).

[[Category:Manual|Chord Editor]]
[[Category:Windows|Chord Editor]]
[[de:Handbuch: Chord Editor]]

Manual: Pattern Properties

2020-05-30T01:07:58Z

Twomoso: /* Time Signature */ "modern tempo mode" > "Modern tempo mode"

[[Image:Pattern Properties.png|thumb|327px|Pattern Properties dialog]]

The Pattern Properties dialog can be opened from the [[Manual: Patterns|Pattern Editor]], e.g. by clicking the question mark icon in the [[Manual: Patterns#Toolbar|toolbar]] or by clicking the pattern number in the upper-left corner of the pattern display (''#0'' or similar). It is not available for MOD and S3M files, as the pattern length is fixed in those formats.

== Pattern Size ==

To change the number of rows in the pattern, either type the number into the text field, or click on the menu arrow to choose from a list.
Pattern lengths from 1 to 1024 rows are supported.
To quickly halve or double the number of rows, click on the “/2” or “x2” buttons.
If you are reducing the number of rows, and there is event data in the rows that are being deleted, you will be alerted that this data will be lost, and you can back out if necessary.

== Time Signature ==

For MPTM tracks, you can enable per-pattern Time Signatures by setting the “Override” checkbox.
Then enter the Rows per Beat and Rows per Measure values that you want to apply to this pattern only.

In Modern tempo mode, the duration of the rows contributing to a beat can be configured by clicking the '''Configure Swing''' button, which will open the [[Manual: Tempo Swing Settings|Tempo Swing Settings]] dialog. This way, swinging rhythms can be created automatically without the help of pattern commands.

At the bottom is a reminder of the pattern you are modifying, the current number of rows, and the amount of memory it consumes.

[[Category:Manual|Pattern Properties]]
[[Category:Windows|Pattern Properties]]

Manual: Clipboard Manager

2020-05-30T01:03:14Z

Twomoso: use <kbd> tags for "Enter" and "ESC" key references; "ESC" > "Escape"

[[Image:Clipboard Manager.png|thumb|287px|Clipboard Manager dialog]]

The Clipboard Manager is used to configure and switch between OpenMPT’s internal pattern clipboards. You can set any number of internal clipboards using the edit box at the bottom of the dialog and switch between clipboards by clicking an entry in the clipboard list.

Copying pattern data or order selections in the [[Manual: Patterns|Pattern Editor]] places them in the current internal clipboard and in the operating system’s text clipboard.
When pasting, OpenMPT always reads the system clipboard first, and if it could not find any pattern data in it, it falls back to reading the current internal clipboard. Switching to another internal clipboard copies its contents into the system clipboard.

Double-click a clipboard to change its name; use the <kbd>Enter</kbd> key to confirm, or <kbd>Escape</kbd> to abort.

It is also possible to cycle through the internal clipboard using keyboard shortcuts without having to open the Clipboard Manager. By default, these are <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Left</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Right</kbd>.

[[Category:Manual|Clipboard Manager]]
[[Category:Windows|Clipboard Manager]]

Manual: Channel Manager

2020-05-30T01:00:16Z

Twomoso: grammar corrections; (introduction) "don't" > "do not"

The Channel Manager allows you to configure some attributes of all channels at once. You can Mute / Unmute, toggle Record Select, toggle a channel’s plugin assignments, or reorder or remove channels.

There are two states a channel in this window can be in — selected and / or enabled. Selecting a channel will turn its button white, while de-selecting it will turn it back to grey. Enabling a channel will change the colour of the status light (on the left side of each channel’s button), but the meaning of each colour depends on the attribute you are changing. Note that channel selection is independent of channel enabling.

There are different ways to activate functions in each window, but here are the things that are common to all of them:

* <kbd>Control</kbd> '''+ Left-click''' on a channel button selects the channel.
* <kbd>Control</kbd> '''+ Right-click''' on a channel button de-selects the channel.
* '''Select All''': Selects all of the channels at once.
* '''Invert Selection''': Selects all channels not currently selected, while de-selecting those that are. To select all but one channel, select the channel you do not want, then click on Invert Selection.
* '''Store''': Remembers the selection state and the enabled state of each channel in a temporary memory. Each page has its own memory, so you can store the settings for each channel, for each page.
* '''Restore''': Reverts the channel settings from memory to their previous states when they were last stored (except in the Reorder / Remove page, which enables all channels and returns them to their previous positions, since the last Apply).
* '''Middle-click''': Renames a channel, if supported by the current format.

The rest of the options differ between pages and are described below:

=== Solo/Mute Channels ===

In this page you can quickly mute and unmute many channels at once. You can also designate one or more channels as a Solo channel, which mutes all other channels.

A solo channel is indicated by a green icon, and muted channels by a red icon. A normal unmuted channel′s icon has the same colour as the window′s background.

[[Image:Channel Manager Solo Mute.png|thumb|350px|Solo/Mute Channels]]

* '''Left-click''': Sets the clicked channel to Solo, which mutes all other channels.
* '''Right-click''': Toggles the Mute status of the clicked channel.
* '''Solo''': Toggles the selected channels between Solo, which enables the Mute of all other channels, and Unmuted.
* '''Mute''': Toggles the Mute status of the selected channels.

=== Record Select ===

In this page you can set up which channels should be used for live recording. There are two record groups which can be used independently for entering notes into. If the edit cursor is in either group, it will stay in channels designated to this group while entering notes. If the edit cursor is in neither group, it will stay on the same channel while entering notes. A channel can only be part of one record group at a time.

[[Image:Channel Manager Record Select.png|thumb|350px|Record Select]]

* '''Left-click''': Toggles assignment to the first record group. A green icon indicates that the channel is assigned to this record group.
* '''Right-click''': Toggles assignment to the second record group. A red icon indicates that the channel is assigned to this record group.
* '''Instrument 1''': Assigns all selected channels to the first record group, or removes them from the record group if they previously were all part of the first record group.
* '''Instrument 2''': Likewise, this assigns all selected channels to the second record group, or removes them from the record group if they previously were all part of the second record group.

=== FX/Plugins ===

In this page you can enable or disable the audio processing of each channel’s assigned plugins (if any). Channels with enabled plugins are marked with a green icon, “dry” channels use a red icon. Note that instrument plugins are not affected by this setting.

[[Image:Channel Manager Plugins.png|thumb|350px|Plugin Processing]]

* '''Left-click''': Enables plugin processing on this channel.
* '''Right-click''': Disables plugin processing on this channel.
* '''Enable FX''': Enables all selected channels’ plugins.
* '''Disable FX''': Disables all selected channels’ plugins.

=== Reorder/Remove ===

The effects of this page are unalterable, so use with care. Here you can alternate channel positions, moving them around by clicking and dragging, as described below. At the same time, you can also remove channels.

A green icon indicates that the channel will be kept, and a red icon means that a channel will be removed if '''Apply''' is hit.

[[Image:Channel Manager Reorder.png|thumb|350px|Reorder / Remove]]

* '''Left-click''': “Grabs” the selected channel’s button(s) so you can move it to a new location. Drag the selection to another channel, release the mouse button, and the selected button will be placed '''before''' the chosen channel.
* '''Right-click''': Toggles the designation for the channel’s removal. When a channel is enabled, it will remain after removal is applied. When it is disabled, it will be prepared for deletion. If you close the Channel Manager without applying, the channels’ deletion order will be reset and nothing will be applied.
* '''Remove''': Designates the selected channels for removal.
* '''Cancel All''': Restores the positions and removal state of all channels.
* '''Apply''': Reorders the positions of the channels in the track, and removes all disabled channels from the track and compacts the channels.

[[Category:Manual|Channel Manager]]
[[Category:Windows|Channel Manager]]
[[de:Handbuch: Channel Manager]]

Template:Main Page/Welcome

2020-05-30T00:27:36Z

Twomoso: fix inconsistent tense ("share new tutorials, or help improving the manual" > "...or help improve the manual")

This wiki is the source for the official OpenMPT manual and provides a comprehensive overview of the software. You can use this wiki to share new tutorials, or help improve the manual by working on the [[Special:WhatLinksHere/Template:Todo|list of articles]] that have passages that still need some work.

User:Twomoso

2020-05-29T23:11:02Z

Twomoso: testing done. please disregard previous edits (please!!)

User:Twomoso

2020-05-29T23:01:13Z

Twomoso: /* bad header 2 */ does it work /* bad header 3 */ like this??

= bad header 1 =

* abcdefg
* hijklmn
* opqrstu
* vwxyz

== bad header 2 ==

ZYX, WVU, TSR, QPO, NML, KJI, HGF, EDC, BA,

=== bad header 3 ===

α-bet

= This header's okay i guess =

'''a'''
:bcde
'''b'''
:aaaa

User:Twomoso

2020-05-29T22:57:53Z

Twomoso: /* bad header 1 */

= bad header 1 =

* abcdefg
* hijklmn
* opqrstu
* vwxyz

== bad header 2 ==

ZYX WVU TSR QPO NML KJI HGF EDC BA

=== bad header 3 ===

alphabet

= This header's okay i guess =

'''a'''
:bcde
'''b'''
:aaaa

User:Twomoso

2020-05-29T22:56:46Z

Twomoso: Created page with "= bad header 1 = abcdefg hijklmn opqrstu vwxyz == bad header 2 == ZYX WVU TSR QPO NML KJI HGF EDC BA === bad header 3 === alphabet = This header's okay i guess = '''a''..."

= bad header 1 =

abcdefg hijklmn opqrstu vwxyz

== bad header 2 ==

ZYX WVU TSR QPO NML KJI HGF EDC BA

=== bad header 3 ===

alphabet

= This header's okay i guess =

'''a'''
:bcde
'''b'''
:aaaa

Manual: Clipboard Manager

2020-05-29T01:54:13Z

Twomoso:

[[Image:Clipboard Manager.png|thumb|287px|Clipboard Manager dialog]]

The Clipboard Manager is used to configure and switch between OpenMPT’s internal pattern clipboards. You can set any number of internal clipboards using the edit box at the bottom of the dialog and switch between clipboards by clicking an entry in the clipboard list.

Copying pattern data or order selections in the [[Manual: Patterns|Pattern Editor]] places them in the current internal clipboard and in the operating system’s text clipboard.
When pasting, OpenMPT always reads the system clipboard first, and if it could not find any pattern data in it, it falls back to reading the current internal clipboard. Switching to another internal clipboard copies its contents into the system clipboard.

Double-click a clipboard to change its name; use the Enter key to confirm, or ESC to abort.

It is also possible to cycle through the internal clipboard using keyboard shortcuts without having to open the Clipboard Manager. By default, these are <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Left</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Right</kbd>.

[[Category:Manual|Clipboard Manager]]
[[Category:Windows|Clipboard Manager]]

Manual: Cleanup Manager

2020-05-29T01:41:44Z

Twomoso: (introduction) rephrase "Help Tips" sentence; (all) rewrite sections to describe all options, like other menu pages (most descriptions from OpenMPT's tooltips)

The Cleanup Manager, reachable via the '''Edit''' menu, allows you to strip away or rearrange various aspects of your track. The interface is self explanatory, and when you move your mouse cursor over a checkbox, a tooltip describes what it does. No cleanup is done until the OK button is clicked. Keep in mind that not all cleanup actions can be undone, so it is advisable to save your track before applying cleanup.

[[File:Cleanup_Manager.png|450px|thumb|right|Cleanup Manager window with default setup]]

== Patterns ==

* '''Remove unused''': Remove all unused patterns and rearrange them.
* '''Remove all''': Remove all patterns.
* '''Rearrange''': Number the patterns given by their order in the sequence.
* '''Remove duplicates''': Merge patterns with identical content.

== Orders / Sequences ==

* '''Merge sequences''': Merge multiple sequences into one. This helps when exporting or converting from one track format to another (especially from MPTM).
* '''Remove all orders''': Reset the order list.

== Samples ==

* '''Remove unused''': Remove all unused samples.
* '''Remove all''': Remove all samples.
* '''Rearrange''': Reorder sample list by removing empty samples.
* '''Remove unused sample data''': Remove unused data after the sample loop end.

“Remove unused sample data” can optimize samples in two ways:
* Trim samples so that data after their sample loops is deleted (in all circumstances, audio after sample loops is never reached during playback).
* Convert stereo samples to mono if they are found to only contain mono data.

== Instruments ==

* '''Remove unused''': Remove all unused instruments.
* '''Remove all (convert to samples)''': Remove all instruments and convert them to samples.

== Plugins ==

* '''Remove unused''': Remove all unused plugins.
* '''Remove all''': Remove all plugins.

== Miscellaneous ==

* '''Reset all variables''': Convert the module to IT and reset song / sample / instrument variables. This is useful for re-using samples from another song in a new track, for example when creating a sample pack for a competition (see the Presets section below).
* '''Remove unused channels''': Removes all empty pattern channels.

== Presets ==

Clicking on a preset button will automatically configure the checkboxes for a certain use-case. With any preset you can still enable or disable any of the checkboxes.

* '''Remove all unused stuff''': Remove all unused patterns, samples, instruments, plugins, and channels. Patterns will also be rearranged, and duplicate patterns merged. Unused sample data will be trimmed. The configuration set by this preset is also the default for the Cleanup Manager dialog.
* '''Create samplepack''': Remove all patterns, orders, instruments, plugins, and unused channels, while keeping and rearranging all the samples. The “Reset all variables” checkbox from the Miscellaneous section is also enabled.

[[Category:Manual|Cleanup Manager]]
[[Category:Windows|Cleanup Manager]]
[[de:Handbuch: Cleanup-Dialog]]

Manual: MIDI Mapping

2020-05-29T00:36:31Z

Twomoso: (Current Mapping) replace colon with period

[[Image:MIDI Mapping.png|thumb|330px|MIDI Mapping Dialog]]

MIDI Mapping allows you to map certain incoming MIDI messages to plugin parameter changes. This can be useful in a live setup, where a MIDI controller can be used to directly tweak plugin parameters, or simply to directly record parameter changes to the pattern editor.

You can open this dialog from the [[Manual: Menus#View|View menu]] or use the “Learn” mode by pressing <kbd>Shift</kbd> while modifying a parameter in an active plugin GUI. The modified plugin and plugin parameter are then automatically filled into the appropriate fields.

MIDI Mapping settings are saved in modules, so they do not have to be re-entered when loading a previously edited module.

== Current Mapping ==

This is the currently edited MIDI Mapping.

* '''MIDI Learn''': When this box is checked, OpenMPT will listen for incoming MIDI events and fill in '''Channel''', '''Event''' and '''Controller''' values automatically.
* '''Active''': Checking this box enables this MIDI Mapping.
* '''Capture''': Checking this box prevents the MIDI message from being transmitted to other MIDI Mappings listening to the same MIDI event or even other parts of the program such as any open plugin editors or the pattern editor, where the controller change may be written down as a MIDI Macro command.
* '''Pattern Record''': Checking this box will enter the parameter change into the Pattern as a [[Manual: Parameter Control Events|Parameter Control Event]], so it is only available in MPTM tracks.
* '''Channel''': The MIDI Channel (1 – 16) OpenMPT will listen on to capture this event. When choosing '''Any''', it will listen on all MIDI channels for this event.
* '''Event''': The type of event OpenMPT should listen for. MIDI Control Changes (also known as MIDI CCs) and aftertouch events are currently supported.
* '''Controller''': The MIDI CC message that OpenMPT will listen for to control the plugin parameter. Clicking on the field shows a list of MIDI CC messages from which you can choose.
* '''Plugin''': The plugin that will be controlled by this event. Clicking on the field will open a list of the loaded plugins.
* '''Parameter''': Here you can assign the plugin’s parameter you wish to control with the MIDI CC event. Clicking on the field shows a popup menu where you can choose the parameter to control.
* '''Add Event''': Clicking on this button adds the event settings above to the MIDI Mapping list.
* '''Replace Event''': Clicking on this button replaces the currently selected MIDI Mapping in the list with the event settings provided above.
* '''Remove Event''': Clicking on this button removes the currently selected entry from the MIDI Mapping list.

== MIDI Mapping List ==

The MIDI Mapping list shows all available MIDI Mappings. You can use the '''Up''' and '''Down''' buttons to rearrange MIDI Mappings that cover the same MIDI event. The order of such MIDI Mappings may be crucial since the '''Capture''' setting can prevent an incoming MIDI event being redirected to subsequent MIDI Mappings.
You may enable and disable any MIDI Mapping directly from this list by toggling its check box.

[[Category:Manual|MIDI Mapping]]
[[Category:Windows|MIDI Mapping]]
[[Category:Plugins|MIDI Mapping]]
[[Category:MIDI|MIDI Mapping]]
[[de:Handbuch: MIDI Mapping]]

Manual: Macro Configuration

2020-05-29T00:30:14Z

Twomoso: grammar corrections

[[Image:Zxx Macro Configuration.png|thumb|300px|Zxx Macro Configuration Dialog]]

The Zxx Macro Configuration dialog is used to set up [[Manual: Zxx Macros|Zxx Macros]].

== Macro Syntax ==

Macros are parametered MIDI messages. They may contain uppercase '''constants''' and lowercase '''variables:

=== Constants ===

* The letters '''A''' through '''F''' and digits '''0''' through '''9''' are constants. They are transferred as 4-bit values (also called nibbles).

=== General Variables ===

* The letter '''n''' is substituted by the last triggered note on the same channel as the macro is called.
* The letter '''c''' is substituted by the 4-bit wide MIDI channel number that can be found in the [[Manual: Instruments|instrument settings]].
* Parametered macros (Z00 through Z7F) may also contain the letter '''z''', which is substituted by the 7-bit wide Zxx parameter (00h through 7Fh).
* The letter '''h''' is substituted by the number of the tracker channel on which the macro was triggered.
* The letter '''o''' is substituted by the parameter of the last Set Offset (<code>Oxx</code>) effect.
* The letter '''m''' is substituted by the current play direction of the sample playing on this channel (forward: 0, backward: 1).
* The letter '''s''' is substituted by the Roland SysEx checksum of the current SysEx block.

=== Volume / Velocity Variables ===

* The letter '''v''' is substituted by the current note velocity, including volume slides and such.
* The letter '''u''' is substituted by the current computed velocity, which also includes the volume envelope.

=== Panning Variables ===

* The letter '''x''' is substituted by the current note panning.
* The letter '''y''' is substituted by the current computed panning, which also includes the panning envelope.

=== MIDI Program Change Variables ===

* The letter '''a''' is substituted by the high 7 bits of the MIDI bank number that can be found in the [[Manual: Instruments|instrument settings]].
* The letter '''b''' is substituted by the low 7 bits of the MIDI bank number that can be found in the instrument settings.
* The letter '''p''' is substituted by the MIDI program number that can be found in the instrument settings.

The '''Macro Help''' button shows a quick reference which explains all possible characters.

“Internal” macro messages start with the character combination F0F0 or F0F1 (which is in fact an invalid SysEx message) and are always four bytes (or eight nibbles) long. They are used to control the resonant sample filters and plugin settings. All other MIDI messages are “external” and are directly sent to plugins.

A macro may consist of several internal and external messages and may be up to 31 characters long, so it is for example possible to control filter cutoff and resonance at once in a single macro.

== Parametered Macros ==

'''Current Macros''': A list of the 16 [[Manual: Zxx Macros#Parametered Macros|parametered macros]]. Click on the '''SF0''' through '''SFF''' buttons to change the settings for one of them, or select a macro from the '''Modify macro''' dropdown list. A '''Show All''' button is shown next to all macros that control plugin parameters. Clicking this button shows a list of plugins which can be controlled by this macro.

Only one parametered macro can be active on a pattern channel at a time. To select the active macro, use pattern effects <code>SF0</code> through <code>SFF</code> to activate the respective macro for future usage with <code>Zxx</code> or <code>\xx</code> commands.

You may choose a pre-configured macro type from the '''Type''' dropdown list:
* '''Unused''': This macro does nothing.
* '''Set Filter Cutoff''': Sets the cutoff frequency of the resonant filter. Z00 represents the lowest cutoff frequency, Z7F the highest.
* '''Set Filter Resonance''': Sets the resonance amount of the resonant filter. Z00 means no resonance, Z7F is full resonance.
* '''Set Filter Mode''': Z00 activates the lowpass filter, Z10 activates the highpass filter.
* '''Plugin Dry/Wet Ratio''': Controls the Dry/Wet Ratio of the currently active plugin on the channel the Zxx command occurs in. Z00 means 0% Wet / 100% Dry, Z7F 100% Wet / 0% Dry. Note that channel plugins are prioritised over instrument plugins if both are present on a channel (this is also true for the following macro types).
* '''Control Plugin Param''': For plugin parameter control, you must also specify a parameter that shall be controlled. For this, choose a plugin from the dropdown list below and a parameter from the dropdown list next to that. Note that macros are not bound to a single plugin; they are applied to whatever plugin is active on the channel the Zxx or \xx command is encountered. This effectively means that the plugin dropdown list does not change the macro itself — it is only there to help you pick the correct parameter for the macro. It also means that one and the same macro can control the same parameter of several plugins. For example, the macro F0F08Fz may control parameter 15 of any loaded plugin. Plugin parameter macros may also be assigned from the [[Manual: Plugin Window#Info|plugin window]].
* '''MIDI CC''': Sends a MIDI Control Change to the active plugin. The actual MIDI CC can be chosen from the dropdown list below.
* '''Channel Aftertouch''': Sends a channel aftertouch message to the active plugin.
* '''Polyphonic Aftertouch''': Sends a polyphonic aftertouch message to the active plugin. The last note (the “n” character in the macro) triggered on the same channel as the MIDI Macro is automatically embedded into the MIDI message.
* '''Pitch Bend''': Sends a pitch bend message to the active plugin. The lower 7 bits of the pitch bend message are always zero.
* '''Custom''': Allows you to enter a custom macro.

The '''Value''' edit field shows the actual macro. You can enter a custom macro here, but it must follow the macro syntax described above. Custom macros are for example useful for sending raw MIDI events to plugins.

== Fixed Macros ==

Here you can configure the 128 [[Manual: Zxx Macros#Fixed Macros|fixed macros]]. From the '''Preset''' list, you may choose one of the following presets:
* '''Unused''': All fixed macros do nothing.
* '''Z80-Z8F controls Resonance (default)''': Sets the resonance amount of the resonant filter. Z80 means no resonance, Z8F is full resonance.
* '''Z80-ZFF controls Resonance''': Same as above, but with increased granularity. Z80 means no resonance, ZFF is full resonance.
* '''Z80-ZFF controls Cutoff''': Sets the cutoff frequency of the resonant filter. This is identical to the first default parametered macro, so it is pointless to use both in the same track.
* '''Z80-ZFF controls Filter Mode''': Toggles the filter mode of the resonant filter. Z80 activates the lowpass filter, Z90 activates the highpass filter.
* '''Z80-Z9F controls Resonance + Filter Mode''': Z80 through Z8F set the resonance of the resonant filter (like the first preset), Z90 activates the lowpass filter, Z92 activates the highpass filter.
* '''Z80-ZFF controls Channel Aftertouch''': Sends a channel aftertouch message to the active plugin.
* '''Z80-ZFF controls Polyphonic Aftertouch''': Sends a polyphonic aftertouch message to the active plugin. The last note (the “n” character in the macro) triggered on the same channel as the MIDI Macro is automatically embedded into the MIDI message.
* '''Z80-ZFF controls Pitch Bend''': Sends a pitch bend message to the active plugin. The lower 7 bits of the pitch bend message are always zero.
* '''Custom''': This “preset” is shown if you customize any of the 128 fixed macros. For example, you may copy any of the parametered macro presets to a fixed macro and replace the '''z''' character by two constants (A-F) or any of the other available variables.

Choose a macro from the '''Customize''' dropdown list to edit any of the fixed macros.

== Default Configuration ==

OpenMPT’s default macro configuration is as follows:
* The first parametered macro controls cutoff.
* All other parametered macros do nothing.
* Fixed macros Z80 through Z8F control resonance, Z90 through ZFF do nothing.

This can be overridden by a default user macro configuration, which is used for all newly created tracks.
If you happen to use a certain combination of parametered and fixed macros in many tracks, you can click the '''Set as default''' button to automatically load this macro configuration for all newly created tracks. It is explicitly '''not''' used for tracks which do not have macro information embedded.

Note that template modules provide a more sophisticated way of managing default macro configurations than using the '''Set as default''' button, so an empty template module should be preferred over this setting.

[[Category:Manual|Macro Configuration]]
[[Category:Windows|Macro Configuration]]
[[Category:MIDI|Macro Configuration]]
[[de:Handbuch: Macro Configuration]]

Manual: Song Properties

2020-05-29T00:16:17Z

Twomoso: (Mix Levels table) make capitalization in non-header cells sentence case

[[Image:Song Properties.png|thumb|300px|Song Properties window]]

The attributes found in this page are very fundamental to the track, and none of them can be changed during playback using effect commands. On the contrary, some of these settings even affect how certain effect commands work. The track type you use dictates which properties can be enabled. For new tracks, you can set anything available, but when you load a module, you almost never want to change these attributes unless you are trying to update the module or make it available in another format.

== Track Type ==

Shows the current track format. Clicking on this field will open a popup menu where you can choose to convert the track to another format. However, in doing so, you may lose features when converting between formats that are too different from each other.

=== Channels ===

Shows the number of pattern channels that are used in this track. Clicking on the field will open a popup menu where you can choose the number of channels. Keep in mind that using [[Manual: Saving and exporting#Compatibility Export|Compatibility Export]] may further limit the amount of available channels.

== Playback Flags ==

=== Linear Frequency Slides ===

On older trackers, frequency slides always slid the same amount of “periods” (an unit that is inverse to frequency). As the note scale is logarithmic, this means in practice that sliding by a given amount of periods becomes less “effective” in the lowest octave (i.e. it will not change the note as much) than in the higher octaves. Linear slides avoid this problem - slide parameters are defined by 1⁄64th note units, so the same slide parameter will always slide the same amount of notes instead of the same amount of frequency. It is recommended to leave this setting enabled for new songs; changing it for existing songs can destroy note slides in those songs. Note that the MOD and S3M format never make use of linear slides.

=== Fast Volume Slides ===

Applicable only when loading S3M tracks, checking this box will apply volume slides on every tick (as opposed to every non-row tick), which was the default behaviour in Scream Tracker 3.0. Normally you should not need to change this setting as it will modify note slide behaviour.

=== Extended Filter Range ===

Normally the Cutoff frequency range is from 130 Hz to about 5 kHz. Checking this box allows for the instrument filtering range to be doubled, to a range of 130 Hz to about 10 kHz.

=== IT Old Effects ===

When this checkbox is enabled, some effects commands (Vibrato, Tremor, Tremolo, Offset) are played like older versions of Impulse Tracker (and other trackers) would play them. Even if "old" might sound bad, you should not change this setting for existing tracks as some effects might play differently.

=== Compatible Gxx ===

Normally Portamento commands in IT tracks (Exx, Fxx, and Gxx) share their memory; that is, the last value used by one of them will be used by another if calling a 00 value. If you check this box, Gxx memory is '''not''' shared in IT tracks (but you must also set the IT Compatibility flag, described below). This behaviour is more consistent with other trackers like Fasttracker 2, where tone portamento (3xx) and note slides (1xx and 2xx) do not share memory as well. Another notable difference is that any envelopes are reset when using Gxx next to a note + instrument combo (like in the XM format) and that the effect of a previous Key-Off note is nullified when Compatible Gxx is enabled.

=== ProTracker 1/2 mode ===
For MODs created with ProTracker 1 and 2, you might need to check this box for proper playback. Most of the settings in this mode are specific to modules created with ProTracker. Further MOD-specific quirks can be enabled and disabled in the [[#Compatibility Settings|Compatibility Settings]] below. OpenMPT automatically tries to detect if it should enable ProTracker 1/2 mode when loading MOD files.

The following “Amiga-only” limitations and other quirks are applied in ProTracker 1/2 mode:
* Instrument changes are always applied on the first tick, even if the note is delayed.
* Tremolo and vibrato are not applied on the first tick of a row.
* Notes that fall outside of the standard range (C-4 to B-6) will be coloured red to warn you that these notes cannot be played on a real Amiga, and they will also be corrected to the Amiga's frequency range.
* Arpeggios are “wrapped around” if they exceed the Amiga note range — that is, if you play e.g. a B-6 with an arpeggio effect, the arpeggiated notes are wrapped around to octave 4.
* The quirky behaviour of the 9xx command known from ProTracker 1/2 is emulated in this mode.

=== Amiga Frequency Limits ===
Only available in S3M and MOD files, this setting ensures that notes cannot exceed the Amiga frequency range. All notes are clamped to the Amiga’s three-octave range. Note slides can also not exceed this range. It is not recommended to enable this option in S3M files, as it just exists for backwards compatibility with old files that require it to be enabled.
In MOD files, it can be enabled separately from ProTracker 1/2 mode to enforce the Amiga note range without emulating other ProTracker quirks. Amiga Frequency Limits are enabled automatically when loading 4 channel MOD files whose pattern note range does not exceed the Amiga note range.

== Mix Levels ==

Mix Levels dictate the volume ratio between samples and VST plugins. Most importantly, the mix levels determine how samples are amplified before they are being sent through a plugin. By default, the best mix levels for the current file are chosen when creating a new song. Some legacy mix level settings may only be available when opening an existing module which makes use of them.

Here is an overview with all the differences. The latest mix level modes are on the right.

{| class="wikitable"
|-
! !! '''Original (MPT 1.16)''' !! '''OpenMPT 1.17RC1''' !! '''OpenMPT 1.17RC2''' !! '''OpenMPT 1.17RC3''' !! '''Compatible'''
|-
| '''[[Manual: Setup/Mixer#Soft Panning|Soft Panning]]''' || User-defined in setup || User-defined in setup || User-defined in setup || Forced on || Forced off †
|-
| '''[[Manual: Setup/Mixer#Pre-Amp|Sample Pre-Amp]] || User-defined in setup || User-defined in setup || User-defined in setup || Fixed (no attenuation) || Fixed (half volume)
|-
| '''Global Volume''' || Applied to samples || Applied to samples || Applied to master || Applied to master || Applied to master
|-
| '''Sample Volume''' || Halved before being sent to plugins Doubled when sending back || Divided by 16 before being sent to plugins Multiplied by 16 when sending back || Correct levels (no multiplication) || Correct levels || Correct levels
|}

As the sample volume is reduced before samples are being sent to the plugin in the two oldest mix modes (1.16 and 1.17RC1), plugins do not receive the correct levels of the samples. To compensate for this, the plugin’s output is multiplied to normal gain again. As VST instruments have no input, this effectively means that VST instruments are twice as loud as intended when using the oldest mix mode, and sixteen times as loud when using the OpenMPT 1.17RC1 mix mode. Hence, '''do not use them'''. When working with plugins, use the latest (OpenMPT 1.17RC3) mix mode.

When applying global volume to samples rather than to the master output, the output of VST plugins is not affected by global volume, which is usually not the wanted behaviour.

The '''Compatible Mix Level''' settings are automatically used when playing MOD and S3M tracks, and should always be used when writing IT and XM tracks. The sample mix levels are identical those of Schism Tracker in this mode, meaning that (almost) identical audio levels can be guaranteed across several trackers.
When using plugins, it is recommended to not use compatible mix levels, as the exact pre-amplification may change to increase compatibility with other trackers. Use OpenMPT’s mix levels when working with plugins in the MPTM format.

† When using '''Compatible''' levels, the Linear Pan Law is being used. '''Compatible (FT2 Pan Law)''' makes use of the Square Root Pan Law instead, which is the pan law that Fasttracker 2 uses. This option is only available for XM files. The Square Root Pan Law emphasises samples played in the center, while samples played more on the left and right are slightly attenuated.

== Compatibility Settings ==

OpenMPT supports many module playback quirks to emulate a wide range of OpenMPT versions and other trackers. This is to retain compatibility with as many trackers as possible, so that any module will sound as good as possible.

The '''Set Defaults''' button allows you to automatically use the recommended compatibility settings for IT and XM modules. Using it may be necessary when upgrading from an old OpenMPT version. More information about this can be found in the chapter on [[Manual: Compatible Playback|Compatible Playback]].

Click '''Edit Compatibility Settings''' button to edit the compatibility details. This button opens the [[Manual: Compatible Playback#Playback Compatibility Settings|Playback Compatibility Settings]] dialog.

== Tempo Mode ==

In the Tempo group, the '''Mode''' drop down box lets you choose the ''tempo mode'': Classic, Alternative, or Modern. Each tempo mode has different advantages and is further explained below. Before comparing the tempo modes, it is helpful to understand the following points.

* The exact meaning of the Tempo value depends on the tempo mode, but increasing the Tempo will always result in a faster note playback speed, and decreasing the Tempo will always produce a slower note playback speed. There are two ways you can change the Tempo.

:*To set the initial Tempo: in the [[Manual: General#Tempo /Restart|General tab]], use the “Initial tempo” slider or box.
:*To change the Tempo in the middle of a song: in the pattern editor, go to the desired pattern and row and insert a “Set Tempo” [[Manual: Effect Reference|effect]] (for IT: Txx; for XM: Fxx, where xx is 20 to FF).

* The smallest unit you can use for creating notes is a row. When any other value affects the row duration, notes will play faster or slower.

* The smallest unit the player uses is a tick, a subdivision of a row.

* In OpenMPT, “Speed” means “ticks per row”. Changing the Speed affects the number of instrument envelope ticks that are processed per row and the behavior of many pattern effects. In some tempo modes, changing the Speed also affects the note playback speed. There are two ways you can change the Speed.

:*To set the initial Speed: in the General tab, use the box labeled “Ticks/Row”.
:*To change the Speed in the middle of a song: in the pattern editor, go to the desired pattern and row and insert a “Set Speed” effect (for IT: Axx; for XM: Fxx, where xx is 01 to 1F).

=== Overview ===

In the Classic and Alternative tempo modes, values are built up from ticks to rows to beats. In the Modern tempo mode, values are subdivided from beats to rows to ticks.

When a value affects the rows per minute or the row duration, notes will play faster or slower. In the table below, the bold and highlighted items emphasize this.

{| class="wikitable" style="width: 77em;" 
|-
!style="width: 9.2em;"| Tempo mode
!style="width: 23.9em;"| Classic
!style="width: 22.3em;"| Alternative
!style="width: 21.6em;"| Modern
|-
|colspan="4"|
|- align="center" valign="center"
! Main advantage
| Compatible with other players
| Before Modern tempo mode was available, let you increase Speed or Rows per Beat further
| Easy to understand tempo value, always precise
|-
|colspan="4"|
|- align="center" valign="center"
! Tempo unit
| 24 ticks per minute
| 60 ticks per minute (ticks per second)
| beats per minute
|-
|colspan="4"|
|-
! Ticks per minute 
| Tempo × 24
| Tempo × 60
| Tempo × Rows per Beat × Speed
|-
! Rows per minute
| '''Tempo''' × 24 / '''Speed'''
| '''Tempo''' × 60 / '''Speed'''
| '''Tempo''' × '''Rows per Beat'''
|-
! Beats per minute
| Tempo × 24 / Speed / Rows per Beat
| Tempo × 60 / Speed / Rows per Beat
| Tempo
|-
|colspan="4"|
|-
! Tick duration
| 2.5 seconds / Tempo
| 1 second / Tempo
| 60 seconds / Tempo / Rows per Beat / Speed 
|-
! Row duration
| (2.5 seconds / '''Tempo''') × '''Speed'''
| (1 second / '''Tempo''') × '''Speed'''
| 60 seconds / '''Tempo''' / '''Rows per Beat'''
|-
! Beat duration
| (2.5 seconds / Tempo) × Speed × Rows per Beat 
| (1 second / Tempo) × Speed × Rows per Beat
| 60 seconds / Tempo
|-
|colspan="4"|
|- align="center" valign="center"
! If you decrease or increase Tempo...
|style="background: #FFD;"| notes play slower or faster 
|style="background: #FFD;"| notes play slower or faster
|style="background: #FFD;"| notes play slower or faster
|- align="center" valign="center"
! If you decrease or increase Speed...
|style="background: #FFD;"| notes play faster or slower 
|style="background: #FFD;"| notes play faster or slower
| note play speed doesn’t change
|- align="center" valign="center"
! If you decrease or increase Rows per Beat...
| note play speed doesn’t change
| note play speed doesn’t change
|style="background: #FFD;"| notes play slower or faster 
|}

=== Classic Tempo Mode ===

This mode uses the classic definition of speed and tempo that is compatible with many other trackers. It is always used in legacy formats (MOD, S3M, XM, IT).

For performance reasons, most older trackers were implemented with very little to no floating point arithmetic. Some rounding errors when calculating the number of samples that should constitute a buffer of a given duration mean that tempos could be inexact. For this reason, tempo may also differ between various playback rates, e.g. playback might be slightly slower at 48 kHz than at 44 kHz. In OpenMPT, the Classic tempo mode preserves this “old-school” behaviour.

=== Alternative Tempo Mode ===

This was thought as a slightly easier to understand variant of the Classic Tempo Mode devised by Ericus for the mathematically minded. The ratio between ''tempo x'' and ''speed y'' can be memorized easily as “''x'' rows will last ''y'' seconds.” The same rounding error restrictions as in Classic tempo mode apply.

=== Modern Tempo Mode ===

This tempo mode compensates for the rounding errors described above, so the real BPM always corresponds to the exact value you specify. Thus, tempo is always identical at all playback rates. This is the most intuitive mode for new users and closest to other modern music software packages. It is recommended to use this mode in MPTM tracks.

To make use of temporarily increased (or decreased) tracking precision (while staying at the same tempo) in this tempo mode, you will have to change the Rows per Beat of a specific pattern, so this is only possible in the MPTM format.

== Time Signature ==

In the Tempo group, the '''Rows per beat''' and '''Rows per measure''' values are used to highlight appropriate rows in the pattern editor and to calculate the time signature that is sent to plugins and written to stream export metadata and exported MIDI files. In MPTM modules, patterns can also have a custom time signature which overrides this global time signature. It can be changed in the [[Manual: Pattern Properties|Pattern Properties]] dialog.

In Modern tempo mode, the duration of the rows contributing to a beat can be configured by clicking the '''Configure Swing''' button, which will open the [[Manual: Tempo Swing Settings|Tempo Swing Settings]] dialog. This way, swinging rhythms can be created automatically without the help of pattern commands.

== Version Info ==

Shows which software was used to create and save the current track.

[[Category:Manual|Song Properties]]
[[Category:Windows|Song Properties]]
[[de:Handbuch: Song Properties]]

Manual: Song Properties

2020-05-29T00:09:48Z

Twomoso: grammar corrections; (Tempo Mode, Overview) replace HTML tags with equivalent MediaWiki syntax

[[Image:Song Properties.png|thumb|300px|Song Properties window]]

The attributes found in this page are very fundamental to the track, and none of them can be changed during playback using effect commands. On the contrary, some of these settings even affect how certain effect commands work. The track type you use dictates which properties can be enabled. For new tracks, you can set anything available, but when you load a module, you almost never want to change these attributes unless you are trying to update the module or make it available in another format.

== Track Type ==

Shows the current track format. Clicking on this field will open a popup menu where you can choose to convert the track to another format. However, in doing so, you may lose features when converting between formats that are too different from each other.

=== Channels ===

Shows the number of pattern channels that are used in this track. Clicking on the field will open a popup menu where you can choose the number of channels. Keep in mind that using [[Manual: Saving and exporting#Compatibility Export|Compatibility Export]] may further limit the amount of available channels.

== Playback Flags ==

=== Linear Frequency Slides ===

On older trackers, frequency slides always slid the same amount of “periods” (an unit that is inverse to frequency). As the note scale is logarithmic, this means in practice that sliding by a given amount of periods becomes less “effective” in the lowest octave (i.e. it will not change the note as much) than in the higher octaves. Linear slides avoid this problem - slide parameters are defined by 1⁄64th note units, so the same slide parameter will always slide the same amount of notes instead of the same amount of frequency. It is recommended to leave this setting enabled for new songs; changing it for existing songs can destroy note slides in those songs. Note that the MOD and S3M format never make use of linear slides.

=== Fast Volume Slides ===

Applicable only when loading S3M tracks, checking this box will apply volume slides on every tick (as opposed to every non-row tick), which was the default behaviour in Scream Tracker 3.0. Normally you should not need to change this setting as it will modify note slide behaviour.

=== Extended Filter Range ===

Normally the Cutoff frequency range is from 130 Hz to about 5 kHz. Checking this box allows for the instrument filtering range to be doubled, to a range of 130 Hz to about 10 kHz.

=== IT Old Effects ===

When this checkbox is enabled, some effects commands (Vibrato, Tremor, Tremolo, Offset) are played like older versions of Impulse Tracker (and other trackers) would play them. Even if "old" might sound bad, you should not change this setting for existing tracks as some effects might play differently.

=== Compatible Gxx ===

Normally Portamento commands in IT tracks (Exx, Fxx, and Gxx) share their memory; that is, the last value used by one of them will be used by another if calling a 00 value. If you check this box, Gxx memory is '''not''' shared in IT tracks (but you must also set the IT Compatibility flag, described below). This behaviour is more consistent with other trackers like Fasttracker 2, where tone portamento (3xx) and note slides (1xx and 2xx) do not share memory as well. Another notable difference is that any envelopes are reset when using Gxx next to a note + instrument combo (like in the XM format) and that the effect of a previous Key-Off note is nullified when Compatible Gxx is enabled.

=== ProTracker 1/2 mode ===
For MODs created with ProTracker 1 and 2, you might need to check this box for proper playback. Most of the settings in this mode are specific to modules created with ProTracker. Further MOD-specific quirks can be enabled and disabled in the [[#Compatibility Settings|Compatibility Settings]] below. OpenMPT automatically tries to detect if it should enable ProTracker 1/2 mode when loading MOD files.

The following “Amiga-only” limitations and other quirks are applied in ProTracker 1/2 mode:
* Instrument changes are always applied on the first tick, even if the note is delayed.
* Tremolo and vibrato are not applied on the first tick of a row.
* Notes that fall outside of the standard range (C-4 to B-6) will be coloured red to warn you that these notes cannot be played on a real Amiga, and they will also be corrected to the Amiga's frequency range.
* Arpeggios are “wrapped around” if they exceed the Amiga note range — that is, if you play e.g. a B-6 with an arpeggio effect, the arpeggiated notes are wrapped around to octave 4.
* The quirky behaviour of the 9xx command known from ProTracker 1/2 is emulated in this mode.

=== Amiga Frequency Limits ===
Only available in S3M and MOD files, this setting ensures that notes cannot exceed the Amiga frequency range. All notes are clamped to the Amiga’s three-octave range. Note slides can also not exceed this range. It is not recommended to enable this option in S3M files, as it just exists for backwards compatibility with old files that require it to be enabled.
In MOD files, it can be enabled separately from ProTracker 1/2 mode to enforce the Amiga note range without emulating other ProTracker quirks. Amiga Frequency Limits are enabled automatically when loading 4 channel MOD files whose pattern note range does not exceed the Amiga note range.

== Mix Levels ==

Mix Levels dictate the volume ratio between samples and VST plugins. Most importantly, the mix levels determine how samples are amplified before they are being sent through a plugin. By default, the best mix levels for the current file are chosen when creating a new song. Some legacy mix level settings may only be available when opening an existing module which makes use of them.

Here is an overview with all the differences. The latest mix level modes are on the right.

{| class="wikitable"
|-
! !! '''Original (MPT 1.16)''' !! '''OpenMPT 1.17RC1''' !! '''OpenMPT 1.17RC2''' !! '''OpenMPT 1.17RC3''' !! '''Compatible'''
|-
| '''[[Manual: Setup/Mixer#Soft Panning|Soft Panning]]''' || User-Defined in Setup || User-Defined in Setup || User-Defined in Setup || Forced On || Forced Off †
|-
| '''[[Manual: Setup/Mixer#Pre-Amp|Sample Pre-Amp]] || User-Defined in Setup || User-Defined in Setup || User-Defined in Setup || Fixed (No Attenuation) || Fixed (Half Volume)
|-
| '''Global Volume''' || Applied to Samples || Applied to Samples || Applied to Master || Applied to Master || Applied to Master
|-
| '''Sample Volume''' || Halved before being sent to plugins Doubled when sending back || Divided by 16 before being sent to plugins Multiplied by 16 when sending back || Correct levels (no multiplication) || Correct levels || Correct levels
|}

As the sample volume is reduced before samples are being sent to the plugin in the two oldest mix modes (1.16 and 1.17RC1), plugins do not receive the correct levels of the samples. To compensate for this, the plugin’s output is multiplied to normal gain again. As VST instruments have no input, this effectively means that VST instruments are twice as loud as intended when using the oldest mix mode, and sixteen times as loud when using the OpenMPT 1.17RC1 mix mode. Hence, '''do not use them'''. When working with plugins, use the latest (OpenMPT 1.17RC3) mix mode.

When applying global volume to samples rather than to the master output, the output of VST plugins is not affected by global volume, which is usually not the wanted behaviour.

The '''Compatible Mix Level''' settings are automatically used when playing MOD and S3M tracks, and should always be used when writing IT and XM tracks. The sample mix levels are identical those of Schism Tracker in this mode, meaning that (almost) identical audio levels can be guaranteed across several trackers.
When using plugins, it is recommended to not use compatible mix levels, as the exact pre-amplification may change to increase compatibility with other trackers. Use OpenMPT’s mix levels when working with plugins in the MPTM format.

† When using '''Compatible''' levels, the Linear Pan Law is being used. '''Compatible (FT2 Pan Law)''' makes use of the Square Root Pan Law instead, which is the pan law that Fasttracker 2 uses. This option is only available for XM files. The Square Root Pan Law emphasises samples played in the center, while samples played more on the left and right are slightly attenuated.

== Compatibility Settings ==

OpenMPT supports many module playback quirks to emulate a wide range of OpenMPT versions and other trackers. This is to retain compatibility with as many trackers as possible, so that any module will sound as good as possible.

The '''Set Defaults''' button allows you to automatically use the recommended compatibility settings for IT and XM modules. Using it may be necessary when upgrading from an old OpenMPT version. More information about this can be found in the chapter on [[Manual: Compatible Playback|Compatible Playback]].

Click '''Edit Compatibility Settings''' button to edit the compatibility details. This button opens the [[Manual: Compatible Playback#Playback Compatibility Settings|Playback Compatibility Settings]] dialog.

== Tempo Mode ==

In the Tempo group, the '''Mode''' drop down box lets you choose the ''tempo mode'': Classic, Alternative, or Modern. Each tempo mode has different advantages and is further explained below. Before comparing the tempo modes, it is helpful to understand the following points.

* The exact meaning of the Tempo value depends on the tempo mode, but increasing the Tempo will always result in a faster note playback speed, and decreasing the Tempo will always produce a slower note playback speed. There are two ways you can change the Tempo.

:*To set the initial Tempo: in the [[Manual: General#Tempo /Restart|General tab]], use the “Initial tempo” slider or box.
:*To change the Tempo in the middle of a song: in the pattern editor, go to the desired pattern and row and insert a “Set Tempo” [[Manual: Effect Reference|effect]] (for IT: Txx; for XM: Fxx, where xx is 20 to FF).

* The smallest unit you can use for creating notes is a row. When any other value affects the row duration, notes will play faster or slower.

* The smallest unit the player uses is a tick, a subdivision of a row.

* In OpenMPT, “Speed” means “ticks per row”. Changing the Speed affects the number of instrument envelope ticks that are processed per row and the behavior of many pattern effects. In some tempo modes, changing the Speed also affects the note playback speed. There are two ways you can change the Speed.

:*To set the initial Speed: in the General tab, use the box labeled “Ticks/Row”.
:*To change the Speed in the middle of a song: in the pattern editor, go to the desired pattern and row and insert a “Set Speed” effect (for IT: Axx; for XM: Fxx, where xx is 01 to 1F).

=== Overview ===

In the Classic and Alternative tempo modes, values are built up from ticks to rows to beats. In the Modern tempo mode, values are subdivided from beats to rows to ticks.

When a value affects the rows per minute or the row duration, notes will play faster or slower. In the table below, the bold and highlighted items emphasize this.

{| class="wikitable" style="width: 77em;" 
|-
!style="width: 9.2em;"| Tempo mode
!style="width: 23.9em;"| Classic
!style="width: 22.3em;"| Alternative
!style="width: 21.6em;"| Modern
|-
|colspan="4"|
|- align="center" valign="center"
! Main advantage
| Compatible with other players
| Before Modern tempo mode was available, let you increase Speed or Rows per Beat further
| Easy to understand tempo value, always precise
|-
|colspan="4"|
|- align="center" valign="center"
! Tempo unit
| 24 ticks per minute
| 60 ticks per minute (ticks per second)
| beats per minute
|-
|colspan="4"|
|-
! Ticks per minute 
| Tempo × 24
| Tempo × 60
| Tempo × Rows per Beat × Speed
|-
! Rows per minute
| '''Tempo''' × 24 / '''Speed'''
| '''Tempo''' × 60 / '''Speed'''
| '''Tempo''' × '''Rows per Beat'''
|-
! Beats per minute
| Tempo × 24 / Speed / Rows per Beat
| Tempo × 60 / Speed / Rows per Beat
| Tempo
|-
|colspan="4"|
|-
! Tick duration
| 2.5 seconds / Tempo
| 1 second / Tempo
| 60 seconds / Tempo / Rows per Beat / Speed 
|-
! Row duration
| (2.5 seconds / '''Tempo''') × '''Speed'''
| (1 second / '''Tempo''') × '''Speed'''
| 60 seconds / '''Tempo''' / '''Rows per Beat'''
|-
! Beat duration
| (2.5 seconds / Tempo) × Speed × Rows per Beat 
| (1 second / Tempo) × Speed × Rows per Beat
| 60 seconds / Tempo
|-
|colspan="4"|
|- align="center" valign="center"
! If you decrease or increase Tempo...
|style="background: #FFD;"| notes play slower or faster 
|style="background: #FFD;"| notes play slower or faster
|style="background: #FFD;"| notes play slower or faster
|- align="center" valign="center"
! If you decrease or increase Speed...
|style="background: #FFD;"| notes play faster or slower 
|style="background: #FFD;"| notes play faster or slower
| note play speed doesn’t change
|- align="center" valign="center"
! If you decrease or increase Rows per Beat...
| note play speed doesn’t change
| note play speed doesn’t change
|style="background: #FFD;"| notes play slower or faster 
|}

=== Classic Tempo Mode ===

This mode uses the classic definition of speed and tempo that is compatible with many other trackers. It is always used in legacy formats (MOD, S3M, XM, IT).

For performance reasons, most older trackers were implemented with very little to no floating point arithmetic. Some rounding errors when calculating the number of samples that should constitute a buffer of a given duration mean that tempos could be inexact. For this reason, tempo may also differ between various playback rates, e.g. playback might be slightly slower at 48 kHz than at 44 kHz. In OpenMPT, the Classic tempo mode preserves this “old-school” behaviour.

=== Alternative Tempo Mode ===

This was thought as a slightly easier to understand variant of the Classic Tempo Mode devised by Ericus for the mathematically minded. The ratio between ''tempo x'' and ''speed y'' can be memorized easily as “''x'' rows will last ''y'' seconds.” The same rounding error restrictions as in Classic tempo mode apply.

=== Modern Tempo Mode ===

This tempo mode compensates for the rounding errors described above, so the real BPM always corresponds to the exact value you specify. Thus, tempo is always identical at all playback rates. This is the most intuitive mode for new users and closest to other modern music software packages. It is recommended to use this mode in MPTM tracks.

To make use of temporarily increased (or decreased) tracking precision (while staying at the same tempo) in this tempo mode, you will have to change the Rows per Beat of a specific pattern, so this is only possible in the MPTM format.

== Time Signature ==

In the Tempo group, the '''Rows per beat''' and '''Rows per measure''' values are used to highlight appropriate rows in the pattern editor and to calculate the time signature that is sent to plugins and written to stream export metadata and exported MIDI files. In MPTM modules, patterns can also have a custom time signature which overrides this global time signature. It can be changed in the [[Manual: Pattern Properties|Pattern Properties]] dialog.

In Modern tempo mode, the duration of the rows contributing to a beat can be configured by clicking the '''Configure Swing''' button, which will open the [[Manual: Tempo Swing Settings|Tempo Swing Settings]] dialog. This way, swinging rhythms can be created automatically without the help of pattern commands.

== Version Info ==

Shows which software was used to create and save the current track.

[[Category:Manual|Song Properties]]
[[Category:Windows|Song Properties]]
[[de:Handbuch: Song Properties]]

Manual: Display Features

2020-05-27T21:09:15Z

Twomoso: grammar corrections, some rephrasing; "ModPlug" > "OpenMPT"; change tiling method names to match OpenMPT

== Multiview ==
While you can not move the tabs to their own position, you can get a more complete look at your track with Multiview.

In the next graphic, three different tabs of the same track are visible at the same time.

[[Image:Multi View.png|550px]]

To view more than one tab at once, open a song and select “New Window” from the Window menu. This opens an auxiliary window of the current track, which you can reposition and resize inside OpenMPT’s window. From here you can choose one tab such as the General page in one window, and another tab such as the Pattern page in the other window. You can even open a window for each and every tab using the same method. To autoposition the windows, you can choose one of the functions in the Window menu — “Cascade”, “Tile Horizontal”, or “Tile Vertical”.

At the time of writing, there is one important limitation, though: only one window can currently receive position updates. If for example a pattern view is focussed, the Sample and Instrument pages will not get any position updates and thus cannot update their position marks.

[[Category:Manual|Display Features]]

Manual: Instruments

2020-05-27T20:43:51Z

Twomoso: (Sample Quality) remove WFIR type and cutoff factor reference

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

Instruments are an additional “layer” above samples that is available in some module formats supported by OpenMPT. An instrument can hold one or several samples that are assigned to different keys. This is also called '''multisampling'''. It can be used to create easy-to-use realistic sounding instruments (for example, you can assign a different piano sample to every note for a rather realistic reproduction of a piano) or drum sets (like the General MIDI drum set, where every note represents a different percussion instrument). Instruments also hold volume, panning and pitch / filter [[#Envelope Editor|envelopes]] which can be used to further modify the sound of those samples.

Instruments can also be used to control instrument plugins. You can assign a combination of MIDI channel and MIDI programs of an instrument plugin to a module instrument for easy usage.

By default, IT and MPTM files are created in “sample mode”, which means that instrument properties cannot be accessed. If you wish to use “instrument mode” instead, simply click the '''New Instrument''' button in the toolbar to convert all samples to instruments. After doing so, every sample is represented by an instrument.

In instrument mode, lone samples that are not assigned to an instrument cannot be accessed in a pattern; to be able to access them, they have to be assigned to an instrument using the [[#Sample Map|Sample Map]].

== Toolbar ==

[[Image:Instrument File Toolbar.png]]

* '''New Instrument''': Creates a new instrument and associates it with a free sample slot. <kbd>Shift</kbd>-clicking this button or choosing the dropdown menu duplicates the current instrument.
* '''Load Instrument''': Loads one or more instruments in one of the following formats: ITI (Impulse Tracker instruments), XI (Fasttracker 2 instruments), SFZ ([[Manual: SFZ Implementation|SFZ instruments]]), PAT (Gravis UltraSound patches) or any of the supported [[Manual: Samples#File Toolbar|sample formats]]. You can load multiple instruments at the same time, which are then loaded into multiple instrument slots. It is also possible to load the first instrument from a DLS, SBK or SF2 soundfont.
* '''Save Instrument''': Saves the current instrument in the ITI, XI or SFZ 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 %instrument_number%, %instrument_filename% and %instrument_name%.
* '''Preview Instrument''': Plays a C-5 note of the current instrument. Clicking the button again fades out the playing note and releases all sustain loops.

Next to the toolbar buttons are a spin button for dialling up a different instrument, the internal instrument name and the internal instrument file name.

== Volume and Panning ==

* '''Global Volume''': The overall attenuation of all samples assigned to this instrument. At a global volume of 64, no attenuation is done, at 32 the samples are half as loud, etc. For instrument plugins, global volume works the same way as the default volume of samples, i.e. it sets the note velocity and can be overridden by a volume command next to a note.
* '''Fade Out''': Determines how fast samples will fade out if the end of the volume is reached, a note fade command is triggered in the pattern or the New Note Action “Note Fade” is used. The higher the value, the faster the samples are faded out. To compute how many ticks the fade out will last, divide 32768 by this value.
* '''Pan''': The default pan position of this instrument. This setting overrides channel panning, but can be overridden by panning commands and sample panning.

== Pitch / Pan Separation ==

Using Pitch / Pan Separation, you can spread out samples in the stereo space, depending on the note that is played.

* '''Separation''': Determines how much the distance of a note from the Pitch / Pan Centre affects the panning. The higher the value, the more the notes are spread out in the stereo spectrum. A negative value can be used to invert the effect, i.e. higher notes will be placed more on the left rather than the right.
* '''Centre''': Defines the note at which the panning is not modified. Notes higher than the centre note will be panned to the right (left with negative separation amount) and notes lower than the centre note will be panned to the left (right with negative separation amount).

== Sample Quality ==

These settings are exclusive to the MPTM format.

* '''Ramping''': Specifies the amount of Ramp-In that is done at the start of the instrument samples in microseconds. A higher value will reduce the sharpness of the samples’ attack. If '''default''' is chosen, the Ramp-In amount from the [[Manual: Setup/Mixer#Volume Ramping|Mixer Setup]] is used.
* '''Resampling''': Defines the resampling algorithm used for playing the instrument samples. The algorithms are identical to those found in the [[Manual: Setup/Mixer#Resampling|Mixer Setup]].

== Filter ==

These settings can be used to setup the resonant filter that can be applied to samples (but not plugins).

* '''Resonance''': Sets the resonance amount of the filter (sometimes called the “Q factor”). The higher the resonance, the more the cutoff frequency is “stressed”.
* '''Cutoff Frequency''': Defines the frequency at which the filter starts to damp frequencies. If a lowpass filter is used, that means that frequencies above this point are damped, with a highpass filter the frequencies below are reduced.
* '''Filter Mode''': Sets the type of filter to be used with this instrument. If '''Channel Default''' is used, the previous filter setting of the pattern channel the instrument is used on is re-used. By default, all channels are set to use the lowpass filter, but the filter type can be changed by [[Manual: Zxx Macros#Resonant Filter Control|MIDI Macros]] or preceding instruments on the same channel. This setting is exclusive to the MPTM format.

If no default resonance or cutoff is specified, the filter values from previous notes on the same channel are reused by default. This can be avoided by setting the resonance to minimum and cutoff to maximum, which disables the filter completely.

== Random Variation ==

Random Variation can be used to add a bit of randomness (or “humanisation”) to the instrument playback.

* '''Volume Swing''': A random percentage is subtracted from or added to the sample’s global volume or plugin’s note velocity. The slider can be used to adjust the maximum percentage.
* '''Pan Swing''': The sample is panned to the left or right by a random amount.
* '''Cutoff Swing''': The resonant filter’s cutoff frequency is changed by a random amount. This setting is exclusive to the MPTM format.
* '''Resonance Swing''': The resonant filter’s resonance amount is changed by a random amount. This setting is exclusive to the MPTM format.

== New Note Action ==

By default, only one note can be played on a channel at a time. Using '''New Note Actions''' (or NNAs for short), it is possible to move playing notes to background channels instead when triggering a new note, so that they can be faded out or continue to run indefinitely. New Note Actions are a great way to save pattern channels that would otherwise be used just fading out playing notes. Furthermore, '''Duplicate Note Actions''' (or DNAs for short) can be used to handle playing notes of the same instrument, sample or plugin separately.

* '''New Note Action''': Determines what is done with the playing note:
** '''Note Cut''': The old note is instantly cut off and replaced by the new note (default behaviour).
** '''Continue''': The old note is moved to a background channel. This is mostly useful with short one-shot samples such as percussion instruments. Pay attention when using this option together with looped samples; they will loop indefinitely until you trigger one of the “Past Note” [[Manual: Effect Reference#Effect Column 4|effects]] (S70, S71 or S72).
** '''Note Off''': Sample and envelope sustain loops of the old note are released.
** '''Note Fade''': The old note is faded out. If the '''Fade Out''' value is 0, this is practically identical to the '''Continue''' option, so the same precautions apply.
* '''Duplicate Note Check''': Defines the type of event for which the '''Duplicate Note Action''' is applied:
** '''Disabled''': By default, the Duplicate Note Action is not executed.
** '''Note''': If the previously playing note on that channel is the same as the newly triggered note, the Duplicate Note Action is executed.
** '''Sample''': If the previously playing sample on that channel is the same as the newly triggered sample, the Duplicate Note Action is executed.
** '''Instrument''': If the previously playing instrument on that channel is the same as the newly triggered instrument, the Duplicate Note Action is executed.
** '''Plugin''': If the newly triggered note is played by the same instrument plugin as the previously playing note, the Duplicate Note Action is executed.
* '''Duplicate Note Action''': If the Duplicate Note Check condition is fulfilled, one of the Duplicate Note Actions is executed. They are identical to the '''New Note Actions'''.

== Plugin / MIDI ==

In the plugin section, you can assign an effect or instrument plugin to the instrument. Effect plugins can be used to modify the sound of the instrument’s samples, instrument plugins on the other hand are a sound generator by themselves, i.e. you do not need to assign samples to an instrument that is already assigned to an instrument plugin.

* '''Plugin''': In this dropdown list, you can select to which plugin the sample audio is routed or which instrument plugin is triggered.
* The '''Editor''' button toggles the visibility of the plugin’s [[Manual: Plugin Window|editor]]. <kbd>Shift</kbd>-clicking the button closes all other open plugin editors.
* '''MIDI Channel''': Configures the MIDI channel on which notes triggered in the pattern are sent to the assigned plugin. This is '''essential''' for instrument plugins — if you do not specify a MIDI channel, you will not hear any sound coming out of your plugin. You can either set the MIDI channel to one of the 16 standard MIDI channels, or choose '''Mapped''' to choose a MIDI channel based on the pattern channel in which the note is triggered. In that case, the MIDI channel is the pattern channel modulo 16, so if a note is triggered on pattern channel 1 (2, 3, 4,… 16), it will be sent to the instrument plugin on MIDI channel 1 (2, 3, 4,… 16); If a note is triggered on pattern channel 17, it will be sent to the instrument plugin MIDI channel 1 again.
* '''MIDI Program''': Here you can specify a MIDI program that should be sent to instrument plugins. This is especially useful when working with multitimbral plugins, so you can have different sounds on different (or even the same) MIDI channels. By default, no MIDI program change is sent to the plugin.
* '''MIDI Bank''': Same as above, but specifies the MIDI bank of the MIDI program. By default, no MIDI bank change is sent to the plugin.

For instrument plugins, further options are available:

* '''Pitch Bend Range''': For portamento and vibrato commands to work with instrument plugins, OpenMPT must know the Pitch Wheel Depth for which the plugin has been configured on the selected MIDI channel. Since there is no standardized way to configure the bend range of a plugin or external MIDI gear, you have to tell OpenMPT to which bend range the plugin is configured. If you set up this value correctly, portamento and vibrato commands sent to plugins should sound identical to their sample counterparts.
** Please note that not all plugins offer the same pitch bend granularity and may still produce pitch bends that differ slightly from sample portamento. This cannot be fixed by OpenMPT, but it should only be audible when trying to slide exactly to a specific note.
** Negative range values may also be entered to compensate for a negative Pitch Wheel Depth (so that Portamento Up commands will still slide upwards).
** Pitch bends affect all notes on the same MIDI channel. In most monotimbral instrument plugins, they affect all notes, no matter which MIDI channel they are played on.
* '''Volume Command Handling''': Determines how volume commands without notes (or all volume commands, if the checkbox below is not ticked) are handled:
** '''None''': Volume commands are not sent to plugins.
** '''MIDI Volume''': Volume commands are sent as MIDI Volume (MIDI CC #7) commands. This affects all playing notes on the same plugin MIDI channel. Not all plugins handle MIDI Volume.
** '''Dry/Wet Ratio''': Volume commands alter the plugin’s Dry/Wet ratio. This affects all playing notes of the plugin.
* '''Volume commands with notes are Velocities''': Determines how volume commands next to notes (velocity) are handled; If the checkbox is ticked, such volume commands are only treated as MIDI Note-On velocity (default behaviour). If it is not ticked, volume commands next to notes are handled just like other volume commands (see previous option). In this case, the instrument’s '''Global Volume''' is used as the MIDI Note-On velocity instead.

The last two options are always disabled if the [[Manual: Compatible Playback#Common compatibility settings|Plugin Volume MIDI CC Bug emulation]] compatibility setting is enabled.

== Tuning ==

In the MPTM format, you can select a custom [[Manual: Tunings|tuning]] for the samples that are assigned to this plugin. Choosing '''Control Tunings''' from the dropdown list will open the [[Manual: Tuning Properties|Tuning Properties window]].

== Pitch / Tempo Lock ==

With this setting, you can specify at which tempo the sample loops correctly. This can be useful e.g. when using drum loops of which you know the exact beats per minute. If the Pitch / Tempo Lock is enabled, changing the song tempo will automatically slow down or speed up the samples assigned to this instrument. The entered tempo may be fractional (e.g. 136.46 BPM).

Holding the <kbd>Shift</kbd> key while clicking the check box will enable or disable the feature for all instruments at once.

== Sample Map ==

The Sample Map holds the sample assignments for every note. From left to right you see which note of the instrument (the note is triggered in the pattern) corresponds to which note (the note that is actually heard) of which sample.

The middle column (sample note) is especially useful when creating drum sets, as you will not have to adjust the C-5 frequency of each of the assigned samples then: Simply map all notes to C-5 and you are done. Note that this column is not available in the XM format, where you can only configure the sample assignments. To change a value, enter a note like you would enter it in the pattern editor and use the number keys to modify its octave.

In the sample column, you can type in any sample number to reference an existing sample. You can also type in “0” to not reference any sample. This should for example be done if the instrument is already assigned to an instrument plugin. You should also keep in mind that only 16 samples can be referenced by each instrument in the XM format.

Use <kbd>Enter</kbd> to pick up the currently selected note or sample and <kbd>Space</kbd> to paste it in another place.

=== Context Menu ===

* '''Edit Sample Map''': Opens the [[Manual: Sample Map|Sample Map]] dialog, where you can assign samples to certain notes for input and playback.
* '''Edit Sample''': Allows you to select one of the associated samples in order to modify it in the [[Manual: Samples|Sample Editor]].
* '''Map all notes to sample''': Assigns all notes to the sample in the current slot.
* '''Map all notes to note''': Assigns all notes to the current note.
* '''Transpose map up''': Moves the note assignments up one semitone.
* '''Transpose map down''': Moves the note assignments down one semitone.
* '''Reset note mapping''': Reverts the map to the default assignment of C-0 through B-9.
* '''Remove all samples''': Removes all notes' sample assignments.
* '''Duplicate instrument''': Creates a new instrument slot and sets all of its attributes to those of the current instrument.

== Envelope Editor ==

[[Image:Envelope Editor.png|thumb|300px|Envelope Editor]]

Envelopes can be used to alter the playback characteristics of samples. Using the '''Volume Envelope''' you can adjust the loudness of the samples, using the '''Panning Envelope''' you can adjust their position in the panning space, and using the '''Pitch / Filter Envelope''' you can adjust their pitch or the resonant filter’s cutoff frequency. Envelopes can also be used on instrument plugins through [[Manual: Zxx Macros|Zxx Macros]].

The Volume Envelope can be used to modulate the amplification of the sample. It ranges from 0% (silence) to 100% (no attenuation). The Panning Envelope moves the sample’s panning relative to its current panning position. If the sample is centered, the highest possible point (+32) will move the sample far right, and the lowest possible point (-32) will move it to the far left. The pitch envelope has a granularity of one quarter tone per step, resulting in a total range of ±16 semitones. If it is being used as a filter envelope, it can control the cutoff filter’s frequency from completely closed to fully open.

=== Envelope Editor Toolbar ===

The first three buttons are used to switch between the envelope views: the '''Volume Envelope''', the '''Panning Envelope''' and the '''Pitch / Filter Envelope'''.

The next four buttons are used to toggle these envelopes. The third and fourth buttons are mutually exclusive; when either is enabled, the Pitch / Filter Envelope will be enabled, but:
* The third button (“Ptch”) explicitly configures the Pitch / Filter Envelope to act as a '''pitch''' envelope.
* The fourth button (“Flt”) explicitly configures the Pitch / Filter Envelope to act as a '''filter''' envelope.

In the MPTM format, you can also turn the pitch envelope into a filter envelope and vice versa using the [[Manual: Effect Reference#Effect Column 5|pattern effects]] S7D and S7E.

The next three buttons are used for configuring the currently displayed envelope:

* '''Envelope Loop''': Enables the envelope loop. Envelope loops cannot be stopped by Note Off events.
* '''Envelope Sustain''': Enables the envelope sustain loop (or sustain point in the XM format). Sustain loops are exited as soon as a Note Off event occours.
* '''Envelope Carry''': When triggering a new note, the envelope is not re-played from the beginning, but rather “carried on”. Since some of Impulse Tracker’s audio drivers ignore envelope carry if the [[#New Note Action|NNA]] is set to “Note Cut” (and some players replicate this behaviour), it is recommended to always choose some other NNA value when using Envelope Carry.

In the XM format, it does not matter if the envelope loop is reached before the sustain point or vice versa; whichever of the two is reached first is used for looping the envelope.

When using IT compatible playback, though, the sustain loop is always considered before the envelope loop, so if the sustain loop is placed beyond the envelope loop, the envelope 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 envelope loop.

The rest of the buttons are used for various tasks:

* '''Show Sample Map''': Opens the [[Manual: Sample Map|Sample Map]] dialog.
* '''Show / Hide Row Guidelines''': Toggles guidelines displayed at every beat (dark grey) and every measure (light grey).
* '''Zoom In''' / '''Zoom Out''': Increases or decreases envelope zoom. You can also press <kbd>Ctrl</kbd> while scrolling the Mouse Wheel to achieve the same effect.
* '''Load Envelope''' / '''Save Envelope''': Allows to load an existing envelope file or save an envelope to a file on disk.

=== Envelope Display ===

Below the toolbar, the actual envelopes are displayed. New envelope nodes can be inserted by <kbd>Shift</kbd>-clicking or double-clicking somewhere in the editor. Middle-click or <kbd>Ctrl</kbd>-right-click an envelope nodes to remove it again. Envelope nodes and loop points can be moved around by simply dragging them with the left mouse button pressed, or by using the corresponding [[Manual: Keyboard Actions#Envelope Editor|keyboard shortcuts]]. Press <kbd>Ctrl</kbd> while dragging an envelope node to also move all trailing envelope nodes.

In the status bar, the mouse cursor position is translated into its corresponding envelope tick and value if the mouse hovers over the envelope display. If the mouse points beyond the release node, the envelope value is displayed relatively to the release node’s value.

=== Envelope Editor Context Menu ===

* '''Loop''': Toggles the Envelope Loop.
* '''Sustain''': Toggles the Envelope Sustain Loop.
* '''Carry''': Toggles the Envelope Carry.
* '''Insert Point''': Adds a new point to the envelope at the location of the mouse click.
* '''Remove Point''': Removes the selected point from the envelope. You cannot remove the first point.
* '''Toggle Release Node''': Toggles the selected point as a Release Node. Envelope playback is resumed from that node if a Note Off event is encountered. In that case, the volume of all following nodes is relative to the volume of the envelope point that was reached at the Note Off event.
* '''Copy Envelope''': Places the data of the envelope into the Clipboard.
* '''Paste Envelope''': Replaces the current envelope by an envelope placed in the Clipboard.
* '''Scale Envelope Points''': Shows the [[Manual: Scale Envelope Points|Scale Envelope Points dialog]] which allows you to stretch or contract the envelope by a given factor and to amplify the envelope.

[[Category:Manual|Instrument Tab]]
[[Category:Tabs|Instrument Tab]]
[[de:Handbuch: Instrumente]]

Manual: Comments

2020-05-27T20:41:28Z

Twomoso: grammar corrections, rephrasing

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

The Comments tab contains a song's comment text (not available in all module formats) and sample / instrument information.
In the text box at the top, you can put in comments or notes for the module. The font of this text box can be modified in the [[Manual: Setup/Display#Comments Font|Display page]] of the Options dialog.

The bottom half of the page lists the samples or instruments (depending on the icon chosen) that are used in this track, sorted according to their slot number. In the '''sample view''', the samples are shown with their waveform lengths, bit depth, and frequency at middle C, as well as the instruments the samples are assigned to and the contents of the samples' “File” text field (in the Samples page). If the sample has been loaded from or saved to a file during the current editing session, or if it is an [[Manual:_Samples#External_Samples|external sample]] in an MPTM file, its file path is also shown. In the '''instrument view''', the instruments are shown with the sample numbers and envelopes they use, the contents of their “File” text field (in the Instruments page), and the plugins assigned to the instrument (if any).

You can interact with the view in several ways:
* '''Double-clicking''' an item or pressing <kbd>Enter</kbd> opens the item in the sample or instrument editor.
* '''Slowly double-clicking''' a sample or instrument name allows you to rename the item.
* '''Right-clicking''' the list opens a context menu, from which you can copy all sample / instrument names to the clipboard.
* Using the same keys as you would in the pattern editor previews samples and instruments.
* Using <kbd>Tab</kbd> quickly toggles between samples and instruments.
* Sliding the column separators in the header resizes the column widths. Double-clicking on the separator resizes the column to fit all of the entries' text.

[[Category:Manual|Comments Tab]]
[[Category:Tabs|Comments Tab]]
[[de:Handbuch: Kommentare]]