Sound.SC3.Server.Command.Generic

Generic constructors for the command set implemented by the SuperCollider synthesis server.

Buffer commands (b_)

b_alloc :: Integral i => i -> i -> i -> Message

Allocates zero filled buffer to number of channels and samples. (Asynchronous)

b_allocRead :: Integral i => i -> String -> i -> i -> Message

Allocate buffer space and read a sound file. (Asynchronous)

b_allocReadChannel :: Integral i => i -> String -> i -> i -> [i] -> Message

Allocate buffer space and read a sound file, picking specific channels. (Asynchronous)

b_close :: Integral i => i -> Message

Close attached soundfile and write header information. (Asynchronous)

b_fill :: (Integral i, Real n) => i -> [(i, i, n)] -> Message

Fill ranges of sample values.

b_free :: Integral i => i -> Message

Free buffer data. (Asynchronous)

b_gen :: Integral i => i -> String -> [Datum] -> Message

Call a command to fill a buffer. (Asynchronous)

b_gen_sine1 :: (Integral i, Real n) => i -> [B_Gen] -> [n] -> Message

Call sine1 b_gen command.

b_gen_sine2 :: (Integral i, Real n) => i -> [B_Gen] -> [(n, n)] -> Message

Call sine2 b_gen command.

b_gen_sine3 :: (Integral i, Real n) => i -> [B_Gen] -> [(n, n, n)] -> Message

Call sine3 b_gen command.

b_gen_cheby :: (Integral i, Real n) => i -> [B_Gen] -> [n] -> Message

Call cheby b_gen command.

b_gen_copy :: Integral i => i -> i -> i -> i -> Maybe i -> Message

Call copy b_gen command.

b_get :: Integral i => i -> [i] -> Message

Get sample values.

b_getn :: Integral i => i -> [(i, i)] -> Message

Get ranges of sample values.

b_query :: Integral i => [i] -> Message

Request /b_info messages.

b_read :: Integral i => i -> String -> i -> i -> i -> Bool -> Message

Read sound file data into an existing buffer. (Asynchronous)

b_readChannel :: Integral i => i -> String -> i -> i -> i -> Bool -> [i] -> Message

Read sound file data into an existing buffer, picking specific channels. (Asynchronous)

b_set :: (Integral i, Real n) => i -> [(i, n)] -> Message

Set sample values.

b_setn :: (Integral i, Real n) => i -> [(i, [n])] -> Message

Set ranges of sample values.

b_write :: Integral i => i -> String -> SoundFileFormat -> SampleFormat -> i -> i -> Bool -> Message

Write sound file data. (Asynchronous)

b_zero :: Integral i => i -> Message

Zero sample data. (Asynchronous)

Control bus commands (c_)

c_fill :: (Integral i, Real n) => [(i, i, n)] -> Message

Fill ranges of bus values.

c_get :: Integral i => [i] -> Message

Get bus values.

c_getn :: Integral i => [(i, i)] -> Message

Get ranges of bus values.

c_set :: (Integral i, Real n) => [(i, n)] -> Message

Set bus values.

c_setn :: (Integral i, Real n) => [(i, [n])] -> Message

Set ranges of bus values.

Instrument definition commands (d_)

d_recv' :: Graphdef -> Message

Install a bytecode instrument definition. (Asynchronous)

d_recv :: Synthdef -> Message

Install a bytecode instrument definition. (Asynchronous)

d_load :: String -> Message

Load an instrument definition from a named file. (Asynchronous)

d_loadDir :: String -> Message

Load a directory of instrument definitions files. (Asynchronous)

d_free :: [String] -> Message

Remove definition once all nodes using it have ended.

Group node commands (g_)

g_deepFree :: Integral i => [i] -> Message

Free all synths in this group and all its sub-groups.

g_freeAll :: Integral i => [i] -> Message

Delete all nodes in a group.

g_head :: Integral i => [(i, i)] -> Message

Add node to head of group.

g_new :: Integral i => [(i, AddAction, i)] -> Message

Create a new group.

g_tail :: Integral i => [(i, i)] -> Message

Add node to tail of group.

g_dumpTree :: Integral i => [(i, Bool)] -> Message

Post a representation of a group's node subtree, optionally including the current control values for synths.

g_queryTree :: Integral i => [(i, Bool)] -> Message

Request a representation of a group's node subtree, optionally including the current control values for synths.

Replies to the sender with a /g_queryTree.reply message listing all of the nodes contained within the group in the following format:

int32 - if synth control values are included 1, else 0
int32 - node ID of the requested group
int32 - number of child nodes contained within the requested group

For each node in the subtree:
[
  int32 - node ID
  int32 - number of child nodes contained within this node. If -1 this is a synth, if >= 0 it's a group.

  If this node is a synth:
    symbol - the SynthDef name for this node.

  If flag (see above) is true:
    int32 - numControls for this synth (M)
    [
      symbol or int: control name or index
      float or symbol: value or control bus mapping symbol (e.g. 'c1')
    ] * M
] * the number of nodes in the subtree

N.B. The order of nodes corresponds to their execution order on the server. Thus child nodes (those contained within a group) are listed immediately following their parent.

Node commands (n_)

n_after :: Integral i => [(i, i)] -> Message

Place a node after another.

n_before :: Integral i => [(i, i)] -> Message

Place a node before another.

n_fill :: (Integral i, Real f) => i -> [(String, i, f)] -> Message

Fill ranges of a node's control values.

n_free :: Integral i => [i] -> Message

Delete a node.

n_map :: Integral i => i -> [(String, i)] -> Message

