replace Tempo module by an ableton-link synched clock that comes with tidal-link #1059

polymorphicengine · 2023-12-29T13:25:15Z

to make tidal-link and tidals clock functionality more widely useable (i.e. not dependend on types from tidal) i decided to reimplement the Tempo.hs module in a new module Sound.Tidal.Clock, that is part of tidal-link. The functionality is still the same, but i rewrote the code to make the clock independed of tidal and added an API so it can be used more easily.

i also restructured the code into a Clock monad, which is essentialy just the IO monad with some read-only memory for the configuration and mutable state, imo this makes the code much easier to comprehend and maintain.

i also rewrote some of the Stream and Transition modules to use the Clock instead of Tempo.hs, here i tried to make as little changes as possible, most of the code is exactly the same. the most notable changes are

streamReplace : updatePattern is no longer handled by the clock, it was only that way to tag the patterns with the time of evaluation, this time can be gotten from the clock through the API
streamFirst : onSingleTick is also no longer handled by the clock, the zeroedLinkOperations needed for the action can also be gotten through the clock API
transiton : also this function is no longer handled directly by the clock

the next step would be to restructure the Stream module, possibly splitting it into a couple of modules, maybe also rewriting Stream as an IO based monad.

what do you think @yaxu @Zalastax @mindofmatthew ?

…ly on tidals types and can act as a general purpose ableton link based clock for timed processes

…reintegrate everything

matthewkaney

Awesome! This makes sense to me. I've added some comments and questions I had, but overall I think this is a good direction to move in.

matthewkaney · 2023-12-29T21:11:24Z

tidal-link/src/hs/Sound/Tidal/Clock.hs

+              ,cQuantum = 4
+              ,cBeatsPerCycle = 4


Probably a @Zalastax questions, but what's the difference between cQuantum and cBeatsPerCycle? To me they seem redundant: if someone wants to define Tidal "bpm" in terms of a 4-beat cycle, is there a case where they wouldn't also want cycles phase-aligned with other 4-beat measures (loops, etc) on the network (which is what quantum is for)?

It's mostly redundant. I thought it could possibly be useful for some people but wasn't sure if it would be used. I was thinking people think of cycles in interesting and different ways and that I don't want to impose my way. It could also act as a workaround for the limits of Link BPM.

tidal-link/src/hs/Sound/Tidal/Clock.hs

src/Sound/Tidal/Stream.hs

tidal-link/src/hs/Sound/Tidal/Clock.hs

… see tidalcycles#1060

matthewkaney · 2023-12-30T18:58:35Z

Btw, can you update the BootTidal.hs file so that it's easier to test this branch?

Zalastax

One of my goals when I introduced Link was to sequentialize everything that can affect time. I did so by moving the handling of Transition and once into Tempo and putting everything in a queue which is processed between the processing of the normal clock. This is inspired by my experience with Erlang actors and I believe it often reduces bugs. We are here moving away from that pattern. I do see benefits with this new approach, like once happening more immediately and ClockActions being a cleaner interface. I also don't think the drawbacks are very significant and I notice I didn't even fully complete that vision because pmap is modified from multiple threads. So I quite like this change but wanted to provide some context. Might be room for some future tidying up, but not sure much benefits can be gained.

Zalastax · 2024-01-14T14:31:11Z

tidal-link/src/hs/Sound/Tidal/Clock.hs

+  }
+
+-- | possible actions for interacting with the clock
+data ClockAction


I like that this focuses the actions to be time related instead of the mix that TempoAction had.

Zalastax · 2024-01-14T14:59:43Z

src/Sound/Tidal/Transition.hs

@@ -37,11 +39,30 @@ import Sound.Tidal.Utils (enumerate)
    along with this library.  If not, see <http://www.gnu.org/licenses/>.
 -}

+type TransitionMapper = Time -> [ControlPattern] -> ControlPattern


matthewkaney · 2024-01-17T00:00:26Z

src/Sound/Tidal/Config.hs

