Expose [BPM],sync_lock_algorithm option in deck preferences. #11828

daschuer · 2023-08-14T01:00:47Z

Unfortunately this is still required to have a reliable transition with non const beat-grids like in 2.3.

This has been a hidden preferences option introduced here: #3698 as a workaround until unstable / dynamic outro tempos have been fixed, which never happens.
Details have been discussed here: https://mixxx.zulipchat.com/#narrow/stream/109171-development/topic/sync.20lock.20with.20variable.20tempo.20tracks

With the later improvements we have already introduced and #11831 applied this works now very good for me. You can pick "Follow implicit leader" if you have only a few tracks with non const beat grids, or "Use steady Tempo" if all are non const. This way are safe from messed up transitions. Both modes allow to change that behaviour on the fly by making the on of the tracks or the internal clock the explicit leader.

The tooltips are:

Follow implicit leader's tempo:
Apply tempo changes from a soft leading track (normally the previous track in a transition) to the follower tracks. After the transition, the follower track will continue with the previous leader's very last tempo. Changes from explicit selected leaders are always applied.

Use steady Tempo:
The tempo of a previous soft leader track at the beginning of the transition is kept steady. After the transition, the follower track will maintain this original tempo. This technique serves as a workaround to avoid dynamic tempo changes, as seen in rubato-style tracks, during the outro. For instance it prevents the follower track from continuing with a slowed-down tempo of the soft leader. This corresponds to the behavior before Mixxx 2.4. Changes from explicit selected leaders are always applied.

Unfortunately this is still required to have a reliable transition with non const beat-grids like in 2.3.

Holzhaus · 2023-08-14T19:00:58Z

src/engine/sync/enginesync.h

