Controllers: Don't needlessly copy presets into user directory #2569

Holzhaus · 2020-03-19T16:37:43Z

~~Based on PR: #2567~~

For XML, we now check if the preset has been edited and only save it to the user directory in that case. Since we don't allow to edit JavaScript from within Mixxx, these are never copied anymore.

Now I can actually use Mixxx with an empty ~/.mixxx/controllers/ directory 🎉

uklotzde · 2020-03-19T18:59:35Z

The copying and duplicate devices in the list boxes with the same name cause so much confusion, even for me. This would be a huge improvement!

uklotzde · 2020-03-19T19:05:11Z

I guess this should to be included in 2.3.0?

ronso0 · 2020-03-19T19:23:44Z

I didn't built this, yet.
How's the workflow now if I want to alter the js file only?

Holzhaus · 2020-03-19T20:21:34Z

I didn't built this, yet.
How's the workflow now if I want to alter the js file only?

I think you can just edit the file and save it in ~/.mixxx/controllers/.

Holzhaus · 2020-03-19T20:23:35Z

I guess this should to be included in 2.3.0?

I wasn't sure since @ywwg was keen on reducing the scope of 2.3. If nobody encounters any problems during testing I'd like to get this merged ASAP though ;-)

Be-ing · 2020-03-23T02:33:21Z

Thank you for working on this obnoxious UX issue.

I guess this should to be included in 2.3.0?

Ehhh maybe we shouldn't rush this. We have enough on our plate for 2.3.

Holzhaus · 2020-03-25T09:11:30Z

I'd propose this for 2.3 (not as a blocker though) because it makes controller mapping development much easier. Right now, you can't really develop controller mappings from the git source tree, because Mixxx will always copy them to the user directory. On the wiki, we recommend symlinking ~/.mixxx/controllers to <gitroot>/res/controllers, but the XML file will be copied anyway, so you need to change the controller mapping every time you restart mixxx.

You can still develop from the user directory, but then there is no way to use pre-commit hooks.

goddisignz · 2020-04-03T12:22:57Z

Awesome! I recently started working on a component based mapping for the Pioneer DDJ-SX2. I rebased your PR onto my working branch and everything is going so much smoother now.
😎

Holzhaus · 2020-04-04T23:59:16Z

Awesome! I recently started working on a component based mapping for the Pioneer DDJ-SX2. I rebased your PR onto my working branch and everything is going so much smoother now.

Great! I hope we can get this reviewed and merged before we branch off 2.3. This makes it possible to develop mappings inside the git repo and use the pre-commit hooks to ensure proper code style.

Holzhaus · 2020-04-08T19:27:29Z

The Controller page now has a working (!) apply button. Before, mappings would be applied instantly when selecting it on the combobox. Please test.

Be-ing · 2020-04-08T19:39:00Z

src/controllers/dlgprefcontroller.cpp

