Traktor S2 MK1: Add calibration and refactor #11237

leifhelm · 2023-02-01T17:29:20Z

As discussed in #3905 with @JoergAtGithub this PR add the capability to read the feature report of the controller and apply the calibration stored in it.
I cleaned up the messy code and replaced it with nice OOP code.

~~I guess this has to wait until #3905 gets into 2.4.~~

JoergAtGithub · 2023-02-01T22:54:02Z

On a first look, the code looks very clean.

JoergAtGithub · 2023-02-02T18:01:35Z

You might be interested in initializing Mixxx with the knob positions at startup, using getInputReport (which is another new HID feature in 2.4). Example: e221885

JoergAtGithub · 2023-03-25T19:57:03Z

We have issue #10667 where this mapping was derived from.
Both mappings use the CO "load_preset" which is no longer available in 2.4. Could you try to change this to use the "loaded_chain_preset".

github-actions · 2023-06-24T00:08:02Z

This PR is marked as stale because it has been open 90 days with no activity.

leifhelm · 2023-07-02T16:25:12Z

I’m back. The mapping of knobs seems to have changed. Only goes non-linearly halfway. 🤔

res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js

ronso0 · 2023-07-02T20:08:01Z

The browse knob behaves now exactly like in Traktor Pro.

What does that mean? Mixxx is not Traktor.

leifhelm · 2023-07-02T21:43:55Z

Turning Browse: go up or down in track list.
Shift + Turning Browse: go up or down in search box
Click Browse: Mini/Maximize Library
Shift + Click Browse: Open Folder (GoToItem)
I have not found a description on how the browse knob should behave.

I guess the desired behavior would be (based on Traktor S4 Mk2):
Click Browse: GoToItem
Turning Browse: go up or down where ever the focus is.
Shift + Turning Browse: Move the focus around.

So if you would like to select a track in the track list, you have to do the following:

Check if the focus is on the track list.
If not move the focus to the track list.
Turn the knob to select the track.

MoveFocus also shifts focus to the text search box, a bit odd when using the controller.

leifhelm · 2023-07-02T22:09:34Z

script.absoluteNonLin seems to be broken. Mapping to 0…2 and then squaring looks more linear to me.

ronso0 · 2023-07-02T22:38:15Z

go up or down in track list.
Shift + Turning Browse: go up or down in search box
Click Browse: Mini/Maximize Library
Shift + Click Browse: Open Folder (GoToItem)
I have not found a description on how the browse knob should behave.

And with this implementation there's no way to move focus to the library sidebar, right?

I guess the desired behavior would be (based on Traktor S4 Mk2):
Click Browse: GoToItem
Turning Browse: go up or down where ever the focus is.
Shift + Turning Browse: Move the focus around.

Yes, one possibility.

So if you would like to select a track in the track list, you have to do the following:

Check if the focus is on the track list.

If not move the focus to the track list.

Turn the knob to select the track.

Yep. But if you don't click on any beatsize spinboxes the focus remains on Tracks, even if you toggle the maximized library.

MoveFocus also shifts focus to the text search box, a bit odd when using the controller.

Why is that odd? You can then cycle through the list of saved search queries. If you never do that and want to prevent accidental query change, you can disable the Up/Down functionality in Preferences > Library.

leifhelm · 2023-07-03T17:58:12Z

In my implementation pressing shift moves focus to the sidebar (Tracks, Auto-DJ, …). Releasing shift moves focus back to the Track list. Have a look at shift(field)

leifhelm · 2023-07-03T18:16:17Z

There are dedicated controls for beatsize adjustment. When selecting the beatsize with the mouse, [Library], MoveVertical moves the focus always to the track-list.

The current system is optimized for people who navigate around their library with the side bar and the track list, maybe frequently switching between them as they navigate a folder structure. And do not use the Seach… input box.

Do you have a better idea of what to do when pressing Browse in track-list?

I think I messed up the terminology in my previous comments.

leifhelm · 2023-07-03T18:29:17Z

