Mapping for Numark Platinum FX #12872

evoixmr · 2024-02-26T01:12:19Z

ronso0 · 2024-02-26T18:03:50Z

Thank you for this PR!

Please sign the Mixxx Contributor Agreement and comment here when you have done so. It gives us permission to distribute your contribution under the GPL v2 or later license and the Apple Mac App Store. It is also helpful for us to have contact information for contributors in case we may need it in the future.

ronso0 · 2024-02-26T18:10:31Z

Instead of commiting through the Github web API, I highly recommend you set up git and work locally.
For example this will allow you to run the pre-commit code checks and notice issues beofre pushing.
Here for example, pre-commit complains about indentation.

Deails can be found here https://github.com/mixxxdj/mixxx/blob/main/CONTRIBUTING.md#git-workflow
and the git setup steps are explained here https://github.com/mixxxdj/mixxx/wiki/using-git

Since you're working only on a mapping you don't need to worry about building Mixxx.

evoixmr · 2024-02-26T18:18:40Z

@ronso0 I just signed the Mixxx Contributor Agreement.

JoergAtGithub · 2024-02-26T18:47:40Z

Just to clarify: Please confirm that the uploaded mapping files are exclusively your own work or are based exclusively on files that are already part of Mixxx.

evoixmr · 2024-02-26T20:15:15Z

@JoergAtGithub the mapping is a mixxx community work. I believe I am the only active member from that forum. All the update from the mapping for the past year were all mine, the original mapping is almost not usable for mixxx 2.4.

All the contributors are listed on the author's area of Numark Mixtrack Platinum FX.midi.xml

The thread for the mapping - #12872 (comment)

evoixmr · 2024-02-26T22:24:49Z

@ronso0 One more update then I will move locally on weekend., I was trying to work remotely, away from home.

ronso0 · 2024-02-26T23:38:31Z

Great, because I think all these "Update ..." commits may as well be squashed.
FYI as long as a PR has not seen a review you may squash, rebase and force-push as you like. You may set this to Draft in order to signal you're still polishing.
Small fixups (typos, pre-commit fixes) can go to fixup commits and be squashed before merge.

evoixmr · 2024-02-27T20:50:45Z

@ronso0 I believe this mapping is ready. I did not get any errors or warning.

Swiftb0y

very shallow first look. This will take some work go get into shape. I'm a bit short on time rn so I kept my comments short, but please ask if they've been too short and/or you need help. Thank you.

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

Swiftb0y · 2024-02-28T06:16:10Z

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

+// whether the corresponding Mixxx option is enabled
+// (Settings -> Preferences -> Waveforms -> Synchronize zoom level across all waveforms)
+MixtrackPlatinumFX.waveformsSynced = true;


why is that relevant for the mapping?

// need to zoom both channels if waveform sync is disabled in Mixxx settings. // and when it's enabled then no need to zoom 2nd channel, as it will cause // the zoom to jump 2 levels at once

I see I see. I think this would be better solved by introducing a CO that always zooms the CO in unison regardless of the preference setting. Can you file a feature request for that?

Swiftb0y · 2024-02-28T06:17:47Z

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

+    AUTOLOOP: 0x0D,
+    FADERCUTS: 0x07,
+    SAMPLE1: 0x0B,
+    BEATJUMP: 0x01, // DUMMY not used by controller


can you elaborate? what do you mean with not used by controller?

Beatjump is working on the map. It might just need correction to
BEATJUMP: 0x02

Swiftb0y · 2024-02-28T06:19:12Z

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

+// state variable, don't touch
+MixtrackPlatinumFX.shifted = false;
+
+MixtrackPlatinumFX.initComplete=false;


would be nice to remove this. its a rather ugly workaround and fixing the root problem would be better.

I will need more research or help on this.

I'll try to find some time to look into it. I'm just saying its a code smell for now.

Swiftb0y · 2024-02-28T06:23:27Z

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

