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

(DEBUG) S4 Mk3: compare scratch functions engine.scratch.. vs engine.setValue(group, "scratch2..") #14004

Draft
wants to merge 3 commits into
base: 2.5
Choose a base branch
from
Draft

(DEBUG) S4 Mk3: compare scratch functions engine.scratch.. vs engine.setValue(group, "scratch2..") #14004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c238d7
S4 Mk3: compare scratch functions engine.scratch.. vs engine.setValue…
ronso0 Dec 18, 2024
af4acaf
S4 Mk3: add option to stop scratching on hotcue press
ronso0 Dec 18, 2024
7abf261
S4 Mk3: use scratch modes scratch2, scratchTick or scratch_position
ronso0 Dec 18, 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
25 changes: 25 additions & 0 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 @@ -10,6 +10,31 @@
</devices>
</info>
<settings>
<group label="TEST scratch modes">
<row orientation="vertical">
<option
variable="scratchMode"
type="enum"
label="Scratch mode">
<value label="scratch2">scratch2</value>
<value label="scratchTick">scratchTick</value>
<value label="wheelPos">wheelPos</value>
</option>
<option
variable="scratchSyncToWheelLED"
type="boolean"
default="false"
label="Sync scratch speed with wheel LED speed">
</option>
<option
variable="hotcuePressStopsScratching"
type="boolean"
default="false"
label="Stop scratching when a hotcue is pressed">
</option>
</row>
</group>

