Konduktiva is a JavaScript library for live coding, an improved version of the Conductive library for live coding in the Haskell programming language by Renick Bell. At present, it is intended for use within Nodejs.
Konduktiva website Renick Bell's Website
-
Install Nodejs. If npm does not automatically get installed with Nodejs, install npm.
2.1. Check if nodejs is installed by running this command in the terminal:
node -v2.2. Check if npm is installed by running this command in the terminal:
npm -v2.3. You can close the terminals you have opened prior to this step.
-
Install Konduktiva by using NPM:
npm i konduktiva -
Install a Digital Audio Workstation. Ardour is recommended
Click here for tutorials about Konduktiva
Konduktiva is a JavaScript library for live coding performances using a metaphor of a conductor conducting an ensemble.
A MusicalEnvironment is used to store all of the necessary data.
Players represent processes that can be started or stopped using the metaphor of a player in a musical ensemble like a band or orchestra.
The Players execute action functions which do things like play samples, trigger MIDI events, or even change the state of the system. They do so according to timing determined by IOI functions. IOI means interonset interval, which is the time between events. This timing is what determines the rhythm of a Player.
Players can be used for a single or multiple outputs. Anything that can be manipulated with a JavaScript function call can be an output. Actions for the SuperDirt sampler and MIDI are included in the distribution.
By starting and stopping Players, a performance can be realized.
One of the services that it provides is a sequencer with regular timing. If you use setInterval alone, you will eventually accumulate a time lag, which means that your rhythm will be slow and fall behind what you expect, or that two different processes would fall out of time.
The exact timing is controlled by an IOI function, which is one of two functions called by a Player. Players are a metaphor for a repeating set of function calls.
An IOI function produces a time interval that is used to space out events. It produces an interval which is the space between events. The simplest IOI function could return a single number, such as 1, which would indicate an event on each beat.
Ableton sequences by putting blocks on a grid. Konduktiva has a grid aligned to a BPM, except instead of placing blocks on the grid, you are placing fu
In a DAW like Ableton, you sequence music by placing blocks on a grid which is defined by BPM and time signature (4 beats per bar). In Konduktiva, there doesn't need to be a bar.
If you think about the piano roll in a DAW, you paint on notes. In Konduktiva, we write a function to determine the position of the notes. As for which notes they are, in a DAW the vertical position is painted as well. In Konduktiva, we write a function to determine that.
Think of an orchestra. You might have one player playing a violin and another playing a flute. In Konduktiva, you might represent each of these with a Player, each with a different function for rhythm and a different function for what sound to make.
In a piano roll, you press play, and each of the painted notes is sounded according to its position on the roll, and when all of the notes have been played, the DAW will produce silence (unless you have set a loop point). In Konduktiva, you press play for an individual Player (or for all of the Players together, or a subset, depending on your design), and the default behavior is to repeat a Player's function for rhythm indefinitely until the Player is stopped.
In Konduktiva, by editing the Players on the fly, you can perform complex musical sequences, like a conductor conducting players in an ensemble.
Because we have the power of a programming language, we can produce sequences which are much more complex than those that you would draw on a piano roll.
Each Player references two functions: an IOI (interonset interval) function which controls timing of events, and an action function which determines what to do according to that timing.
These functions are separate from the Player itself so that different Players can use the same IOI or action functions. Imagine a violin Player and a flute Player, each having a different action function corresponding to those two sounds, yet both using the same IOI function, resulting in them playing the same rhythm. Alternatively, you could have a single violin action function being used by two different Players, each with a different IOI function, resulting in two different rhythms of violin melody. IOI functions
IOI stands for interonset interval: the interval between the onset of events, or how much time passes between the triggering of events. This is like the space between notes on a piano roll, but more specifically the distance between the start of each note.
With an IOI function, we specify the gaps between notes in order to define our rhythm. An IOI function that produces the looping sequence of numbers 2, 3, 2, a rhythm of 2 beats, 3 beats, and then 2 beats results.
|X-X--X--|X-X--X--|X-X--X--|X-X--X-- (... indefinitely)
An IOI function produces rhythm. Rhythm implies at least two notes. By repeating an IOI function, a rhythm emerges.
It's important to remember that this doesn't necessarily have anything to do with note duration; it's just when the note starts.
You might want to think of it as defining the negative space between notes. action functions
In Konduktiva, the position of the notes is controlled by an IOI function. What happens at those notes is determined by the action function.
In Konduktiva instead of a block, you
Musical Environment
You populate the MusicalEnvironment with Players, IOI functions, and action functions. The tempo exists as a property of this MusicalEnvironment.
QuantizedMap
This is a class used for storing all of the data that is needed for producing a performance with Konduktiva, including Players, Actions, IOI functions, RhythmMaps, and so on. You populate the MusicalEnvironment with Players, IOI functions, and action functions. The tempo exists as a property of this MusicalEnvironment.
The constructor takes no arguments. Call it to get a default MusicalEnvironment which can then be adjusted to your needs.
e = new MusicalEnvironment();
The titles of each variable in this documentation are aimed at giving as much information as possible. For example, the first title "bools: boolean[]". "bools" is the variable name and "boolean[]" tells you that the variable bools is supposed to be an array full of booleans.
Actions functions that can be used are stored here. Learn more here
Connected to player variable: action
Channel Maps that players can use. These maps control which channel player should send midi info to at a given time.
Connected to player variable: channelMap
Chord maps that players can use. These maps control which chords a player should use at a given time. The values are letter musical notation. (eg. M or m7)
Connected to player variable: chordMap
Control change maps that players can use. These map control which control change midi messages a player should send at a given time. The values are the midi controlChange information in form of objects with the variables controller and, value.
Connected to control change player variable: controlChangeMap
An array of densityGraph names. The acutal densityGraphs are stored in the densityGraphs variable.
Returns the current tempo of the MusicalEnvironment. To change the tempo use the changeTempo method.
Shows the current beats per measure. Default is 4.
An object filled with densityGraphs. The actual graphs are in form of QuantizedMaps. So, it is a QuantizedMap in an object in another object.
IOI function are stored here.
Controls how long each note plays for. Similar to noteDurationMaps. Works with noteDuration. This is the equation used for calculating a duration of a note. noteDuration * legatoMap.
Returns the lookahead time.
maskMaps are basically the booleans. The keys are the time and the values are trues or falses. If it is a true for a specific time, the action function will be called. If it is a false, action function will not be called. To supress events.
Not filling this in will deactivate this specific feature.
Sets the amount of midi notes a player is allowed to play at a given beat. The keys are the beats and the values are the amount of midi notes the player is allowed to play.
The midiInputs that Konduktiva/Easymidi can detect.
the midiOutputs that Konduktiva/Easymidi can detect.
Used by the players that send Midi Program messages. Controls which Midi program messages to send at a given time.
The mode players should be filtered through. It passes the note to filter through the modeFilter QuantizedMap via wrapLookup method.
The modeFilter that the player should use.
These QuantizeMaps store how long each note should play for at a given beat. They are the note spans. Works with legatoMaps. This is the equation used for calculating a duration of a note. noteDuration * legatoMap.
Stores the noteValues. The keys is the beats and the values are the notes to play.
Two options relativeSemitone or relativeScaleDegree. This changes how the action function uses the noteMaps
Stores the octaves the action function should use at a given beat. The keys are the beats and the values are the octaves to use.
An array full of player objects. Find out more by looking at the player section.
For use in recording midi inputs.
Controls when a note is played (keys) and how long each note should play for (values).
Needed to call ```rhythmPattern.add(e, playerName) for things to work correctly. To create events.
The root letter. By default it is 'A'.
Stores the root English letters. The keys are the beats and the values are the English letters.
superDirt stuff.
superDirt stuff.
superDirt stuff.
superDirt instrument QuantizedMap.
Players that are schedules to play stored in an array.
Controls which chordMap a player is using
Tasktimer
Location of the superDirt samples.
Controls the midi velocity variable from 0-127 at a given beat. The keys are the beats and the values are the velocity.
-> Number
Returns the current beat of the MusicalEnvironment
e.currentBeat()
console.log(e.currentBeat())
Number ->
Takes a number as an argument and changes the currentTempo to that number.
e.changeTempo(tempo)
New tempo of the current MusicalEnvironment
console.log(e.changeTempo(100)) //TEMPO CHANGE! time: 5.690928572999313; beat: 8.493846618000418
console.log(e.changeTempo(120)) //TEMPO CHANGE! time: 22.66408885199949; beat: 36.78241345300153
string -> Function
Returns the action function of a specific player in this MusicalEnvironment Takes player name in form of a string as an argument.
e.getAction(player)
Name of a variable in e.players
console.log(e.getAction('kick')) //[Function (anonymous)]
console.log(e.getAction('snare')) //[Function (anonymous)]
string -> Function
Returns the IOI function of a specific player in this MusicalEnvironment.
e.getIOIFunc(player)
Name of a variable in e.players
console.log(e.getIOIFunc('kick')) //[Function: defaultIOI]
console.log(e.getIOIFunc('snare')) //[Function: defaultIOI]
schedules events. string ->
Returns the IOI function of a specific player in this MusicalEnvironment. Not meant to be called by user.
e.scheduledPlayers(player)
Name of a variable in e.players
e.scheduleEvents('musicSynthesizerSession1')
Starts the scheduler for the MusicalEnvironment. It takes no arguments and returns nothing.
e.startScheduler()
e.startScheduler()
Stops the scheduler for the MusicalEnvironment. Takes no arguments and retunrs nothing.
e.stopScheduler()
e.stopScheduler()
String ->
e.play(player)
Player name
e.play('musicSynthesizerSession1')
String ->
e.stop(player)
Player name
e.stop('musicSynthesizerSession1')
->
Returns an array of all the player names.
e.allPlayers()
console.log(e.allPlayers)
-> [[String, String] ...]
Returns an array full of arrays. Each sub array contains the player name and their status. All the player names and their status also gets logged into the console.
e.allPlayerStatus()
console.log(e.allPlayerStatus())
/*
[
[ 'kick', 'stopped' ],
[ 'snare', 'stopped' ],
[ 'perc', 'stopped' ],
[ 'hat', 'stopped' ],
[ 'sub', 'stopped' ],
[ 'stab1', 'stopped' ],
[ 'stab2', 'stopped' ],
[ 'atmo', 'stopped' ],
[ 'musicSynthesizerSession1', 'stopped' ]
]
*/
->
Returns an array of all the names of players that are currently playing.
e.playingPlayers()
console.log(e.playingPlayers()) //[]
[String] ->
Starts playing all the player names in the array.
e.playN(ps)
An array of player names.
e.playN(['musicSynthesizerSession1', 'musicSynthesizerSession2'])
[String] ->
Stops playing all the player names in the array.
e.stopN(ps)
An array of player names.
e.stopN(['musicSynthesizerSession1', 'musicSynthesizerSession2'])
->
All players start playing.
e.playAll()
e.playAll()
->
All players stop playing.
e.stopAll()
e.stopAll()
[String] ->
Stops playing all the player names in the array after checking if the players exist inside the MusicalEnvironment.
e.solo(ps)
An array of player names.
e.stopN(['musicSynthesizerSession1', 'musicSynthesizerSession2'])
String ->
Toggles the state of a specific player. If that player is playing it will be stopped. If that player is stopped, it will start playing.
e.togglePlayer(p)
Player name
e.togglePlayer('musicSynthesizerSession1')
-> String
Checks if superDirt samples exists at the location(file path) they are supposed to be at.
e.findSuperDirtSamples()
e.findSuperDirtSamples()
//'/home/steve/.local/share/SuperCollider/downloaded-quarks/Dirt-Samples'
-> String
Returns the path of where superDirt samples should be on a specific system.
e.getSuperDirtSamplesPath()
e.getSuperDirtSamplesPath()
//'/home/steve/.local/share/SuperCollider/downloaded-quarks/Dirt-Samples'
String -> String -> Number, [Number] -> [[Number]]|[Number] ->
Checks the arguments of addMap method.
e.checkingAddMapToMusicalEnvironmentArguments(objectName, mapName, keyspan, keys, values)
Name of a variable in the MusicalEnvironment to add to.
Name of the new QuantizedMap.
Th keyspan of the new QuantizedMap.
The keys of the new QuantizedMap.
The values of the new QuantizedMap.
e.checkingAddMapToMusicalEnvironmentArguments('rhythmMaps', 'chalk', 10, [0, 1, 2, 3], [4, 5, 6, 7])
//undefined
String -> String -> Number, [Number] -> [Number] -> Boolean
Creates the default a rhythmMap with the information provided
e.createDefaultRhythmMap(objectName, mapName, keyspan, keys, values)
Name of a variable in the MusicalEnvironment to add to.
Name of the new QuantizedMap.
Th keyspan of the new QuantizedMap.
The keys of the new QuantizedMap.
The values of the new QuantizedMap.
e.createDefaultRhythmMap('rhythmMaps', 'chalk', 10, [0, 1, 2, 3], [4, 5, 6, 7])
//true
String -> String -> Number, [Number] -> [Number] -> Boolean
Creates subArray QuantizedMaps and adds them to MusicalEnvivronment. This is used for noteMaps and octaveMaps.
e.createSubarrayMap(objectName, mapName, keyspan, keys, values)
Name of a variable in the MusicalEnvironment to add to.
Name of the new QuantizedMap.
Th keyspan of the new QuantizedMap.
The keys of the new QuantizedMap.
The values of the new QuantizedMap.
e.createSubarrayMap('rhythmMaps', 'chalk', 10, [0, 1, 2, 3], [4, 5, 6, 7])
//true
String -> String -> Number, [Number] -> [Boolean] -> Boolean
Creates the default rhythmPattern maps based on the information.
e.createRhythmPatternMap(objectName, mapName, keyspan, keys, values)
Name of a variable in the MusicalEnvironment to add to.
Name of the new QuantizedMap.
Th keyspan of the new QuantizedMap.
The keys of the new QuantizedMap.
The values of the new QuantizedMap.
e.createRhythmPatternMap('rhythmMaps', 'chalk', 10, [0, 1, 2, 3], [4, 5, 6, 7])
//true
String -> String -> Number, [Number] -> [Boolean] -> Boolean
Creates the default maskMap based on the information provided.
e.createDefaultMaskMaps(objectName, mapName, keyspan, keys, values)
Name of a variable in the MusicalEnvironment to add to.
Name of the new QuantizedMap.
Th keyspan of the new QuantizedMap.
The keys of the new QuantizedMap.
The values of the new QuantizedMap.
e.createDefaultMaskMap('rhythmMaps', 'chalk', 10, [0, 1, 2, 3], [4, 5, 6, 7])
String -> String -> Number, [Number] -> [Boolean] -> Boolean
Create default chord progression map with information provided.
e.createChordProgressionMap(objectName, mapName, keyspan, keys, values)
Name of a variable in the MusicalEnvironment to add to.
Name of the new QuantizedMap.
Th keyspan of the new QuantizedMap.
The keys of the new QuantizedMap.
The values of the new QuantizedMap.
e.createDefaultMaskMap('rhythmMaps', 'chalk', 10, [0, 1, 2, 3], [4, 5, 6, 7])
//true
String -> String -> Number, [Number] -> [Boolean] -> Boolean
Creates the default song map with based on the information provided.
e.createSongMap(objectName, mapName, keyspan, keys, values)
Name of a variable in the MusicalEnvironment to add to.
Name of the new QuantizedMap.
Th keyspan of the new QuantizedMap.
The keys of the new QuantizedMap.
The values of the new QuantizedMap.
e.createSongMap('rhythmMaps', 'chalk', 15000, [1000, 5000, 10000], ['twelveBars', 'lsystem', 'scarboroughFair'])
//true
String -> String -> Number, [Number] -> [Boolean] -> Boolean
Create default chord progression map with information provided.
e.createDefaultMap(objectName, mapName, keyspan, keys, values)
//true
Name of a variable in the MusicalEnvironment to add to.
Name of the new QuantizedMap.
Th keyspan of the new QuantizedMap.
The keys of the new QuantizedMap.
The values of the new QuantizedMap.
e.createDefaultMap('rhythmMaps', 'chalk', 10, [0, 1, 2, 3], [4, 5, 6, 7])
//true
This function helps add QuantizedMaps into the MusicalEnvironment with correct types. If something is wrong, this function will throw an error. It is safer and in some situations easier and quicker to use this method than to create a QuantizedMap manually.
e.addMap(objectName, mapName, keyspan, keys, values)
Name of a variable in the MusicalEnvironment to add to.
Name of the new QuantizedMap.
Th keyspan of the new QuantizedMap.
The keys of the new QuantizedMap.
The values of the new QuantizedMap.
e.addMap('rhythmMaps', 'chalk', 10, [0, 1, 2, 3], [4, 5, 6, 7])
console.log(e.rhythmMaps.chalk)
/*
QuantizedMap {
keyspan: 1,
keys: [ 1 ],
values: QuantizedMap {
keyspan: 10,
keys: [ 0, 1, 2, 3 ],
values: [ 4, 5, 6, 7 ]
}
}
*/
There are different ways you can interacte and change things in the MusicalEnvironment. You can change it by doing e.variable = . This way is excellent if you are familliar with what you are doing and if you have time. When live coding we often have to act and think quickly. When doing this is is especially easy to make mistakes when making QuanitzedMaps.
Players are processes that can be started or stopped using the metaphor of a player in a musical ensemble like a band or orchestra.
Players are data structures to represent an agent which carries out Action functions in time according to an IOI function.
Players can be used for a single or multiple outputs. Anything that can be manipulated with a JavaScript function call can be an output. Actions for the SuperDirt sampler and MIDI are included in the distribution.
By starting and stopping Players, a performance can be realized.
new Player(name)
Name of the player. This will also be the value of the name variable in the player.
e.players.testPlayer = new Player('testPlayer')
e.players.testPlayer.maskMap = 'default'
e.players.testPlayer.action = 'midiSequencedRhythm'
e.players.testPlayer.rhythmMap = 'default'
console.log(e.palyers.testPlayer)
This class is usually called by helper functions like setupMidiRhythm or setupPlaybackPlayer. To make the the player work, the user needs to give it a maskMap, action function and, a rhythmMap.
A QuantizedMap is a discrete function in which an input returns one of a set of possible outputs.
A common use is to provide a set of time intervals from 0 to n in which each interval is mapped to a specific output.
Keyspan is the total
An array of numbers in ascending order.
new QuantizedMap(keyspan, keys, values)
Takes a number as an input and will look for a number in the keys array that is closest to it compared to the others. It will then take the index of that number and return the value array using that index.
The floorLookup method does something similar to nearestLookup but when it looks for the closest it always looks for a number smaller than it.
The wrapLookup method is also similar to the nearestLookup method but when the number provided is greater than the keyspan, it does not return the last item in the values array instead it loops back around.
A RhythmPattern is a set of parameters bundled as an object which is used to create a rhythm pattern and mask pattern for a particular Player.
String -> Number -> [Number ...] -> [Boolean] -> Object
Creates the RhythmPattern
new RhythmPattern(n, l, i, b)
Name of the rhythmPattern.
Length of the rhythmPattern
A number array filled with the booleans "true" and "false".
let testR = new RhythmPattern('dopeRhythm', 5, [2, 2, 2, 2, 2], [true, false, true, true])
MusicalEnvironment -> String ->
Adds this RhythmPattern to a player.
testR.addToPlayer(env, playerName)
MusicalEnvironment
Name of the player to add to.
testR.addToPlayer(e, 'p3')
MusicalEnvironment -> String ->
Adds to MusicalEnvironment but does not add to a player.
testR.add(env, playerName)
MusicalEnvironment
Name of the player to add to.
testR.add(e, 'p3')
To Note: None of the action functions or the functions called by/in the action functions are intended to be directly called by users.
Action function are a key part of Konduktiva. Click (here)[http://konduktiva.org/doku.php?id=action-functions] to get a simple explanation of action functions and click (here)[http://konduktiva.org/doku.php?id=custom-actions] to see a simple explanation on how to create custom action functions.
Here the details of what each action function does will be documented more specifically.
Number -> Number -> MusicalEnvironment
A simple action function for testing and debugging purposes which will log all of the arguments into the console disregarding the verbose variable of the player. (Not meant to be called by user)
e.actions.default(midiOutput, b, e)
The index in the array e.midiOutputs.
Beat
MusicalEnvironment.
e.actions.default(1, 100, e)
/*
Hi this is the default action function being triggered
This is the midiOutput: 1
This is the beat: 100
undefined
*/
Object -> Number ->
DEPRECATED
String -> Number -> MusicalEnvironment -> Boolean
Sends note MIDI messages using the information provided. Note other functions called in this function documented below.
e.actions.sendNotesMidiInfo(playerName, b, e)
The name of the player to be played
Beat
MusicalEnvironment
e.actions.sendNotesMidiInfo('exampleMidiPlayer1', 100, e)
String -> Number -> MusicalEnvironment -> Boolean
Sends chord MIDI messages using the information provided. Note other functions called in this function documented below.
e.actions.sendChordMidiInfo(playerName, b, e)
The name of the player to be played
Beat
MusicalEnvironment
e.actions.sendChordMidiInfo('exampleMidiPlayer1', 100, e)
Object -> Number ->
Plays the information of a player using superdirt
e.actions.superDirt(e.players.exampleMidiPlayer1, 100)
Player
Beat
e.actions.superDirt(e.players.exampleMidiPlayer1, 100)
Object -> Number -> Number -> Object
Gets MIDI information that the player should be playing at a specific beat.
K.getNoteInfoToSend(player, b, midiOutput)
Player that should be playing
Beat
The index of the array in e.midiOutputs.
Object -> ... -> Boolean
Checks if player verbose player is true and if so log messages requested.
K.checkIfUseVerboseLogging(player, ...)
Player to check for verbose variable.
There can be as many other arguments as the user wants and it will be logged in the console if player.verbose is true.
K.checkIfUseVerboseLogging(e.players.exampleMidiPlayer1, ...)
MusicalEnvironment -> Number -> Object -> Object -> Object
Checks the maxPolyphany map for how many chords can be played at a specific beat. Notes over the polyphany limit will be dropped.
K.filterPolyphany(e, b, player, info)
MusicalEnvironment
Beat
Player to play
Information gotten from getNoteInfoToSend function
K.filterPolyphany(e, 100, e.players.exampleMidiPlayer1, K.getNoteInfoToSend(e.players.exampleMidiPlayer1, 100, 1))
Number -> MusicalEnvironment -> Number -> Object -> Number
Filters note through modes.
K.filterMode(note, e, b, player)
Note to filter
MusicalEnvironment
Beat
Player
K.filterMode(4, e, 100, e.players.exampleMidiPlayer1)
//4
Object -> Object
Calculates the note variable of the final MIDI message.
K.calculateFinalNoteValue(info)
The object returned by getNoteInfoToSend.
K.calculateFinalNoteValue(K.getNoteInfoToSend(e.players.exampleMidiPlayer1, 100, 1))
MusicalEnvironment -> Number -> Object ->
Checks if player is supposed to send MIDI CC messages at the current beat and if yes sends the correct MIDI CC message.
K.checkIfSendMidiControlChange(e, b, player)
MusicalEnvironment
Beat
Player
K.checkIfSendMidiControlChange(e, 100, e.players.exampleMidiPlayer1)
Object -> Number -> MusicalEnvironment -> Number
Checks which channel the player should be sending MIDI messages to.
K.findChannel(player, b, e)
Player that should be checked
Beat
MusicalEnvironment
K.findChannel(e.players.exampleMidiPlayer1, 100, e)
Object -> Object -> Number -> Number ->
Sends MIDI noteon and noteoff messages.
K.sendMidiData(info, player, note, channel)
Object returned from getNoteInfoToSend function.
Player to check
Channel to send MIDI message to.
K.sendMidiData(K.getNoteInfoToSend(e.players.exampleMidiPlayer1, 100, 1), e.players.exampleMidiPlayer1, 50, 1)