Awesome
PunKt - Kotlin Punk
A live coding music library/environment for Kotlin. For software developers who want to dive into live coding music.
"Punkt" is "point" in Polish.
Demos:
Rationale
- minimal - just a sequencer playing samples and synths designed in SuperCollider
- easy to install - a library + template project, just
git clone
, run and enjoy - no custom IDE - could be started directly from IntelliJ IDEA or command line with any Kotlin-aware editor
- data-oriented - patterns and melodies represented as data structure, making it easy to test and visualize
How to start
- Install SuperCollider (at least 3.10) and sc3-plugins
- Clone template project
git clone https://github.com/pjagielski/punkt-template.git
- Start SuperCollider, boot server (Server->Boot Server) and run punkt-synths.scd
(in case of "Memory allocation problems": clone punkt project and run
src/main/resources/punkt.scd
in SuperCollider.) - Run
Main.kt
inpunkt-template
- Profit! Just edit
src/main/kotlin/live.kts
in your favourite editor for live-coding
Why Kotlin?
- statically typed, compiled - you get code completion and compile-time errors for free
- sequence API - great standard library with lazy immutable sequences for making patterns
- DSL builders - extension methods and operator overloading makes it easy to create powerful DSLs
- scripting - a file watcher and API for compiling/evaluating script whenever it changes
- coroutines - makes trivial to trigger an asynchronous event from anywhere in your code
- mainstream - it's great to learn Clojure or Haskell, but it's even better that your project uses technology that reaches lots of potential users ;)
Minimal example
patterns(beats = 8) {
+ repeat(1).sample("bd_haus")
}
Plays "bd_haus" sample every beat.
What happened here? punkt
highly relies on durations to create patterns. If we want to play "bd_haus" sample every
beat, we could specify this by a list of beats, like listOf(0, 1, 2, 3, ...)
. We could use rangeTo
function (e.g. 0..7
) to
create a fixed range of beats. In punkt
instead, you specify the durations between the beats, and a
starting point - which defaults to 0 by this repeat
function (which is not repeat
from Kotlin standard library).
This has some advantages:
- in simple cases, you repeat single value or cycle through small series of values
- this creates infinite sequence of beats, which is helpful if you don't know upfront how many beats you need ;)
that's why we need to narrow the resulting collection to fixes number of beats with this
patterns(beats = 8) {..}
function.
Another example: 4 on the floor beat:
patterns(beats = 8) {
+ repeat(1).sample("bd_haus") // every beat starting from 0
+ repeat(2).sample("claps", at = 1.0) // every even beat, starting from 1
+ repeat(1).sample("hat_2", at = 0.5, amp = 0.5f) // every beat, starting from 0.5
}
Evaluates to:
sample | played at beats |
---|---|
"bd_haus" | [0,1,2,3,4,5,6,7] |
"claps" | [1,3,5,7] |
"hat_2" | [0.5,1.5,2.5,3.5,4.5,5.5,6.5] |
Melody phrases
punkt
also uses similar technique to create melodies. But melodies, apart from time when the sound should play,
require a note (pitch), which should play. To make it more musically correct, these notes should be part
of some musical scale. That's why we start by creating a scale
object using DSL from scale
package:
val scale = Scale(C.sharp(), minor)
The notes of C# minor are: C#,D#,E,F#,G#,A,B (https://en.wikipedia.org/wiki/C-sharp_minor)
Then we can use phrase
function, which takes sequence of degrees of given scale and sequence of durations to create a melody:
patterns(beats = 8) {
+ scale.low()
.phrase(
degrees(listOf(0,-4,-2,-1).flatMap { listOf(it,it,it) }),
cycle(0.75, 0.75, 0.5))
.synth("tr808", amp = 0.2f)
}
This creates following notes:
beats | note | degree |
---|---|---|
0, 0.75, 1.5 | C# | 0 |
2, 2.75, 3.5 | F# | -4 |
4, 4.75, 5.5 | A | -2 |
6, 6.75, 7.5 | B | -1 |
Which is the "Shape of you" bassline ;)
More examples
TB-303 pentatonic arpeggio with LFO
val pentatonic = Scale(C.sharp(), pentatonic)
val lfo = LFO(1000, 3200, length = 1.5)
patterns(beats = 8) {
+ pentatonic.low()
.phrase(degrees(cycle(cycle((0..4)).take(10).toList())), cycle(0.25))
.synth("tb303", amp = 0.2f)
.params("sus" to 0.3, "dec" to 0.2, "start" to 100)
.params("cutoff" to lfo)
}
4-step chord progression with lead synth
val scale = Scale(C.sharp(), minor)
val progression = listOf(Chord.I, Chord.IV, Chord.VI, Chord.VII)
patterns(beats = 8) {
+ scale
.phrase(
progression.flatMap { listOf(it, null, it) }.toDegrees(),
cycle(1.0, 0.25, 0.75)
)
.synth("lead", amp = 0.25f)
.params("cutoff" to 1500)
}
Inspirations
- ORCΛ - simplicity (just a sequencer)
- openRNDR - kotlin script-driven live coding
- Leipzig - music as data
- FoxDot - synth design, OSC implementation
- Tidal - patterns, SuperDirt
- Sonic-Pi - live loops, script-driven live coding
Changelog
0.3.0 - 09.09.2020
- introduced separate tracks with global effects
- new global effects:
reverb
,delay
,djf
- new effects:
djf
,waveDist
,squiz
- new synths:
piano
,bass8
- new note methods:
amp
,track
- fluent API for effects
0.2.0 - 17.05.2020
- introduced effects
- new effects:
lpf
,hpf
,delay
,dist
,chop
- new synth:
lead
- BREAKING: synth params API cleanup
- events logging
0.1.0 - 20.04.2020
- initial version ;)
sample
andloop
support- new synths:
tb303
,tr808
,plucklead
,da-funk
Roadmap
- OSC/MIDI out
- OSC/MIDI in
add effects on separate channels(0.3.0)- pattern randomization
- visualization
License
Copyright © 2020- Piotr Jagielski
Punkt is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.