n_mapn :: Integral i => i -> [(String, i, i)] -> Message

Map a node's controls to read from buses.

n_mapa :: Integral i => i -> [(String, i)] -> Message

Map a node's controls to read from an audio bus.

n_mapan :: Integral i => i -> [(String, i, i)] -> Message

Map a node's controls to read from audio buses.

n_query :: Integral i => [i] -> Message

Get info about a node.

n_run :: Integral i => [(i, Bool)] -> Message

Turn node on or off.

n_set :: (Integral i, Real n) => i -> [(String, n)] -> Message

Set a node's control values.

n_setn :: (Integral i, Real n) => i -> [(String, [n])] -> Message

Set ranges of a node's control values.

n_trace :: Integral i => [i] -> Message

Trace a node.

n_order :: Integral i => AddAction -> i -> [i] -> Message

Move an ordered sequence of nodes.

Par commands (p_)

p_new :: Integral i => [(i, AddAction, i)] -> Message

Create a new parallel group (supernova specific).

Synthesis node commands (s_)

s_get :: Integral i => i -> [String] -> Message

Get control values.

s_getn :: Integral i => i -> [(String, i)] -> Message

Get ranges of control values.

s_new :: (Integral i, Real n) => String -> i -> AddAction -> i -> [(String, n)] -> Message

Create a new synth.

s_noid :: Integral i => [i] -> Message

Auto-reassign synth's ID to a reserved value.

UGen commands (u_)

u_cmd :: Integral i => i -> i -> String -> [Datum] -> Message

Send a command to a unit generator.

Server operation commands

cmd :: String -> [Datum] -> Message

Send a plugin command.

clearSched :: Message

Remove all bundles from the scheduling queue.

dumpOSC :: PrintLevel -> Message

Select printing of incoming Open Sound Control messages.

errorMode :: ErrorScope -> ErrorMode -> Message

Set error posting scope and mode.

notify :: Bool -> Message

Select reception of notification messages. (Asynchronous)

nrt_end :: Message

End real time mode, close file (un-implemented).

quit :: Message

Stop synthesis server.

status :: Message

Request /status.reply message.

sync :: Integral i => i -> Message

Request /synced message when all current asynchronous commands complete.

Modify existing message to include completion message

with_completion_packet :: Message -> Packet -> Message

Add a completion packet to an existing asynchronous command.

withCM :: Message -> Message -> Message

Add a completion message to an existing asynchronous command.

let m = n_set1 0 "0" 0
let e = encodeMessage m
withCM (b_close 0) m == Message "/b_close" [Int32 0,Blob e]

Variants to simplify common cases

b_alloc_setn1 :: (Integral i, Real n) => i -> i -> [n] -> Message

Pre-allocate for b_setn1, values preceding offset are zeroed.

b_getn1 :: Integral i => i -> (i, i) -> Message

Get ranges of sample values.

b_query1 :: Integral i => i -> Message

Variant on b_query.

b_set1 :: (Integral i, Real n) => i -> i -> n -> Message

Set single sample value.

b_setn1 :: (Integral i, Real n) => i -> i -> [n] -> Message

Set a range of sample values.

b_setn1_segmented :: (Integral i, Real n) => i -> i -> i -> [n] -> [Message]

Segmented variant of b_setn1.

c_getn1 :: Integral i => (i, i) -> Message

Get ranges of sample values.

c_set1 :: (Integral i, Real n) => i -> n -> Message

Set single bus values.

c_setn1 :: (Integral i, Real n) => (i, [n]) -> Message

Set single range of bus values.

n_run1 :: Integral i => i -> Bool -> Message

Turn a single node on or off.

n_set1 :: (Integral i, Real n) => i -> String -> n -> Message

Set a single node control value.

s_new0 :: Integral i => String -> i -> AddAction -> i -> Message

s_new with no parameters.

Buffer segmentation and indices

b_segment :: Integral i => i -> i -> [i]

Segment a request for m places into sets of at most n.

b_segment 1024 2056 == [8,1024,1024]
b_segment 1 5 == replicate 5 1

b_indices :: Integral i => i -> i -> i -> [(i, i)]

Variant of b_segment that takes a starting index and returns (index,size) duples.

b_indices 1 5 0 == zip [0..4] (replicate 5 1)
b_indices 1024 2056 16 == [(16,8),(24,1024),(1048,1024)]

UGen commands.

pc_preparePartConv :: Integral i => i -> i -> i -> Message

Generate accumulation buffer given time-domain IR buffer and FFT size.

Unpack

unpack_n_info_datum_plain :: Num i => [Datum] -> [i]

Result is null for non-conforming data, or has five or sevel elements.

unpack_n_info_plain :: Num i => Message -> [i]

unpack_n_info :: Num i => Message -> Maybe (i, i, i, i, i, Maybe (i, i))

Unpack n_info message.

unpack_n_info_err :: Num i => Message -> (i, i, i, i, i, Maybe (i, i))

unpack_tr :: (Num i, Fractional f) => Message -> Maybe (i, i, f)

Unpack the '/tr' messages sent by sendTrig.

unpack_tr_err :: (Num i, Fractional f) => Message -> (i, i, f)

unpack_b_setn :: (Num i, Fractional f) => Message -> Maybe (i, i, i, [f])

unpack_b_setn_err :: (Num i, Fractional f) => Message -> (i, i, i, [f])

unpack_b_info :: (Num i, Fractional f) => Message -> Maybe (i, i, i, f)

Unpack b_info message, fields are (id,frames,channels,sample-rate).

unpack_b_info_err :: (Num i, Fractional f) => Message -> (i, i, i, f)

Variant generating error.