+// status, extra 04 is just more device id, not sure what the 05 is
+//F0 00 20 04 7F 03 01 05 F7
+
+// wake (not sure what the extra 07 is for?
+//F0 7E 00 07 06 01 F7
+
+// I think these are the dial updates
+//F0 00 20 04 7F 02 02 04 08 00 00 04 00 00 00 05 F7
+//F0 00 20 04 7F 04 01 04 00 00 00 04 00 00 00 05 F7
+//F0 00 20 04 7F 02 04 04 08 00 00 04 00 00 00 07 00 00 F7
+//F0 00 20 04 7F 03 02 04 08 00 00 04 00 00 00 05 F7
+//F0 00 20 04 7F 03 04 04 08 00 00 04 00 00 00 07 00 00 F7
+//F0 00 20 04 7F 01 04 04 08 00 00 04 00 00 00 07 00 00 F7
+//F0 00 20 04 7F 04 04 04 08 00 00 04 00 00 00 07 00 00 F7
+


not sure how relevant this is for you, but I've reverse-engineered this all already. https://github.com/mixxxdj/mixxx/pull/11075/files#diff-39ced933348af25b914ee7fcd0d44355bb001d6151fb8781d7aca1471e304d52R3-R42

I will need more research or help on this.

The comment now just posts some messages, the link I shared has some extra info that explains them in better detail. I think some of this code could be better rewritten by salvaging code from that mapping, such as NS6II.numberToSysex and NS6II.Display.

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

Swiftb0y · 2024-02-28T06:40:04Z

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

+MixtrackPlatinumFX.bpms = []; 
+MixtrackPlatinumFX.trackBPM = function(value, group, _control) {
+	// file_bpm always seems to be 0?
+	// this doesn't work if we have to scan for bpm as it will be zero initially
+	// so we hook into the bpm change as well, and if we have 0 then set it to the first value seen (in bpm output)
+	MixtrackPlatinumFX.bpms[script.deckFromGroup(group) - 1] = engine.getValue(group,"bpm");
+}


this should be removed. Either store the BPM along with the component or query it directly with engine.getValue when you need it.

I can not reproduce the file_bpm issue mentioned here.

Also, avoid script.deckFromGroup(group) if possible. its slow. Also indexing into some array like here MixtrackPlatinumFX.bpms[script.deckFromGroup(group) - 1] is usually a sign that some feature could've been implemented much better directly using components. So keep an eye out for that.

Will check this..

Swiftb0y · 2024-02-28T06:49:53Z

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