<group label="Deck Lighting">
<row orientation="vertical">
<option
Expand Down
186 changes: 151 additions & 35 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 @@ -117,6 +117,29 @@ const BeatLoopRolls = [
// the motor if enable. Recommended value are 33 + 1/3 or 45.
// Default: 33 + 1/3
const BaseRevolutionsPerMinute = engine.getSetting("baseRevolutionsPerMinute") || 33 + 1/3;
const ScratchSyncToWheelLED = !!engine.getSetting("scratchSyncToWheelLED");
// For testing: switch between
// * engine.scratch.. functions
// * engine.setValue(.., "scratch2..") and
// * new wheel_scratch_position controller

// The mode available, which the wheel can be used for.
const scratchModes = {
scratch2: 0,
scratchTick: 1,
wheelPos: 2,
wheelPosNew: 3,
};
const ScratchMode = scratchModes[engine.getSetting("scratchMode")] || scratchModes.scratch2;
// const UseEngineScratch = !!engine.getSetting("useEngineScratch");
// Parameters for engine.scratchEnable()
// alpha and beta are the recommended start values from
// https://github.com/mixxxdj/mixxx/wiki/midi%20scripting#scratching-and-jog-wheels
const ScratchAlpha = 1.0/8;
const ScratchBeta = ScratchAlpha/32;
const ScratchTicksPerRev = ScratchSyncToWheelLED ? 2150 : 6750;
const ScratchSpeedFactor = ScratchSyncToWheelLED ? 2.14 : 1;
const HotcuePressStopsScratching = !!engine.getSetting("hotcuePressStopsScratching");

// Define whether or not to use motors.
// This is a BETA feature! Please use at your own risk. Setting this off means that below settings are inactive
Expand Down Expand Up @@ -449,7 +472,7 @@ class Deck extends ComponentContainer {
moveMode: this.moveMode,
};

engine.setValue(this.group, "scratch2_enable", false);
this.deck.wheelTouch.toggleScratching(false);
this.group = newGroup;
this.color = this.groupsToColors[newGroup];

Expand All @@ -459,7 +482,7 @@ class Deck extends ComponentContainer {

if (this.wheelMode === wheelModes.motor) {
engine.beginTimer(MotorWindUpMilliseconds, () => {
engine.setValue(newGroup, "scratch2_enable", true);
this.deck.wheelTouch.toggleScratching(true);
}, true);
}
}
Expand Down Expand Up @@ -647,6 +670,9 @@ class CueButton extends PushButton {
constructor(options) {
super(options);
this.outKey = "cue_indicator";
if (this.deck === undefined) {
throw Error("CueButton must have a deck attached to it");
}
this.outConnect();
}
unshift() {
Expand All @@ -663,9 +689,9 @@ class CueButton extends PushButton {
} else {
engine.setValue(this.group, this.inKey, pressed);
if (this.deck.wheelMode === wheelModes.motor) {
engine.setValue(this.group, "scratch2_enable", false);
this.deck.wheelTouch.toggleScratching(false);
engine.beginTimer(MotorWindDownMilliseconds, () => {
engine.setValue(this.group, "scratch2_enable", true);
this.deck.wheelTouch.toggleScratching(true);
}, true);
}
}
Expand Down Expand Up @@ -708,6 +734,9 @@ class HotcueButton extends PushButton {
}
this.outKey = `hotcue_${this.number}_status`;
this.colorKey = `hotcue_${this.number}_color`;
if (this.deck === undefined) {
throw Error("HotcueButton must have a deck attached to it");
}
this.outConnect();
}
unshift() {
Expand All @@ -717,7 +746,9 @@ class HotcueButton extends PushButton {
this.inKey = `hotcue_${this.number}_clear`;
}
input(pressed) {
engine.setValue(this.group, "scratch2_enable", false);
if (HotcuePressStopsScratching) {
this.deck.wheelTouch.toggleScratching(false);
}
engine.setValue(this.group, this.inKey, pressed);
}
output(value) {
Expand Down Expand Up @@ -1709,7 +1740,7 @@ class S4Mk3Deck extends Deck {
// Else, we enter/exit the loop in wheel mode
} else if (this.previousWheelMode === null) {
this.deck.fluxButton.loopModeOff();
engine.setValue(this.group, "scratch2_enable", false);
this.deck.wheelTouch.toggleScratching(false);
this.previousWheelMode = this.deck.wheelMode;
this.deck.wheelMode = wheelModes.loopIn;

Expand Down Expand Up @@ -1759,7 +1790,7 @@ class S4Mk3Deck extends Deck {
onShortRelease: function() {
if (!this.shifted) {
engine.setValue(this.group, this.key, false);
engine.setValue(this.group, "scratch2_enable", false);
this.deck.wheelTouch.toggleScratching(false);
}
},
loopModeOff: function(skipRestore) {
Expand Down Expand Up @@ -1793,7 +1824,7 @@ class S4Mk3Deck extends Deck {
// Else, we enter/exit the loop in wheel mode
} else if (this.previousWheelMode === null) {
this.deck.reverseButton.loopModeOff();
engine.setValue(this.group, "scratch2_enable", false);
this.deck.wheelTouch.toggleScratching(false);
this.previousWheelMode = this.deck.wheelMode;
this.deck.wheelMode = wheelModes.loopOut;
if (this.loopModeConnection === null) {
Expand Down Expand Up @@ -2161,16 +2192,20 @@ class S4Mk3Deck extends Deck {
cueBaseName: "outro_end",
}),
new HotcueButton({
number: 1
number: 1,
deck: this
}),
new HotcueButton({
number: 2
number: 2,
deck: this
}),
new HotcueButton({
number: 3
number: 3,
deck: this
}),
new HotcueButton({
number: 4
number: 4,
deck: this
})
];
const hotcuePage2 = Array(8).fill({});
Expand All @@ -2181,8 +2216,8 @@ class S4Mk3Deck extends Deck {
/* eslint no-unused-vars: "off" */
for (const pad of hotcuePage2) {
// start with hotcue 5; hotcues 1-4 are in defaultPadLayer
hotcuePage2[i] = new HotcueButton({number: i + 1});
hotcuePage3[i] = new HotcueButton({number: i + 13});
hotcuePage2[i] = new HotcueButton({number: i + 1, deck: this});
hotcuePage3[i] = new HotcueButton({number: i + 13, deck: this});
if (UseBeatloopRollInsteadOfSampler) {
samplerOrBeatloopRollPage[i] = new BeatLoopRollButton({
number: i,
Expand Down Expand Up @@ -2366,7 +2401,7 @@ class S4Mk3Deck extends Deck {
this.deck.fluxButton.loopModeOff(true);
if (this.deck.wheelMode === wheelModes.motor) {
this.deck.wheelMode = wheelModes.vinyl;
engine.setValue(this.group, "scratch2_enable", false);
this.deck.wheelTouch.toggleScratching(false);
} else {
this.deck.wheelMode = wheelModes.motor;
const group = this.group;
Expand All @@ -2392,7 +2427,7 @@ class S4Mk3Deck extends Deck {
} else {
this.deck.wheelMode = wheelModes.vinyl;
}
engine.setValue(this.group, "scratch2_enable", false);
this.deck.wheelTouch.toggleScratching(false);
this.outTrigger();
}
},
Expand All @@ -2409,13 +2444,19 @@ class S4Mk3Deck extends Deck {
this.wheelTouch = new Button({
touched: false,
deck: this,
wheelPos: 0,
speed: 0,
input: function(touched) {
this.touched = touched;
if (this.deck.wheelMode === wheelModes.vinyl || this.deck.wheelMode === wheelModes.motor) {
if (touched) {
engine.setValue(this.group, "scratch2_enable", true);
} else {
this.stopScratchWhenOver();
this.toggleScratching(true);
} else { // release
// if (ScratchMode === scratchModes.scratch2) {
this.stopScratchWhenOver();
// } else {
// this.toggleScratching(false);
// }
}
}
},
Expand All @@ -2424,14 +2465,58 @@ class S4Mk3Deck extends Deck {
return;
}

if (engine.getValue(this.group, "play") &&
engine.getValue(this.group, "scratch2") < 1.5 * baseRevolutionsPerSecond &&
engine.getValue(this.group, "scratch2") > 0) {
engine.setValue(this.group, "scratch2_enable", false);
} else if (engine.getValue(this.group, "scratch2") === 0) {
engine.setValue(this.group, "scratch2_enable", false);
} else {
engine.beginTimer(100, this.stopScratchWhenOver.bind(this), true);
// if (ScratchMode === scratchModes.scratchTick) {
// this.toggleScratching(false);
// }

switch (ScratchMode) {
case scratchModes.wheelPos:
if (Math.abs(this.speed) < 0.0000001) {
this.toggleScratching(false);
} else {
engine.beginTimer(100, this.stopScratchWhenOver.bind(this), true);
}
break;
case scratchModes.scratchTick:
case scratchModes.scratch2:
default:
if (engine.getValue(this.group, "play") &&
engine.getValue(this.group, "scratch2") < 1.5 * baseRevolutionsPerSecond &&
engine.getValue(this.group, "scratch2") > 0) {
this.toggleScratching(false);
} else if (engine.getValue(this.group, "scratch2") === 0) {
this.toggleScratching(false);
} else {
engine.beginTimer(100, this.stopScratchWhenOver.bind(this), true);
}
break;
}
},
toggleScratching: function(enable) {
switch (ScratchMode) {
case scratchModes.scratchTick:
if (enable) {
engine.scratchEnable(this.deck.currentDeckNumber,
ScratchTicksPerRev,
BaseRevolutionsPerMinute,
ScratchAlpha,
ScratchBeta); // ramping true by default
} else {
engine.scratchDisable(this.deck.currentDeckNumber);
}
break;
case scratchModes.wheelPos:
if (enable) {
engine.setValue(this.group, "scratch_position", this.wheelPos);
engine.setValue(this.group, "scratch_position_enable", 1);
} else {
engine.setValue(this.group, "scratch_position_enable", 0);
}
break;
case scratchModes.scratch2:
default:
engine.setValue(this.group, "scratch2_enable", enable);
break;
}
}
});
Expand All @@ -2448,20 +2533,33 @@ class S4Mk3Deck extends Deck {
input: function(value, timestamp) {
if (this.oldValue === null) {
// This is to avoid the issue where the first time, we diff with 0, leading to the absolute value
this.oldValue = [value, timestamp, 0];
this.oldValue = [value, timestamp, 0, 0];
return;
}
let [oldValue, oldTimestamp, speed] = this.oldValue;
/* eslint prefer-const: "off" */
let [oldValue, oldTimestamp, speed, oldPos] = this.oldValue;

// Log value right-aligned
// const maxLength = wheelRelativeMax.toString().length;
// const valueStr = value.toString().padStart(maxLength, " ");
// if (this.deck.currentDeckNumber === 1) {
// console.warn(`value: ${valueStr}`);
//}

// check if the internal timer wrapped around
if (timestamp < oldTimestamp) {
oldTimestamp -= wheelTimerMax;
}

let diff = value - oldValue;
// Check if the value wrapped around.
// It's not impossible a human made ~11 revs since the last call...
if (diff > wheelRelativeMax / 2) {
oldValue += wheelRelativeMax;
diff -= wheelRelativeMax;
} else if (diff < -wheelRelativeMax / 2) {
oldValue -= wheelRelativeMax;
diff += wheelRelativeMax;
}

const currentSpeed = (value - oldValue)/(timestamp - oldTimestamp);
Expand All @@ -2470,11 +2568,18 @@ class S4Mk3Deck extends Deck {
} else {
speed = currentSpeed;
}
this.oldValue = [value, timestamp, speed];
this.speed = wheelAbsoluteMax*speed*10;

this.speed = wheelAbsoluteMax * speed * 10 * ScratchSpeedFactor * 2.14;

const newPos = oldPos + diff * 55;
this.deck.wheelTouch.wheelPos = newPos;
this.deck.wheelTouch.speed = speed;

this.oldValue = [value, timestamp, speed, newPos];

const scratch2 = engine.getValue(this.group, "scratch2");
if (this.speed === 0 &&
engine.getValue(this.group, "scratch2") === 0 &&
scratch2 === 0 &&
engine.getValue(this.group, "jog") === 0 &&
this.deck.wheelMode !== wheelModes.motor) {
return;
Expand Down Expand Up @@ -2508,8 +2613,19 @@ class S4Mk3Deck extends Deck {
}
break;
case wheelModes.vinyl:
if (this.deck.wheelTouch.touched || engine.getValue(this.group, "scratch2") !== 0) {
if (ScratchMode === scratchModes.scratchTick &&
engine.isScratching(this.deck.currentDeckNumber)) {
if (diff !== 0) {
engine.scratchTick(this.deck.currentDeckNumber, diff);
}
} else if (ScratchMode === scratchModes.scratch2 &&
(this.deck.wheelTouch.touched || scratch2 !== 0)) {
engine.setValue(this.group, "scratch2", this.speed);
} else if (ScratchMode === scratchModes.wheelPos &&
// (this.deck.wheelTouch.touched || scratch2 !== 0)) {
(this.deck.wheelTouch.touched ||
engine.getValue(this.group, "scratch_position_enable") > 0)) {
engine.setValue(this.group, "scratch_position", newPos);
} else {
engine.setValue(this.group, "jog", this.speed);
}
Expand Down Expand Up @@ -2706,10 +2822,10 @@ class S4Mk3MotorManager {
}

if (this.isBlockedByUser()) {
engine.setValue(this.deck.group, "scratch2_enable", true);
this.deck.wheelTouch.toggleScratching(true);
this.currentMaxWheelForce = this.zeroSpeedForce + parseInt(this.baseFactor * expectedSpeed);
} else if (expectedSpeed && this.userHold === 0 && !this.deck.wheelTouch.touched) {
engine.setValue(this.deck.group, "scratch2_enable", false);
this.deck.wheelTouch.toggleScratching(true);
this.currentMaxWheelForce = MaxWheelForce;
}

Expand Down
Loading