Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

S4MK3: Software mixer support and default pad layout customisation #13059

Merged
merged 5 commits into from
May 13, 2024
Merged

S4MK3: Software mixer support and default pad layout customisation #13059

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f2cadf7
feat(S4MK3): optional mapping to the software mixer
acolombier Apr 6, 2024
1c05b8c
feat(S4MK3): custom default pad layout
acolombier Apr 6, 2024
0afe2dc
fix(S4MK3): redundant default value and invalid device matching
acolombier Apr 6, 2024
2280d98
Apply suggestions from code review
acolombier Apr 12, 2024
95509f7
Apply suggestions from code review
acolombier May 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 45 additions & 3 deletions res/controllers/Traktor Kontrol S4 MK3.hid.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<description>HID Mapping for Traktor Kontrol S4 MK3</description>
<manual>native_instruments_traktor_kontrol_s4_mk3</manual>
<devices>
<product protocol="hid" vendor_id="0x17cc" product_id="0x1720" usage_page="0xff01" usage="0x1" interface_number="0x4" />
<product protocol="hid" vendor_id="0x17cc" product_id="0x1720" usage_page="0xff01" usage="0x0" interface_number="0x3" />
</devices>
</info>
<settings>
Expand Down Expand Up @@ -56,7 +56,7 @@
label="Deck C">
<value label="Aqua">aqua</value>
<value label="Azalea">azalea</value>
<value label="Blue" default="true">blue</value>
<value label="Blue">blue</value>
<value label="Celeste">celeste</value>
<value label="Fuscia">fuscia</value>
<value label="Green">green</value>
Expand Down Expand Up @@ -131,7 +131,7 @@
label="Tempo fader low soft takeover color">
<value label="Aqua">aqua</value>
<value label="Azalea">azalea</value>
<value label="Blue" default="true">blue</value>
<value label="Blue">blue</value>
<value label="Celeste">celeste</value>
<value label="Fuscia">fuscia</value>
<value label="Green">green</value>
Expand Down Expand Up @@ -190,6 +190,21 @@
This option is useful if you don't use samplers and would like to access a set of predefined beatloop rolls. Beat size can be customized individually.
</description>
</option>
<option
variable="defaultPadLayout"
type="enum"
label="Default Pad Layout">
<value label="Intro/Outro + 4 hotcues" default="true">default</value>
<value label="Hotcues">hotcue</value>
<value label="Sampler or beatloop">samplerBeatloop</value>
<value label="Keyboard">keyboard</value>
<description>
Define the default layout used for the pads.
</description>
</option>
</group>

<group label="Mixer">
<option
variable="mixerControlsMicAuxOnShift"
type="boolean"
Expand All @@ -199,6 +214,33 @@
When shifting decks, the mixer controls microphones or auxiliary lines. If both a microphone and an auxiliary are configured on the same channel, the mixer will prioritize controlling the auxiliary.
</description>
</option>
<option
variable="softwareMixerMain"
type="boolean"
default="false"
label="Main gain is handled by the Mixxx built-in mixer">
<description>
When enable, the master potentiometer on top right column of the mixer will drive the main gain of the Mixxx internal mixer as well as the hardware built-in mixer in the device. This is useful if you aren't relying on the hardware output, but will create conflict if enabled when using the hardware outputs.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if the word master is problematic here - the device is physically labelled with Master so if it is, perhaps I can put " around it or the :hwbtn: marker?

acolombier marked this conversation as resolved.
Show resolved Hide resolved
</description>
</option>
<option
variable="softwareMixerBooth"
type="boolean"
default="false"
label="Booth gain is handled by the Mixxx built-in mixer">
<description>
When enable, the booth potentiometer on right column of the mixer will drive the booth gain of the Mixxx internal mixer as well as the hardware built-in mixer in the device. This is useful if you aren't relying on the hardware output, but will create conflict if enabled when using the hardware outputs.
acolombier marked this conversation as resolved.
Show resolved Hide resolved
</description>
</option>
<option
variable="softwareMixerHeadphone"
type="boolean"
default="false"
label="Headphone gain and cue mix is handled by the Mixxx built-in mixer">
<description>
When enable, the headphone volume and cue potentiometers on bottom right column of the mixer will drive the headphone controls of the Mixxx internal mixer as well as the hardware built-in mixer in the device. This is useful if you aren't relying on the hardware output, but will create conflict if enabled when using the hardware outputs.
acolombier marked this conversation as resolved.
Show resolved Hide resolved
</description>
</option>
</group>