+// TODO in 2.3 it is not possible to "properly" map the FX selection buttons.
+// this should be done with load_preset and QuickEffects instead (when effect
+// chain preset saving/loading is available in Mixxx)
+MixtrackPlatinumFX.EffectUnit = function(deckNumber) {    
+    this.effects = [false, false, false];
+    this.isSwitchHolded = false;
+


this todo and implementation is now obsolete since you're targetting mixxx 2.4 and loaded_chain_preset is available (just not yet documented, PR is in progress though, see the preview below).

https://deploy-preview-612--mixxx-manual.netlify.app/chapters/appendix/mixxx_controls#control-[QuickEffectRack1_[ChannelI]]-loaded_chain_preset

WIll check on this..

Swiftb0y · 2024-02-28T06:55:33Z

Also please take care of the eslint issues. Do you need help with setting that up? Also, you should probably create a new branch for this mapping, otherwise you will get problems down the line (the "don't commit to branch" pre-commit hook should've prevented you from this, but it seems you don't have pre-commit set up).

Swiftb0y · 2024-02-28T06:56:30Z

Here's my template response that contains some links that should get you started with pre-commit:

Please understand that in order for us to be able to merge this, your contribution need to follow our style guide. Most of the required changes can be made automatically by use of pre-commit. Please set up pre-commit and make sure to manually apply the required changes using pre-commit run --from-ref 2.4 --to-ref HEAD. Thank you very much.

evoixmr · 2024-02-28T15:07:24Z

@Swiftb0y The mapping and manual started as a community work, I am the only one remaining that is still working on both. I'm actually working remotely and can't really setup to work on this locally. My time is also limited but this mapping is the community has been past due. I actually need all the help I can get. I really appreciate your feedback.

Swiftb0y · 2024-02-28T18:16:35Z

I'm actually working remotely and can't really setup to work on this locally.

Thats fine. May I ask for some more details on your setup so I can determine whats the best way to proceed then?

I actually need all the help I can get.

Sure sure, no problem. I suggest you start by trying to address my previous comments and if you have trouble implementing them, reply in the relevant thread and I can go into more detail if necessary.

…ixtrack-Platinum-FX-scripts.js Co-authored-by: Swiftb0y <[email protected]>

Co-authored-by: Swiftb0y <[email protected]>

evoixmr · 2024-02-28T21:38:16Z

Thats fine. May I ask for some more details on your setup so I can determine whats the best way to proceed then?

On weekdays, I'm mostly on android device.
On weekends, Arch Linux LTS desktop or Debian Trixie laptop

Sure sure, no problem. I suggest you start by trying to address my previous comments and if you have trouble implementing them, reply in the relevant thread and I can go into more detail if necessary.

Updated.

Swiftb0y · 2024-02-29T17:12:22Z

On weekdays, I'm mostly on android device.
On weekends, Arch Linux LTS desktop or Debian Trixie laptop

What kind of work can you do from your android device and what can you from your arch/debian setups? Interacting with git? cloning the repo? compiling code?

ronso0 · 2024-03-11T13:07:44Z

I understand that (and I understand you don't want to drop your current implementation unless strictly necessary ; ) but I think it would be much simpler: Browse and Tap are close and it would be consistent to use the same logic for both.

(note that I don't insist on this, just want to share my thoughts for other reviewers to consider)

evoixmr · 2024-03-11T13:41:01Z

If I use shift+BPM to select the deck, I will need to use BPM to reset both decks, no way to of selecting which deck to reset.

I updated the manual on the BPM's instruction (item# 23).

ronso0 · 2024-03-11T14:14:00Z

If I use shift+BPM to select the deck, I will need to use BPM to reset both decks, no way to of selecting which deck to reset.

I thought of Shift (hold) + Tap longpress to do the reset. Wouldn't that also read left/right Shift?
Though no need to complicate things as long as the instructions are clear and the workflow is intuitive. I don't have this controller so I can't test the mapping.

evoixmr · 2024-03-11T14:43:53Z

Left/Right - Shift (hold) + Tap longpress to do the reset. - I will work on this on my next update, Hopefully target mixxx target 2.4.2.

I actually have an updated mapping that can switch the time elapse/remaining (using shift+play), This is being tested on the community now.

I will include both on my next update. Targeting one of the future releases.

Fix for pad mode buttons staying blinking when using multiple shift+pad mode.

Long press on pad mode did not work on 2.4, this is working now.

daschuer · 2024-09-15T19:33:03Z

@ronso0 What is the review status here?

ronso0 · 2024-10-21T10:59:25Z

I only tried to make some sugestions to improve the workflow. I think @Swiftb0y was reviewing the code.

ywwg · 2024-11-27T15:24:17Z

@Swiftb0y any updates on this? I know it's a huge PR

Swiftb0y · 2024-11-27T16:19:24Z

well, most of the comments I made previously have stalled. I can try to take another swing at this if @evoixmr is available.

evoixmr · 2024-11-28T14:58:50Z

well, most of the comments I made previously have stalled. I can try to take another swing at this if @evoixmr is available.

@Swiftb0y I'm still here. I was hoping for milestone 2.4.2.

Swiftb0y · 2024-11-28T15:05:27Z

Great. I'll try to take another look in the next couple days. Remind me in case I forget.

evoixmr · 2025-01-13T16:41:18Z

@Swiftb0y Can we move forward on the next update?

ronso0 · 2025-01-24T01:15:34Z

@Swiftb0y do you have time to review this?

I'm hesitant to change the base to 2.5, don't know how this affects the review convos.

ywwg · 2025-01-24T20:07:57Z

Changing target should not affect the existing conversations.

ronso0 · 2025-01-24T23:28:06Z

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

+        if (MixtrackPlatinumFX.tapChangesTempo) {
+            this.tap = new components.Button({
+                unshift: function() {
+                    this.disconnect();
+                    this.input = function(channel, control, value, _status, _group) {
+                        const tapch=MixtrackPlatinumFX.activeForTap(value)+1;
+                        if (tapch) {
+                            if (value>0) {
+                                const prelen = bpm.tap.length;
+                                const predelta = bpm.previousTapDelta;
+                                bpm.tapButton(tapch);
+                                // if the array reset, or changed then the tap was "accepted"
+                                if ((bpm.tap.length===0) || (bpm.tap.length!==prelen) || predelta!==bpm.previousTapDelta) {
+                                    this.send(this.outValueScale(value));
+                                } else {
+                                    this.send(0);
+                                }
+                            } else {
+                                this.send(this.outValueScale(value));
+                            }
+                        }
+                    };
+                },


Just a note:
by now (Mixxx 2.5) there is tempo_tap #12104

Swiftb0y

Hey @evoixmr. I'm terribly sorry for putting this off until now. Where do you want to continue? Should we polish this or do you just want get it merged asap? Do you have time/motivation for follow up PRs?

Swiftb0y · 2025-01-26T16:49:17Z

res/controllers/Numark-Mixtrack-Platinum-FX-scripts.js

+// FX toggles
+MixtrackPlatinumFX.toggleFXControlEnable = true;
+MixtrackPlatinumFX.toggleFXControlSuper = false;
+
+MixtrackPlatinumFX.shiftBrowseIsZoom = false;
+
+// setting this to false sets tap the file bpm, but without a way to reset its dangerous
+MixtrackPlatinumFX.tapChangesTempo = true;
+


we have UI support for some of these now: https://github.com/mixxxdj/mixxx/wiki/midi%20scripting#settings-api

Are you interested in refactoring accordingly?

It would ne nice to get it merged , this PR is almost a year old. Yes I can work on future PR.

Refactoring? Does it need to be done through XML?

well, you need to declare your settings in the XML and then you can query them in the JS mapping using engine.getSetting("key"). So while the majority of changes are in the XML, some JS changes are required to actually query the data. There are already a couple mappings implementing this if you'd like to work of some concrete examples.

Can we leave as is for now and merge first? The mapping has been tested by multiple user on 2.5 without any issue.

Swiftb0y

While the code quality is not perfect, its above average and thus I'm okay with merging. Next we need to make sure the manual page is ready.

ronso0 · 2025-02-11T22:10:39Z

Just merged the manual.

Thanks @evoixmr for your patience!

Add files via upload

484edd6

github-actions bot added the controllers label Feb 26, 2024

ronso0 changed the title ~~Mapping for Numark Platinum FX for Mixxx 2.4~~ Mapping for Numark Platinum FX Feb 26, 2024

Update Numark-Mixtrack-Platinum-FX-scripts.js

730c0c8

evoixmr added 2 commits February 26, 2024 17:15

Update Numark Mixtrack Platinum FX.midi.xml

e554376

Update 1.1 Numark-Mixtrack-Platinum-FX-scripts.js

aed1123

Corrected codespell error Numark-Mixtrack-Platinum-FX-scripts.js

3b5f5eb

Swiftb0y reviewed Feb 28, 2024

View reviewed changes

evoixmr marked this pull request as draft February 28, 2024 14:47

evoixmr mentioned this pull request Feb 28, 2024

Fix warning messages about deprecated keys BSDguy389/Numark-Mixtrack-Platinum-FX-Mapping#1

Merged

evoixmr and others added 4 commits February 28, 2024 14:28

Update shifBrowseIsZoom to shiftBrowseIsZoom res/controllers/Numark-M…

6f8f0b0

…ixtrack-Platinum-FX-scripts.js Co-authored-by: Swiftb0y <[email protected]>

Update shifBrowseIsZoom to shiftBrowseIsZoom

1a0ed68

" + deckNumber + " to ${deckNumber}

ea4a29c

" + deckNumber + " to ${deckNumber}

f4f6390

Co-authored-by: Swiftb0y <[email protected]>

evoixmr added 2 commits February 28, 2024 17:35

Update Numark-Mixtrack-Platinum-FX-scripts.js

b6e46a7

Merge branch 'mixxxdj:2.4' into 2.4

3f865d2

ronso0 added this to the 2.4.2 milestone Apr 13, 2024

daschuer added controller mappings and removed controllers labels Jun 25, 2024

evoixmr added 2 commits July 14, 2024 17:05

Update Numark-Mixtrack-Platinum-FX-scripts.js

bb30730

Fix for pad mode buttons staying blinking when using multiple shift+pad mode.

Corrected pad mode long press functionality for Mixxx 2.4

7de5e7a

Long press on pad mode did not work on 2.4, this is working now.

daschuer modified the milestones: 2.4.2, 2.5.0 Nov 27, 2024

JoergAtGithub modified the milestones: 2.5.0, 2.5.1 Dec 16, 2024

evoixmr requested a review from Swiftb0y January 16, 2025 23:55

ronso0 changed the base branch from 2.4 to 2.5 January 24, 2025 21:42

ronso0 reviewed Jan 24, 2025

View reviewed changes

Swiftb0y reviewed Jan 26, 2025

View reviewed changes

Swiftb0y approved these changes Jan 29, 2025

View reviewed changes

ronso0 merged commit 42401fe into mixxxdj:2.5 Feb 11, 2025
14 checks passed

evoixmr deleted the 2.4 branch February 12, 2025 17:02

Mapping for Numark Platinum FX #12872

Mapping for Numark Platinum FX #12872

Conversation

evoixmr commented Feb 26, 2024 • edited Loading

ronso0 commented Feb 26, 2024

ronso0 commented Feb 26, 2024 • edited Loading

evoixmr commented Feb 26, 2024

JoergAtGithub commented Feb 26, 2024

evoixmr commented Feb 26, 2024 • edited Loading

evoixmr commented Feb 26, 2024

ronso0 commented Feb 26, 2024

evoixmr commented Feb 27, 2024

Swiftb0y left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Swiftb0y commented Feb 28, 2024

Swiftb0y commented Feb 28, 2024

evoixmr commented Feb 28, 2024

Swiftb0y commented Feb 28, 2024

evoixmr commented Feb 28, 2024 • edited Loading

Swiftb0y commented Feb 29, 2024

ronso0 commented Mar 11, 2024 • edited Loading

evoixmr commented Mar 11, 2024

ronso0 commented Mar 11, 2024

evoixmr commented Mar 11, 2024 • edited Loading

daschuer commented Sep 15, 2024

ronso0 commented Oct 21, 2024

ywwg commented Nov 27, 2024

Swiftb0y commented Nov 27, 2024

evoixmr commented Nov 28, 2024 • edited Loading

Swiftb0y commented Nov 28, 2024

evoixmr commented Jan 13, 2025

ronso0 commented Jan 24, 2025

ywwg commented Jan 24, 2025

Choose a reason for hiding this comment

Swiftb0y left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evoixmr Jan 29, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Swiftb0y left a comment

Choose a reason for hiding this comment

ronso0 commented Feb 11, 2025

evoixmr commented Feb 26, 2024 •

edited

Loading

ronso0 commented Feb 26, 2024 •

edited

Loading

evoixmr commented Feb 26, 2024 •

edited

Loading

evoixmr commented Feb 28, 2024 •

edited

Loading

ronso0 commented Mar 11, 2024 •

edited

Loading

evoixmr commented Mar 11, 2024 •

edited

Loading

evoixmr commented Nov 28, 2024 •

edited

Loading

evoixmr Jan 29, 2025 •

edited

Loading