I seems that different equalizers need different parameter scaling. How should this be handled?

ronso0 · 2023-07-03T21:21:27Z

The current system is optimized for people who navigate around their library with the side bar and the track list, maybe frequently switching between them as they navigate a folder structure. And do not use the Seach… input box.

[Library], MoveVertical (shift: ScrollVertical?) and MoveFocusForward play very well together with the focus highlight in skins. With [Library], GoToItem (using [Library], focus_widget internally) you can jump from the searchbox or from the sidebar to the tracks table.
It seems you optimized the navigation for your use case (and for 2.3 and earlier this implementation is okay), but this way you exclude other users from using new 2.4 features with this mapping (search box' saved queries).

Btw what I expect the Browse mapping to do is pretty much what @JoergAtGithub proposed in your previous PR #3905 (comment)

When selecting the beatsize with the mouse, [Library], MoveVertical moves the focus always to the track-list.

Yes, correct. Since the spinboxes can only be focused by mouse click it is assumed the beat size is change by mouse or keyboard. With [Library], MoveVertical you can easily return to the tracks table in case your hands are already back on the controller (no need to reach for the mouse again). Same happens with [Library], GoToItem, though there are many simple controllers which may not have a button to map it, so MoveVertical is helping out (even though it may change the spinboxes, but as you said, if a users needs to do that regularly they'll map the dedicated controls).

res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js

leifhelm · 2023-07-07T07:30:29Z

@ronso0 are you happy with the browse knob behavior now?

JoergAtGithub · 2023-07-08T11:56:52Z

Could you please explain step by step, how you tested that the calibration values are used in the same way as in Traktor Pro.

ronso0 · 2023-07-08T14:52:09Z

@ronso0 are you happy with the browse knob behavior now?

Yeah, I think this can work well.
What about this Playlist residue though?
https://github.com/mixxxdj/mixxx/pull/11237/files#diff-1e471385f72a5137810cf36856f4456991bc962bcef3ae54a772080a96abb873R1135

leifhelm · 2023-07-09T18:57:01Z

I captured the USB Traffic from Traktor Pro with Wireshark and USBPcap. When doing the calibration sequence I would only turn/move one knob/slider. Traktor Pro seems to have a check in place that writes default values if you do not move a knob/slider. This can be used to check which values have changed. As the calibration sequence demands left, right, center for knobs, and three values which are the exact same as in the last received input packet, I figured that the corresponding values are the ADC readings of the left, right, center position. Sliders only have the two end positions in the calibration routine.
Similar methodology was applied with the jog wheel touch calibration. There exists a restore factory settings button that writes the default values, or the factory jog wheel calibration (read earlier).

I hope this explains that enough. As decompilation was not used, I can not for example tell how the calibration values are used in Traktor Pro.

What about this Playlist residue though?

Good catch. I changed it to [Library].

JoergAtGithub · 2023-07-09T19:05:11Z

This describes the capture of the calibration procedure, but did you also captured the readout when Traktor Pro starts up?

Did you tried to intentionally calibrate intentionally "wrong", e.g. left and right cross-fader positions close to the center, to get extra sharp cuts? If you do, does it cut at the same fader position with Traktor Pro and Mixxx?

leifhelm · 2023-07-10T14:56:23Z

When Traktor Pro 2 starts up the feature reports d0-d4 are read, followed by input report 01 and 02. This is the only USBHID traffic apart from fetching the HID report descriptor and a SET_IDLE request.

leifhelm · 2023-07-10T15:05:58Z

I calibrated the crossfader to about 5 mm from the edge. When slowly moving the slider from the outside inwards the crossfader in the software starts moving at the same point for Traktor and Mixxx.

JoergAtGithub · 2023-08-14T19:38:42Z

res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js

+        this.decks[0].registerInputs(InputReport0x01, InputReport0x02, {
+            gainEncoderPress: [0x0E, 0x01],
+            shift: [0x0D, 0x80],
+            sync: [0x0D, 0x40],


This registerInputs structure is very difficult to understand. For me it's not clear anymore, in which InputReport an input data item is located. Please rethink how to make this part of the code easier readable for others.

Something like this?

JoergAtGithub

Code structure is much better readable now - but I found some small points. Please have a look!

res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js

JoergAtGithub · 2023-09-05T19:30:36Z

res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js

+                    return;
+                }
+                // was enabled, and button has been let go.  maybe latch it.
+                if (now - this.syncEnabledTime > 300) {


this.syncEnabledTime is not a numeric type, it's defined as this.syncEnabledTime = {};

Would NaN be better? isNaN(now - NaN) === true and NaN > 300 === false.

res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js

JoergAtGithub

LGTM! Waiting for CI.

JoergAtGithub · 2023-09-13T23:18:27Z

Thank you!

JoergAtGithub · 2024-04-20T15:27:36Z

There is a report in our forum, that this mapping is not working on Linux: https://mixxx.discourse.group/t/ni-traktor-s2-mk1-linux-only-half-of-the-mapping-works/29468

github-actions bot added the controller mappings label Feb 1, 2023

leifhelm marked this pull request as draft February 1, 2023 17:30

JoergAtGithub mentioned this pull request Mar 26, 2023

Kontrol S4 Mk3: add controller mapping #11284

Merged

JoergAtGithub mentioned this pull request May 12, 2023

AutoDJ + USB MIDI/HID controller + moving crossfader to "Deck A" = "fails to trigger Deck A auto play" #11546

Open

github-actions bot added the stale Stale issues that haven't been updated for a long time. label Jun 24, 2023

leifhelm force-pushed the 2.4-calibration branch from 266b861 to 9011bf3 Compare July 2, 2023 16:17

ronso0 removed the stale Stale issues that haven't been updated for a long time. label Jul 2, 2023

ronso0 reviewed Jul 2, 2023

View reviewed changes

res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js Outdated Show resolved Hide resolved

leifhelm marked this pull request as ready for review July 4, 2023 19:35

leifhelm force-pushed the 2.4-calibration branch from 9496566 to f193364 Compare July 4, 2023 20:31

ronso0 reviewed Jul 5, 2023

View reviewed changes

res/controllers/Traktor-Kontrol-S2-MK1-hid-scripts.js Show resolved Hide resolved

leifhelm force-pushed the 2.4-calibration branch from 32c2834 to 5016898 Compare July 5, 2023 15:24

leifhelm added 11 commits July 21, 2023 09:05

Traktor S2 MK1: Refactor mapping

9a7cf36

Traktor S2 Mk1: Read any apply calibration

d85309d

Traktor S2 Mk1: update copyright notice

624145f

Traktor S2 Mk1: load_preset -> loaded_chain_preset

add0f49

Traktor S2 Mk1: remove linkOutput

4e9298a

Traktor S2 Mk1: fix eq knobs scaling for biquad

a91b007

Traktor S2 Mk1: Adjust browse knob behavior

4e2dc71

Traktor S2 Mk1: Read initial state of controls

1568bca

Traktor S2 Mk1: Fix encoder initialization

b148da4

Traktor S2 Mk1: setValue -> setParameter

1a12706

Traktor S2 Mk1: Playlist -> Library

697e9eb

leifhelm force-pushed the 2.4-calibration branch from 03acb98 to 697e9eb Compare July 21, 2023 07:07

leifhelm mentioned this pull request Jul 21, 2023

Traktor S2 Mk1: Update controller mapping for the 2.4 version mixxxdj/manual#574

Merged

JoergAtGithub added the needs review label Aug 13, 2023

JoergAtGithub requested changes Aug 14, 2023

View reviewed changes

Traktor S2 Mk1: Clarify registerInput/Output

18007a8

leifhelm requested a review from JoergAtGithub August 29, 2023 08:24

JoergAtGithub requested changes Sep 5, 2023

View reviewed changes

JoergAtGithub removed the needs review label Sep 5, 2023

leifhelm added 4 commits September 13, 2023 19:58

Traktor S2 Mk1: Remove console.log statements

70dc1ce

Traktor S2 Mk1: Fix missing rename.

905f8ba

Traktor S2 Mk1: Remove superfluous arguments

3d8e043

Traktor S2 Mk1: Use NaN as initial value

19535a2

JoergAtGithub approved these changes Sep 13, 2023

View reviewed changes

JoergAtGithub merged commit 42798e9 into mixxxdj:2.4 Sep 13, 2023

JoergAtGithub added the changelog This PR should be included in the changelog label Sep 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Traktor S2 MK1: Add calibration and refactor #11237

Traktor S2 MK1: Add calibration and refactor #11237

leifhelm commented Feb 1, 2023 •

edited

Loading

JoergAtGithub commented Feb 1, 2023

JoergAtGithub commented Feb 2, 2023

JoergAtGithub commented Mar 25, 2023

github-actions bot commented Jun 24, 2023

leifhelm commented Jul 2, 2023

ronso0 commented Jul 2, 2023

leifhelm commented Jul 2, 2023

leifhelm commented Jul 2, 2023

ronso0 commented Jul 2, 2023

leifhelm commented Jul 3, 2023 •

edited

Loading

leifhelm commented Jul 3, 2023

leifhelm commented Jul 3, 2023

ronso0 commented Jul 3, 2023

leifhelm commented Jul 7, 2023

JoergAtGithub commented Jul 8, 2023

ronso0 commented Jul 8, 2023

leifhelm commented Jul 9, 2023

JoergAtGithub commented Jul 9, 2023

leifhelm commented Jul 10, 2023 •

edited

Loading

leifhelm commented Jul 10, 2023 •

edited

Loading

JoergAtGithub Aug 14, 2023

leifhelm Aug 29, 2023

JoergAtGithub left a comment

JoergAtGithub Sep 5, 2023

leifhelm Sep 13, 2023 •

edited

Loading

JoergAtGithub left a comment

JoergAtGithub commented Sep 13, 2023

JoergAtGithub commented Apr 20, 2024

Traktor S2 MK1: Add calibration and refactor #11237

Traktor S2 MK1: Add calibration and refactor #11237

Conversation

leifhelm commented Feb 1, 2023 • edited Loading

JoergAtGithub commented Feb 1, 2023

JoergAtGithub commented Feb 2, 2023

JoergAtGithub commented Mar 25, 2023

github-actions bot commented Jun 24, 2023

leifhelm commented Jul 2, 2023

ronso0 commented Jul 2, 2023

leifhelm commented Jul 2, 2023

leifhelm commented Jul 2, 2023

ronso0 commented Jul 2, 2023

leifhelm commented Jul 3, 2023 • edited Loading

leifhelm commented Jul 3, 2023

leifhelm commented Jul 3, 2023

ronso0 commented Jul 3, 2023

leifhelm commented Jul 7, 2023

JoergAtGithub commented Jul 8, 2023

ronso0 commented Jul 8, 2023

leifhelm commented Jul 9, 2023

JoergAtGithub commented Jul 9, 2023

leifhelm commented Jul 10, 2023 • edited Loading

leifhelm commented Jul 10, 2023 • edited Loading

JoergAtGithub Aug 14, 2023

Choose a reason for hiding this comment

leifhelm Aug 29, 2023

Choose a reason for hiding this comment

JoergAtGithub left a comment

Choose a reason for hiding this comment

JoergAtGithub Sep 5, 2023

Choose a reason for hiding this comment

leifhelm Sep 13, 2023 • edited Loading

Choose a reason for hiding this comment

JoergAtGithub left a comment

Choose a reason for hiding this comment

JoergAtGithub commented Sep 13, 2023

JoergAtGithub commented Apr 20, 2024

leifhelm commented Feb 1, 2023 •

edited

Loading

leifhelm commented Jul 3, 2023 •

edited

Loading

leifhelm commented Jul 10, 2023 •

edited

Loading

leifhelm commented Jul 10, 2023 •

edited

Loading

leifhelm Sep 13, 2023 •

edited

Loading