<group label="Beatloop Roll Size (Only if Enabled Instead of the Sampler Tab)">
Expand Down
69 changes: 67 additions & 2 deletions res/controllers/Traktor-Kontrol-S4-MK3.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ const KeyboardColors = [
LedColors.white,
];

// Constant used to define custom default pad layout
const DefaultPadLayoutHotcue = "hotcue";
const DefaultPadLayoutSamplerBeatloop = "samplerBeatloop";
const DefaultPadLayoutKeyboard = "keyboard";

/*
* USER CONFIGURABLE SETTINGS
* Change settings in the preferences
Expand Down Expand Up @@ -137,6 +142,14 @@ const TightnessFactor = engine.getSetting("tightnessFactor") || 0.5;
// This will also affect how quick the wheel starts spinning when enabling motor mode, or starting a deck with motor mode on
const MaxWheelForce = engine.getSetting("maxWheelForce") || 25000; // Traktor seems to cap the max value at 60000, which just sounds insane

// Map the mixer potentiometers to different components of the software mixer in Mixxx, on top of the physical control of the hardware
// mixer embedded in the S4 Mk3. This is useful if you are not using certain S4 Mk3 outputs.
const SoftwareMixerMain = !!engine.getSetting("softwareMixerMain");
const SoftwareMixerBooth = !!engine.getSetting("softwareMixerBooth");
const SoftwareMixerHeadphone = !!engine.getSetting("softwareMixerHeadphone");

// Define custom default layout used by the pads, instead of intro/outro and first 4 hotcues.
const DefaultPadLayout = engine.getSetting("defaultPadLayout");


// The LEDs only support 16 base colors. Adding 1 in addition to
Expand Down Expand Up @@ -1144,6 +1157,42 @@ class Mixer extends ComponentContainer {
},
});

if (SoftwareMixerMain) {
this.master = new Pot({
group: "[Master]",
inKey: "gain",
inByte: 22,
bitLength: 12,
inReport: inReports[2]
});
}
if (SoftwareMixerBooth) {
this.booth = new Pot({
group: "[Master]",
inKey: "booth_gain",
inByte: 24,
bitLength: 12,
inReport: inReports[2]
});
}
if (SoftwareMixerHeadphone) {
this.cue = new Pot({
group: "[Master]",
inKey: "headMix",
inByte: 28,
bitLength: 12,
inReport: inReports[2]
});

this.pflGain = new Pot({
group: "[Master]",
inKey: "headGain",
inByte: 26,
bitLength: 12,
inReport: inReports[2]
});
}

for (const component of this) {
if (component.inReport === undefined) {
component.inReport = inReports[1];
Expand Down Expand Up @@ -2213,8 +2262,24 @@ class S4Mk3Deck extends Deck {
samplerPage: 3,
keyboard: 5,
};
switchPadLayer(this, defaultPadLayer);
this.currentPadLayer = this.padLayers.defaultLayer;
switch (DefaultPadLayout) {
case DefaultPadLayoutHotcue:
switchPadLayer(this, hotcuePage2);
this.currentPadLayer = this.padLayers.hotcuePage2;
break;
case DefaultPadLayoutSamplerBeatloop:
switchPadLayer(this, samplerOrBeatloopRollPage);
this.currentPadLayer = this.padLayers.samplerPage;
break;
case DefaultPadLayoutKeyboard:
switchPadLayer(this, this.keyboard);
this.currentPadLayer = this.padLayers.keyboard;
break;
default:
switchPadLayer(this, defaultPadLayer);
this.currentPadLayer = this.padLayers.defaultLayer;
break;
}

this.hotcuePadModeButton = new Button({
deck: this,
Expand Down