Current XML file schema revision is: 1

Support for additional MIDI devices can be added to Mixxx by created a new “MIDI mapping” file. This mapping file tells Mixxx how to translate MIDI commands from a controller into commands that Mixxx will understand.

The MIDI mapping files are located in the following paths:

• Windows: C:\Program Files\Mixxx\midi
• Linux: /usr/share/mixxx/midi (or /usr/local/share/mixxx/midi)
• OS X: /Applications/Mixxx.app/Contents/midi

By far, the easiest way to create a new MIDI mapping is by using the MIDI Learn wizard in the Preferences. You can then modify the XML file it creates (or any of the ones that ship with Mixxx) using the information on this page if you'd like to fine-tune it or add more mappings. When you've finished creating your MIDI mapping, please send it to us and we'll include it in Mixxx.

Most MIDI messages are three bytes long. The first byte of any MIDI message is called the Status byte. The first nybble (hex digit) is the op-code and the second is the MIDI channel number. So if you have 0x90 the op-code is 0x9 and the channel number is 0x0 (Ch 1.) The full list of MIDI messages is below, where n represents the channel number (0..F inclusive):

The boldface entries in the table above are the messages we are most concerned with since most DJ controllers use only these for all functions. You'll need to consult the MIDI spec for the DJ controller you're working with to determine which messages and note/control numbers correspond to the DJ controller functions & LEDs. If your controller's MIDI spec gives only note names and not numbers, use this table to convert them. To convert from decimal to hex, use this.

(Note that in order to use System Exclusive messages, you will need MIDI Scripting.)

First, try using the MIDI Learn functionality in the Preferences→MIDI Devices window at the bottom. It will help you get many of the essential functions mapped quickly without having to do any hacking.

If you don't have the MIDI spec for your controller, first check the manufacturer's web site under Support. Look for Manuals or User Guides. MIDI specs are usually given in an appendix at the back of the manual. Failing that, you can usually sniff the MIDI data the controller sends.

Open a console and issue amidi -l. This will list the attached MIDI device(s) like so:

Dir Device    Name
IO  hw:1,0,0  SCS.3d MIDI 1

Then, to dump the data, you just issue amidi -p hw:1,0,0 -d (Replace hw:1,0,0 with whatever device ID your controller shows in the list.) See “All” below for how to interpret this data.

Start Mixxx from a command prompt using the –midiDebug option like so:

C:\Program Files\Mixxx>mixxx --midiDebug

Then look at the Mixxx.log file which will contain all of the MIDI messages Mixxx receives.

On Windows, you can download tail.exe to watch it as new messages are added or build Mixxx with scons msvcdebug=1 and run it with the –midiDebug option. This will cause it to pop up a console window when you run it and the MIDI messages received by your controller will be displayed there.

Download the free MIDI Monitor utility and run it.

Then as you press buttons or move sliders, the MIDI commands the controller sends will be printed to the screen. Compare the status (first) byte in each line with the table above and then just write down which button/slider/control sends what command.

For example, when you move a slider, you might see

B0 02 3D
B0 02 3A
B0 02 3D
B0 02 3B
B0 02 3C

Debug: []: "MIDI status: B0, ctrl: 2, val: 3D" 
Debug: []: "MIDI status: B0, ctrl: 2, val: 3A" 
Debug: []: "MIDI status: B0, ctrl: 2, val: 3D" 
Debug: []: "MIDI status: B0, ctrl: 2, val: 3B" 
Debug: []: "MIDI status: B0, ctrl: 2, val: 3C" 

In this instance, it's sending 0xB0, which when we look at the table above, we see that it's a Control Change message on channel 1. We also see that the second byte, 0x02 in this case, is the control number, and the third is the value, which you can ignore for the purposes of mapping. You would then just plug the first two bytes into a <control> XML block (detailed below) for <status> and <midino> respectively.