+        m_ui.chkEnabledDevice->setEnabled(false);
+    } else {
+        // User picked a preset
+        m_ui.chkEnabledDevice->setEnabled(true);


add
m_ui.chkEnabledDevice->setChecked(true);

Hmm, so that selecting a preset means activating the controller? In that case we can remove the enabled checkbox completely and just use "no preset" for disabled controllers.

Is there a use case for keeping a mapping selected but disabling the controller? The only time I have needed to disable and re-enable a controller was when the USB cable came unplugged during a set.

Wait, this works? I always restarted mixxx in that case.

Indeed, it does. It's not obvious at all though.

Hmm, thats a good idea but maybe we should leave it as-is for 2.3. Users that upgrade from 2.2 will have a preset defined for all controllers because Mixxx was writing custom presets everywhere. This means that all controllers would be active.

During development I made a little mistake that also activated all controllers - this made both my keyboard and my mouse unresponsive since they are also HID devices. I had to restart X11 via SSH to make my computer usable again 😕

Oof, yeah. I was wondering if those legacy files laying in the user folders would have consequences. They sure would if we automatically enabled them. I still think it would help to add m_ui.chkEnabledDevice->setChecked(true); here in slotPresetSelected so users don't have to think about that checkbox.

I think we can do this without automatically activating those legacy presets in the user folder. Here is what a fresh mixxx.cfg looks like from master after activating one of my Xone K2s:

Babyface_Pro_(70785713)_MIDI_1 /home/be/.mixxx/controllers/Babyface_Pro_(70785713)_MIDI_1.midi.xml Babyface_Pro_(70785713)_MIDI_2 /home/be/.mixxx/controllers/Babyface_Pro_(70785713)_MIDI_2.midi.xml XONE:K2_MIDI_1 /home/be/.mixxx/controllers/Allen and Heath Xone K2.midi.xml [Controller] XONE:K2_MIDI_1 1

I propose still relying on the [Controller] ConfigKey to determine which controllers to enable on Mixxx startup. Then automatically enable the ConfigKey for a device when a preset is applied. This would allow us to get rid of the Enabled checkbox. I would still want a Reconnect button.

Ok, this sounds like it could work. However, let's do this in a separate PR, this one is already big enough and I have the impression that PRs always take a few days without any new commits before they get merged here 😉

Be-ing · 2020-04-08T19:47:08Z

The buttons to add and remove entries from the Input Mapping and Output Mapping tables have disappeared??

Holzhaus · 2020-04-08T20:27:14Z

The buttons to add and remove entries from the Input Mapping and Output Mapping tables have disappeared??

No, I didn't touch them and they are still there.

src/controllers/controller.h

Be-ing · 2020-04-08T20:32:51Z

master:

this branch:

Add, Remove, and Clear All buttons have disappeared

Holzhaus · 2020-04-08T20:35:36Z

Is that a scrollbar on the right side of the window?

Be-ing · 2020-04-08T20:37:33Z

Ah, they are hidden by the vertical scrollbar. How did that happen?

Holzhaus · 2020-04-08T20:41:05Z

I have no idea. I didn't touch the UI files. I just built this on my laptop, this is how it looks for me:

Be-ing · 2020-04-08T20:41:36Z

I'm doing a git bisect...

daschuer

Some more comments

src/controllers/controllerinputmappingtablemodel.h

src/controllers/controllermanager.cpp

Be-ing · 2020-04-08T21:34:58Z

After some more testing, I can sometimes reproduce the vertical scrollbar issue with the Inputs/Outputs tabs with master, so it is not a regression introduced by this branch and there is no need to fix it here. I am not sure why it appears sometimes but other times it does not. Maybe @ronso0 has some idea about it?

…es-part2

This allows editing user controller scripts (e.g. downloaded from the forum) as well.

src/controllers/dlgprefcontroller.cpp

…esets

Holzhaus · 2020-04-09T10:55:24Z

There's still a lot that could be done to improve handling of controllers in Mixxx, but I consider this PR ready to merge. Please test.

Be-ing · 2020-04-09T15:40:16Z

Great work! Thanks for cleaning up this mess :)

ghost · 2020-04-16T14:24:46Z

I still have a question. So what is the workflow if I want to modify the mapping? Do it in the mixxx's controllers folder?

ronso0 · 2020-04-16T14:36:01Z

As soon as you change a control in Pref > Controllers > YourController > In/Output mapppings the default mapping XML is copied to the controllers folder. (js mapping still has to be copied there manually)

If you want change a mapping for a PR you can simply work in the git res/controllers folder.

Holzhaus added 11 commits March 18, 2020 23:17

controllers/controllermanager: Make use of the getPresetPaths() function

66585a6

controllers/controllermanager: Rename function to sanitizeString

05f7ce4

controllers/controllermanager: Rework device setup code

d7269cf

controllers: Preselect configured mapping in preferences if available

8813212

controllers/dlgprefcontroller: Fix reset of combobox item on apply

29b1df8

controllers/controllerpresetinfo: Remove unused header file

2e314f5

controllers/dlgprefcontroller: Separate user and system presets

bc92e0d

controllers/controllermanager: Always write preset to config on exit

2730b6a

controllers/midi: Make MidiControllerPreset's mappings private

8b46ef0

controllers: Only write preset to user directory if it's dirty

436cd88

controllers/dlgprefcontroller: Don't import scripts into user directory

7f08658

Holzhaus added the controller mappings label Mar 19, 2020

Be-ing added this to the 2.4.0 milestone Mar 23, 2020

Holzhaus removed this from the 2.4.0 milestone Mar 25, 2020

Holzhaus added beta non-blocker and removed beta non-blocker labels Mar 27, 2020

Holzhaus added this to In progress in 2.3 release via automation Apr 2, 2020

Holzhaus added this to the 2.3.0 milestone Apr 2, 2020

Holzhaus moved this from In progress to In Review in 2.3 release Apr 2, 2020

Be-ing removed the beta non-blocker label Apr 5, 2020

Be-ing reviewed Apr 8, 2020

View reviewed changes

daschuer reviewed Apr 8, 2020

View reviewed changes

src/controllers/controller.h Outdated Show resolved Hide resolved

daschuer requested changes Apr 8, 2020

View reviewed changes

src/controllers/controllerinputmappingtablemodel.h Outdated Show resolved Hide resolved

src/controllers/controllermanager.cpp Outdated Show resolved Hide resolved

src/controllers/controllermanager.cpp Show resolved Hide resolved

Holzhaus added 3 commits April 8, 2020 23:46