@@ -25,31 +24,21 @@ data Config = Config {cCtrlListen :: Bool,
                      cCtrlAddr :: String,
                      cCtrlPort :: Int,
                      cCtrlBroadcast :: Bool,
-                      cFrameTimespan :: Double,
-                      cEnableLink :: Bool,
-                      cProcessAhead :: Double,
                      cTempoAddr :: String,
                      cTempoPort :: Int,
                      cTempoClientPort :: Int,


Maybe this PR would be a good place to get rid of cTempoAddr, cTempoPort and cTempoClientPort, since it's already changing the Config type? They're for a tempo-sharing mechanism that was replaced with Link, and are unused everywhere else.

polymorphicengine · 2024-02-23T17:30:52Z

i got around to the restructuring of the stream module now. it is seperated into 7 sub-modules now all of which are re-exported by the old Sound.Tidal.Stream module. They are:

Config, basically as before containing the config of the clock and the control listener
Types, basically the module StreamTypes, but including the Stream and Target definitions
Target, contains logic for creating targets, and sending messages to targets, aswell as the default dirt/superdirt targets
Process, defines doTick, which is the core logic of querying patterns at an arc and processing it's events into OSC messages which are then sent out to the tragets
UI, the exposed user interface into the stream logic, contains all functions for interacting with a given stream
Listen, function for interacting with the stream from outside via OSC
Main, brings the Process and Listen modules together to define startStream, aswell as startTidal

i didn't make any changes to the code yet, it was just a matter of copy and pasting things into the right places. hope this makes sense to you, let me know what you think! @mindofmatthew @yaxu @Zalastax

matthewkaney · 2024-02-24T20:49:20Z

This reorganization makes sense to me!

I was curious: are you thinking of doing a major restructuring of the Stream code in this PR? I could see it getting unwieldy, but since there are only a couple of us who will likely comment, I think it's manageable. If that's the case, would you mind if I submitted pull requests against your branch? I have some ideas of my own (eg #1051), and would generally be interested in helping out with the effort!

polymorphicengine · 2024-02-24T21:16:40Z

are you thinking of doing a major restructuring of the Stream code in this PR?

i thought about it, but i think we could actually close this PR if everyone is happy with it and then work on a new, seperate PR to actually make some changes to the code, aswell as add some things etc. maybe that would make it a bit cleaner. what do you think?

matthewkaney · 2024-02-26T21:21:54Z

That sounds good with me, although I'd wait to merge it in until we can get a 1.9.5 release out.

Unless @yaxu objects, then I'm going to look into merging the build fixes (#1062) and then releasing 1.9.5 later this week! In the meantime, I think you're safe to treat this PR as approved and start a new branch off of this one for a future Stream PR

yaxu · 2024-02-26T21:30:40Z

Hi sorry I'm still away from things until next week, but had a quick look and can't see anything controversial so please go ahead @mindofmatthew !

yaxu · 2024-04-09T10:56:57Z

Shall we merge this now?

matthewkaney · 2024-04-09T15:52:39Z

@yaxu Sounds great! Go ahead and do this before you do your branch tidying

polymorphicengine added 5 commits December 28, 2023 09:22

bump version and add dependencies

521212e

add clock module as a replacement for the Tempo.hs module. doesn't re…

96a2549

…ly on tidals types and can act as a general purpose ableton link based clock for timed processes

fix getLinkOperations

dcc7ddf

remove Tempo.hs in favor of the new Clock module from tidal-link and …

2817b22

…reintegrate everything

fix listener

02883d5

matthewkaney reviewed Dec 30, 2023

View reviewed changes

polymorphicengine added 4 commits December 30, 2023 16:25

change defaultCps to Double

e73b570

move tickAction outside of config

95b1763

fix dontcrash

cf95e13

add ability to enable/disable link clock and make default link False,…

3fedf10

… see tidalcycles#1060

polymorphicengine added 3 commits December 30, 2023 20:10

fix bootfile

cbf79f7

catch errors in streamReplace

8548cb7

switch to TVars to avoid race conditions

3e4f864

Zalastax approved these changes Jan 14, 2024

View reviewed changes

matthewkaney reviewed Jan 17, 2024

View reviewed changes

polymorphicengine added 2 commits February 23, 2024 14:24

move everything stream related to it's own folder

4e7b4eb

complete restructuring of the stream module into separate sub modules

8d6bf14

matthewkaney mentioned this pull request Feb 27, 2024

Split controller OSC off from SuperDirt handshake OSC (Redux for 1.9) #1051

Open

Merge branch '1.10-dev-clock' into 1.9-dev-clock

5b33d3a

yaxu merged commit 997e3f7 into tidalcycles:1.10-dev Apr 9, 2024
22 checks passed

This was referenced Apr 12, 2024

BootTidal.hs breaking change + use of defaultConfig #1074

Closed

add streamGetbpm to Stream.hs #1018

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

replace Tempo module by an ableton-link synched clock that comes with tidal-link #1059

replace Tempo module by an ableton-link synched clock that comes with tidal-link #1059

polymorphicengine commented Dec 29, 2023 •

edited

Loading

matthewkaney left a comment

matthewkaney Dec 29, 2023

Zalastax Jan 14, 2024

matthewkaney commented Dec 30, 2023

Zalastax left a comment

Zalastax Jan 14, 2024

Zalastax Jan 14, 2024

matthewkaney Jan 17, 2024 •

edited

Loading

polymorphicengine commented Feb 23, 2024

matthewkaney commented Feb 24, 2024

polymorphicengine commented Feb 24, 2024

matthewkaney commented Feb 26, 2024

yaxu commented Feb 26, 2024

yaxu commented Apr 9, 2024

matthewkaney commented Apr 9, 2024

replace Tempo module by an ableton-link synched clock that comes with tidal-link #1059

replace Tempo module by an ableton-link synched clock that comes with tidal-link #1059

Conversation

polymorphicengine commented Dec 29, 2023 • edited Loading

matthewkaney left a comment

Choose a reason for hiding this comment

matthewkaney Dec 29, 2023

Choose a reason for hiding this comment

Zalastax Jan 14, 2024

Choose a reason for hiding this comment

matthewkaney commented Dec 30, 2023

Zalastax left a comment

Choose a reason for hiding this comment

Zalastax Jan 14, 2024

Choose a reason for hiding this comment

Zalastax Jan 14, 2024

Choose a reason for hiding this comment

matthewkaney Jan 17, 2024 • edited Loading

Choose a reason for hiding this comment

polymorphicengine commented Feb 23, 2024

matthewkaney commented Feb 24, 2024

polymorphicengine commented Feb 24, 2024

matthewkaney commented Feb 26, 2024

yaxu commented Feb 26, 2024

yaxu commented Apr 9, 2024

matthewkaney commented Apr 9, 2024

polymorphicengine commented Dec 29, 2023 •

edited

Loading

matthewkaney Jan 17, 2024 •

edited

Loading