Mixxx uses a well defined XML format to store its MIDI mappings. The format is used for storing and distributing MIDI mappings from multiple scopes.

<?xml version="1.0" encoding="utf-8"?>
    <MixxxMIDIPreset schemaVersion="1" mixxxVersion="1.7.0+"> <!-- Schema version number to help compatibility, should the MIDI format change -->
	<info><!-- Optional - information about the preset file -->
		<name>Example MIDI Preset for Mixxx</name>
		<author>Tom Care</author>
		<description>This is an example XML MIDI preset for Mixxx. The scope of the preset could be from a small functionality addition, to a complete mapping for a controller, to a complex personal setup with multiple controllers. This description is intended for distribution and could include comments about the extent of the functionality.</description>
	</info>

The first part of the file defines the version of the mapping (for future compatibility, as the Mixxx MIDI abilities become more complex) and an optional info tag which contains information about the preset (primarily used for distribution of presets).

	<controller id="controller name" port=""> <!-- Many controllers in one file supported. A controller should only appear once -->

The “controller id” is the brand & model of the controller, e.g. “Stanton SCS.3d”. Leave “port” empty.

The core part of the file contains a definition for a single controller. There may be multiple controllers in one file (for more complex setups). Each controller definition contains two sections: input bindings (controls) and output bindings.

		<controls> <!-- One control group -->
			<control> <!-- Several controls -->
				<group>[Master]</group>
				<key>crossfader</key>

Group and key define the part of Mixxx that is being controlled. For a list of what these values can be, see below.

				<status>0xB0</status> <-- CC on channel 1 -->
				<midino>0x07</midino>

These tags define the MIDI event that Mixxx will listen for.

				<options>
					<!-- all control specific options should go here - sensitivity etc. Specifics to be decided by spec -->
				</options>

The options further refine the behavior of the control. The list of generic options may expand as Mixxx development continues, but any controller-specific refinements (translations, sensitivity, acceleration, etc.) belong in a MIDI script. Necessary options will have default values, eg a jogwheel might have no acceleration by default.

			</control>
		</controls>
		<outputs>

The next section defines outputs that use “short” (3-byte) MIDI messages. (For SYSEX messages, you need to use scripting.)

			<output>
				<group>[Channel1]</group>
				<key>play</key>
				<status>0x7F</status>  <!-- First byte sent to device -->
				<midino>0x08</midino>  <!-- Second byte -->
				<on>0x01</on>  <!-- Third byte. If not specified, 0x7F is used. -->
				<off>0x00</off> <!-- Alternate third byte. 0x00 is the default. If set to 0xFF, nothing is sent.-->
				<maximum>0.99</maximum>  <!-- Optional upper value for the Mixxx control, above which the 'off' value is sent. 1.0 is the default. -->
				<minimum>0.9</minimum>   <!-- Lower value for the Mixxx control, below which the 'off' value is sent -->

This allows you to send any three bytes to the MIDI controller in the order Status, Midino, on/off. Minimum and maximum define the range within which the 'on' value is sent. Outside this range, the 'off' value is sent. If 'off' is set to 0xFF, no message will be sent outside the range. (Useful for LED sequences.)

			</output>
		</outputs>
	</controller>
</MixxxMIDIPreset>

These define the part of Mixxx that is being controlled:

• group - The MixxxControl (controlobject) group
• key - The MixxxControl (controlobject) key, a list of which can be found below.

These tags define the MIDI event that Mixxx will listen for or send out:

• status - MIDI “Status” byte. See the MIDI crash course above.
• midino - The MIDI control or note number (leave this out for the Pitch Bend status.) Also see the crash course.

Input tags:

• options - Further refine the behaviour of the control (e.g. translations, sensitivity, acceleration) Necessary options will have default values, eg a jogwheel might have no acceleration by default. Can only handle one element currently.
  • Invert
  • Rot64inv
  • Rot64fast
  • Rot64
  • Diff - Add the value to the control's current value
  • Button - a button has a Down (non-zero) and an Up (zero) state, these occur together when pressed/released, this switch only triggers on the Down, Up is ignored. (Herc)
  • Switch - a switch has a On (non-zero) and an Off (zero) state, these occur separately. (Herc)
  • Spread64 - Exponential spread either side of 64, aka “relative” controller
  • Script-Binding - Bind to a MIDI script function given in the “key” tag. (See MIDI Scripting for details.)
  • Hercjog - Handle hercules jog wheels (deprecated…please replace with a MIDI script function.)

Output tags:

• maximum - Send the 'on' value when the Mixxx control drops below this value.
• minimum - Send the 'on' value when the Mixxx control exceeds this value. Send the 'off' value otherwise.

The old midi mapping format is here for reference. The same options apply as above, except use <threshold> for <minimum>, there's no <maximum> (it's always 1.0,) and obviously <Script-Binding> won't work. It looks like this:

 <!DOCTYPE controller>
 <controller>
   <controls>
     <control>
       <group>[[Master]]</group>
       <key>crossfader</key>
       <miditype>Ctrl</miditype>
       <midino>0x31</midino>
       <options>
         <hercjog/>
       </options>
     </control>
     ...
   </controls>
   <lights>
     <light>
       <group>[[Channel1]]</group>
       <key>VuMeter</key>
       <status>0xB0</status>
       <midino>0x16</midino>
       <threshold>0.5</threshold>
     </light>
     ...
   </lights>
 </controller>

Each control inside Mixxx is identified by a unique string. These strings are used in the keyboard mappings, the MIDI mappings, and inside Mixxx to gain access to the controls. The following is a list of controls that can be used in any of the above contexts.

The default range is 0.0 to 1.0, unless otherwise noted. Binary means it's either on (non-zero) or off (zero.)

Please keep the controls in alphabetical order by group

And coming up in v1.8:

This list contains nearly all of the controls that are useful to MIDI mapping developers.

If you were so inclined, the full list (with mixed up [Groups], internal objects and other things you shouldn't touch…be warned!) can be generated by running the following script in your mixxx/src directory:

#!/bin/sh
# set -x
IFS='
'
last_control=

for ck in `grep ConfigKey *.cpp | sed -e 's/ConfigKey(group/ConfigKey("[Master]"/g' | grep 'ConfigKey("' | grep -v "Channel2" | sed -e 's/.*ConfigKey(//g' -e 's/, */,/g' | cut -d\) -f1 | sed -e 's/\[Channel1\]/\[ChannelN\] (where N is a number 1 or 2)/g' | sort -fu`; do
  control=`echo $ck|cut -d\" -f2`
  if [ "$control" != "$last_control" ]; then
    echo
    echo $control
    last_control=$control
  fi
  key=`echo $ck|cut -d\" -f4`
  if [ ! -z "${key}" ]; then echo "* ${key}"; fi
done

If you want to access one of these controls inside Mixxx, you can do so with something like this:

 ControlObjectThreadMain* controlRightPitch = new ControlObjectThreadMain(ControlObject::getControl(ConfigKey("[[Channel2]]", "rate")));

That line will give you a ControlObject which allows you to read and control the pitch of the right channel in Mixxx. For example, to increase the pitch of the track in the right channel, one could do something like this:

 float fRightPitch = controlRightPitch->get();
 controlRightPitch->slotSet(fRightPitch + 0.10);

This would increase the pitch of the right channel inside Mixxx, and the GUI controls would automatically reflect this change. Access to ControlObjects is also thread-safe when used this way.

Important note: Different types of ControlObject wrappers must be used depending on what thread your code is running in. This example assumes the code will run in the GUI (ie. main) thread. The ControlObjects wrappers should be used as follows:

• ControlObjectThreadMain - GUI (main) thread
• ControlObject - The audio callback thread (most audio processing happens here)
• ControlObjectThread - Other threads