controllers/controllermanager: Return QFileInfo in findPresetFile()

54c38e1

Merge branch 'master' of github.com:mixxxdj/mixxx into controller-fix…

9dc6ff7

…es-part2

controllers/dlgprefcontroller: Add edited suffix to filenames

00ad201

This allows editing user controller scripts (e.g. downloaded from the forum) as well.

Be-ing reviewed Apr 8, 2020

View reviewed changes

src/controllers/dlgprefcontroller.cpp Outdated Show resolved Hide resolved

Holzhaus added 2 commits April 9, 2020 02:12

controllers/dlgprefcontroller: Tick Enabled checkbox on preset change

419ccf4

controllers/dlgprefcontroller: Display "No scripts" for scriptless pr…

b9079e0

…esets

Holzhaus requested a review from ronso0 April 9, 2020 09:25

controllers: Fix comments and include guards

4760291

Be-ing merged commit fec775d into mixxxdj:master Apr 9, 2020

2.3 release automation moved this from In Review to Done Apr 9, 2020

Holzhaus mentioned this pull request Apr 18, 2020

Resolve merge conflicts with master branch ferranpujolcamins/mixxx#16

Closed

This was referenced Aug 22, 2022

Multiple identical MIDI devices / controllers not auto-activated at startup #8357

Closed

Shift: Infinite recursion in midi-components-0.0.js #9992

Closed

Strange files in %LOCALAPPDATA%\Mixxx\controllers #10142

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Controllers: Don't needlessly copy presets into user directory #2569

Controllers: Don't needlessly copy presets into user directory #2569

Holzhaus commented Mar 19, 2020 •

edited

uklotzde commented Mar 19, 2020

uklotzde commented Mar 19, 2020

ronso0 commented Mar 19, 2020

Holzhaus commented Mar 19, 2020

Holzhaus commented Mar 19, 2020

Be-ing commented Mar 23, 2020

Holzhaus commented Mar 25, 2020 •

edited

goddisignz commented Apr 3, 2020

Holzhaus commented Apr 4, 2020

Holzhaus commented Apr 8, 2020

Be-ing Apr 8, 2020

Holzhaus Apr 8, 2020

Be-ing Apr 8, 2020

Holzhaus Apr 8, 2020

Be-ing Apr 8, 2020

Holzhaus Apr 8, 2020 •

edited

Be-ing Apr 8, 2020

Be-ing Apr 8, 2020 •

edited

Holzhaus Apr 9, 2020

Be-ing Apr 9, 2020

Be-ing commented Apr 8, 2020

Holzhaus commented Apr 8, 2020

Be-ing commented Apr 8, 2020

Holzhaus commented Apr 8, 2020

Be-ing commented Apr 8, 2020

Holzhaus commented Apr 8, 2020

Be-ing commented Apr 8, 2020

daschuer left a comment

Be-ing commented Apr 8, 2020 •

edited

Holzhaus commented Apr 9, 2020

Be-ing commented Apr 9, 2020

ghost commented Apr 16, 2020

ronso0 commented Apr 16, 2020 •

edited

Controllers: Don't needlessly copy presets into user directory #2569

Controllers: Don't needlessly copy presets into user directory #2569

Conversation

Holzhaus commented Mar 19, 2020 • edited

uklotzde commented Mar 19, 2020

uklotzde commented Mar 19, 2020

ronso0 commented Mar 19, 2020

Holzhaus commented Mar 19, 2020

Holzhaus commented Mar 19, 2020

Be-ing commented Mar 23, 2020

Holzhaus commented Mar 25, 2020 • edited

goddisignz commented Apr 3, 2020

Holzhaus commented Apr 4, 2020

Holzhaus commented Apr 8, 2020

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

Holzhaus Apr 8, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Be-ing Apr 8, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Be-ing commented Apr 8, 2020

Holzhaus commented Apr 8, 2020

Be-ing commented Apr 8, 2020

Holzhaus commented Apr 8, 2020

Be-ing commented Apr 8, 2020

Holzhaus commented Apr 8, 2020

Be-ing commented Apr 8, 2020

daschuer left a comment

Choose a reason for hiding this comment

Be-ing commented Apr 8, 2020 • edited

Holzhaus commented Apr 9, 2020

Be-ing commented Apr 9, 2020

ghost commented Apr 16, 2020

ronso0 commented Apr 16, 2020 • edited

Holzhaus commented Mar 19, 2020 •

edited

Holzhaus commented Mar 25, 2020 •

edited

Holzhaus Apr 8, 2020 •

edited

Be-ing Apr 8, 2020 •

edited

Be-ing commented Apr 8, 2020 •

edited

ronso0 commented Apr 16, 2020 •

edited