Cluster Engine is a constraint solver for solving polyphonic constraint satisfaction problems where both the pitch and the rhythmic structure can be restricted by an arbitrary number of constraints (rules), and the solver then searches for a solution that is consistent with all constraints. This library supports user-defined rules, and highly flexible ways to control which aspects of the resulting score are controlled by certain rules. For example, you can independently control with compositional rules the melody and harmony of the music you generate.
Cluster Engine is the successor of PWMC (Sandred, 2010). It was originally developed as a library for the free composition environment PWGL.
The present version still runs in PWGL, but also on plain Common Lisp in order to make it useable within Opusmodus and – via a SBCL interface – in the music and media programming environment Max (Vincenot, 2017) within the MOZ’Lib package.
Cluster Engine has been successfully tested on PWGL (based on Lispworks), SBCL and Opusmodus (Clozure CL).
Sandred, Ö. (2010) PWMC, a Constraint-Solving System for Generating Music Scores. Computer Music Journal. 34(2), 8–24.
Vincenot, J. (2017) LISP in Max: Exploratory Computer-Aided Composition in Real-Time. ICMC 2017.
These instructions explain how to install Cluster Engine for PWGL. First, download the library with the download link at http://github.com/tanders/cluster-engine and unzip the folder. Then, make sure the folder is named
cluster-engine (remove the
master part of the folder name). Finally, move this folder inside the PWGL user library folder (
This section explain how to install Cluster Engine as a plain Common Lisp library (e.g., to be used by Opusmodus). We are using git for the installation. Even though this is a bit more involved at first, it allows for convenient updates later, and you can even contribute to the development.
Download the present software with git into a directory where ASDF can find the software, e.g., ~/common-lisp/. For example, on UNIX incl. OS X you can enter the following commands at the command line (after you created the directory
~/common-lisp/). Note that
$ is the terminal prompt here, you do not need to enter that :)
$ cd ~/common-lisp $ git clone https://github.com/tanders/cluster-engine.git
You will be asked for your GitHub username and password.
If there are changes, you can update your software later at the terminal in the following way.
$ cd ~/common-lisp/cluster-engine $ git pull
If you use Cluster Engine in PWGL, you load the library in PWGL with File > Load Library…
The library comes with a tutorial, which you find under Help > PWGL Tutorial… In the tutorial browser that opens then move to Library Tutorials > cluster-engine. The tutorial consists of a collection of live patches with comments and documentation slides.
Cluster Engine is an ASDF system (ASDF is the de facto standard for building Common Lisp software), and you can load it into your Lisp compiler as follows.
The library should now be loaded, and you can solve musical constraint satisfaction problems. The first example below is an “empty” problem without any constraints yet. The function
clusterengine is the constraint solver. Its first three arguments specify the number of variables (quasi notes) per voice (
10 in this example), whether or not to randomise the solution (
T) and whether to use additional debugging features (
nil). After a list of constraints (empty in this first example) the function expects specifications for various domains. These specifications support a mini language for flexibility, the specifications below are very simple. Only a single time signature is allowed (all bars are in 3/4 time); the single voice can consist of quarter notes and eighth notes; and possible pitches are middle C and C# (MIDI note numbers 60 and 61).
(ce::clusterengine 10 t nil ; settings nil ; no constraints '((3 4)) ; metric domain ;; domain of rhythmic values and pitches for one voice '(((1/4) (1/8)) ((60) (61))))
clusterengine outputs a declaration of the sequences of time signatures, rhythmic values and pitches for each voice.
(; rhythmic values of voice 1 (1/4 1/8 1/8 1/8 1/4 1/8 1/8 1/8 1/8 1/8) ; pitches (60 61 60 61 61 60 60 60 60 61) ; time signatures ((3 4) (3 4) (3 4)))
The output is automatically translated into a notated score in PWGL, and can be translated into an OpusModus score with the function
cluster-engine-score, which in turn can be translated into a notated score with
preview-score – both functions provided by the library tot.
(:|1| ((q c4 e cs4 c4 cs4 cs4 tie) (e cs4 c4 c4 c4 c4 cs4)))
The above constraint problem does not include any musical rules. Without a detailed discussion, in the following a polyphonic example with a few rules is shown (example 8a translated from the PWGL tutorial into plain Common Lisp). Here, the first rule forces both voices to create 12-tone rows. Rule 2 constrains all harmonic intervals between both voices to consonant intervals of 3, 4, 7, 8 or 9 semitones. Finally, the last rule forbids any voice crossings. A possible result is shown below the code.
(ce::clusterengine 12 t nil (append ;; rule 1 (ce::r-pitches-one-voice #'(lambda (x) (not (member (mod (car (last x)) 12) (mapcar #'(lambda (a) (mod a 12)) (butlast x))))) '(0 1) :all-pitches) ;; rule 2 (ce::r-pitch-pitch #'(lambda (x) (member (mod (ce::apply-minus x) 12) '(3 4 7 8 9))) '(0 1) '(0) :all :no_grace :pitch) ;; rule 3 (ce::R-pitch-pitch #'(lambda (x) (>= (first x) (second x)) ) '(0 1) '(0) :all :no_grace :pitch)) '((4 4)) '(;; domains of rhythmic values and pitches of voice 1 ((1/4)) ((60) (61) (62) (63) (64) (65) (66) (67) (68) (69) (70) (71) (72) (73) (74) (75) (76) (77) (78) (79)) ;; domains of rhythmic values and pitches of voice 2 ((1/4)) ((60) (61) (62) (63) (64) (65) (66) (67) (68) (69) (70) (71) (72) (73) (74) (75) (76) (77) (78) (79))))
For further information refer to the PWGL tutorial for now. Pretty much all PWGL boxes have their equivalent Common Lisp function/macro with the same arguments. An exception is the function
clusterengine itself, where domains of rhythmic values and pitches are defined in Common Lisp as shown above.
The Common Lisp library Cluster Rules extends Cluster Engine by a collection of predefined musical constraints and that way makes it more easy to use. The equivalent PWGL library is PWGL Cluster Rules.