+    // and editing code is committed and we no longer need the lock bpm fallback option.
+    enum SyncLockAlgorithm {
+        // New behavior, which should work if beatgrids are reliable.
+        PREFER_SOFT_LEADER,


I'm not sure if I'm missing something, but isn't it irrelevant if the leader is implicit/soft or explicit?

Suggested change

PREFER_SOFT_LEADER,

PREFER_LEADER,

The explicit leader (full crown symbol) is always preferred. This feature is about the automatically selected soft leader.
"Shall the follower follow a dynamic tempo or should both follow a steady tempo?"

Currently this preferences option is designed to be extensible for more features that will come on the table once we have rhythm detection implemented.
Does it make sense to decouple it?

daschuer · 2023-08-15T05:40:41Z

Initial description and screenshot updated.

ronso0

just some twekas. Still not a native speaker, but it feels a bit better.

src/preferences/dialog/dlgprefdeckdlg.ui

ronso0 · 2023-08-21T21:15:00Z

Sure it's okay to have explanatory tooltips for now, but all that info deserves its own chapter in the manual. We could link to that like we do for the Cue modes.

A few more bits should be clarified IMHO, for example how does Mixxx know when a transition starts? Crossfader, channel fader, effective ratio in the main mix, or some combination?

Co-authored-by: ronso0 <ronso0@mixxx.org>

src/engine/sync/enginesync.h

Swiftb0y · 2023-09-10T11:04:26Z

src/preferences/dialog/dlgprefdeck.cpp

+    const EngineSync::SyncLockAlgorithm syncLockAlgorithm =
+            static_cast<EngineSync::SyncLockAlgorithm>(m_pConfig->getValue<int>(
+                    ConfigKey(BPM_CONFIG_GROUP, SYNC_LOCK_ALGORITHM_CONFIG_KEY),
+                    EngineSync::SyncLockAlgorithm::PREFER_SOFT_LEADER));


Seeing this snippet while starting the review a couple weeks ago was the entire reason for why I implemented #11883 😅
Please update this and the snippet below when merging to main.

daschuer · 2023-10-10T21:52:58Z

The manual can be found here: mixxxdj/manual#589

ronso0

LGTM, just a proposal for the tooltip.

src/skin/legacy/tooltips.cpp

Co-authored-by: ronso0 <ronso0@mixxx.org>

ronso0 · 2023-10-16T21:34:10Z

@Holzhaus @Swiftb0y do you have any remarks?

Swiftb0y

previous comments still apply as well, lgtm otherwise.

src/skin/legacy/tooltips.cpp

daschuer · 2023-11-11T19:10:08Z

This is ready for merge.

ronso0

LGTM, thank you!

ronso0 · 2023-11-13T09:41:11Z

src/defs_urls.h

@@ -53,6 +53,8 @@
    MIXXX_MANUAL_URL "/chapters/preferences.html#library"
 #define MIXXX_MANUAL_CUE_MODES_URL \
    MIXXX_MANUAL_URL "/chapters/user_interface.html#using-cue-modes"
+#define MIXXX_MANUAL_SYNC_MODES_URL \
+    MIXXX_MANUAL_URL "/chapters/user_interface.html#sync-and-rate-controls"


Now that ___ has been merged, we should link to https://manual.mixxx.org/2.4/chapters/djing_with_mixxx#sync-lock-with-dynamic-tempo

Btw, when I click the (?) link I end up at https://manual.mixxx.org/2.4/chapters/user_interface.html#sync-and-rate-controls + X * PageDown (at the effects section)

ronso0 · 2023-11-16T09:06:37Z

Thank you!

Expose [BPM],sync_lock_algorithm option in deck preferences.

a320ada

Unfortunately this is still required to have a reliable transition with non const beat-grids like in 2.3.

github-actions bot added the ui label Aug 14, 2023

daschuer changed the base branch from main to 2.3 August 14, 2023 01:01

daschuer changed the base branch from 2.3 to 2.4 August 14, 2023 01:01

daschuer added the regression label Aug 14, 2023

daschuer added this to the 2.4.0 milestone Aug 14, 2023

Use Term Soft Leader to match other parts in the code

92bdfa1

ronso0 requested a review from ywwg August 14, 2023 12:58

Holzhaus reviewed Aug 14, 2023

View reviewed changes

Extend tooltips

636434b

daschuer mentioned this pull request Aug 15, 2023

Pitch of deck 1 is changing when skipping on paused deck 2 #11788

Closed

ronso0 reviewed Aug 21, 2023

View reviewed changes

src/preferences/dialog/dlgprefdeckdlg.ui Outdated Show resolved Hide resolved

src/preferences/dialog/dlgprefdeckdlg.ui Outdated Show resolved Hide resolved

Improve tooltips

5ee1c71

Co-authored-by: ronso0 <ronso0@mixxx.org>

daschuer removed the request for review from ywwg September 9, 2023 21:10

daschuer added 2 commits September 10, 2023 00:16

Add manual link to Sync mode label in prefrences

edc5d01

Extend the sync_leader tooltip

4b6e4be

Swiftb0y reviewed Sep 10, 2023

View reviewed changes

daschuer force-pushed the sync_lock_algorithm branch from 1549eda to dcfc9e2 Compare October 16, 2023 19:22

Use constants instead of macros

783c041

daschuer force-pushed the sync_lock_algorithm branch from dcfc9e2 to 783c041 Compare October 16, 2023 20:36

ronso0 approved these changes Oct 16, 2023

View reviewed changes

src/skin/legacy/tooltips.cpp Outdated Show resolved Hide resolved

Improve tooltips

51af7c4

Co-authored-by: ronso0 <ronso0@mixxx.org>

Swiftb0y reviewed Oct 17, 2023

View reviewed changes

src/skin/legacy/tooltips.cpp Show resolved Hide resolved

ronso0 approved these changes Nov 13, 2023

View reviewed changes

ronso0 reviewed Nov 13, 2023

View reviewed changes

daschuer added 2 commits November 16, 2023 08:07

Adjust link to the manual

72d5d84

Merge remote-tracking branch 'upstream/2.4' into sync_lock_algorithm

bd77c26

ronso0 merged commit a89f676 into mixxxdj:2.4 Nov 16, 2023
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose [BPM],sync_lock_algorithm option in deck preferences. #11828

Expose [BPM],sync_lock_algorithm option in deck preferences. #11828

daschuer commented Aug 14, 2023 •

edited

Holzhaus Aug 14, 2023

daschuer Aug 15, 2023 •

edited

daschuer Aug 15, 2023

daschuer commented Aug 15, 2023

ronso0 left a comment

ronso0 commented Aug 21, 2023 •

edited

Swiftb0y Sep 10, 2023

daschuer commented Oct 10, 2023

ronso0 left a comment

ronso0 commented Oct 16, 2023

Swiftb0y left a comment

daschuer commented Nov 11, 2023

ronso0 left a comment

ronso0 Nov 13, 2023

ronso0 commented Nov 16, 2023

Expose [BPM],sync_lock_algorithm option in deck preferences. #11828

Expose [BPM],sync_lock_algorithm option in deck preferences. #11828

Conversation

daschuer commented Aug 14, 2023 • edited

Holzhaus Aug 14, 2023

Choose a reason for hiding this comment

daschuer Aug 15, 2023 • edited

Choose a reason for hiding this comment

daschuer Aug 15, 2023

Choose a reason for hiding this comment

daschuer commented Aug 15, 2023

ronso0 left a comment

Choose a reason for hiding this comment

ronso0 commented Aug 21, 2023 • edited

Swiftb0y Sep 10, 2023

Choose a reason for hiding this comment

daschuer commented Oct 10, 2023

ronso0 left a comment

Choose a reason for hiding this comment

ronso0 commented Oct 16, 2023

Swiftb0y left a comment

Choose a reason for hiding this comment

daschuer commented Nov 11, 2023

ronso0 left a comment

Choose a reason for hiding this comment

ronso0 Nov 13, 2023

Choose a reason for hiding this comment

ronso0 commented Nov 16, 2023

daschuer commented Aug 14, 2023 •

edited

daschuer Aug 15, 2023 •

edited

ronso0 commented Aug 21, 2023 •

edited