1 rsc3: server commands

server commands

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

[ int - group ID ] * N

Traverses all groups below this group and frees all the synths. Sub-groups are not freed. A list of groups may be specified.

1.2 /c_setn Set ranges of bus value(s)

[ int - starting bus index int - number of sequential buses to change (M) [ float - a control value ] * M ] * N

Set contiguous ranges of buses to sets of values. For each range, the starting bus index is given followed by the number of channels to change, followed by the values.

1.3 /sync Notify when async commands have completed.

int - a unique number identifying this command.

Replies with a /synced message when all asynchronous commands received before this one have completed. The reply will contain the sent unique ID.

Asynchronous. Replies to sender with /synced, ID when complete.

1.4 /s_getn Get ranges of control value(s)

int - synth ID [ int|string - a control index or name int - number of sequential controls to get (M) ] * N

Get contiguous ranges of controls. Replies to sender with the corresponding /n_setn command.

1.5 /s_get Get control value(s)

int - synth ID [ int or string - a control index or name ] * N

Replies to sender with the corresponding /n_set command.

1.6 /n_mapn Map a node’s controls to read from buses

int - node ID [ int or string - a control index or name int - control bus index int - number of controls to map ] * N

Takes a list of triplets of control names or indices, bus indices, and number of controls to map and causes those controls to be mapped sequentially to buses. If the node is a group, then it maps the controls of every node in the group. If the control bus index is -1 then any current mapping is undone and control reverts to normal.

See also: /n_map

1.7 /b_gen Call a command to fill a buffer

int - buffer number string - command name .. command arguments

Plug-ins can define commands that operate on buffers. The arguments after the command name are defined by the command. The currently defined buffer fill commands are listed below in a separate section.

Buffer Fill Commands

These are the currently defined fill routines for use with the /b_gen command.

Common flags are defined as follows:

1 - normalize Normalize peak amplitude of wave to 1.0. 2 - wavetable If set, then the buffer is written in wavetable format so that it can be read by interpolating oscillators. 4 - clear If set then the buffer is cleared before new partials are written into it. Otherwise the new partials are summed with the existing contents of the buffer.

sine1 int - flags, see above [ float - partial amplitude ] * N

Fills a buffer with a series of sine wave partials. The first float value specifies the amplitude of the first partial, the second float value specifies the amplitude of the second partial, and so on.

sine2 int - flags, see above [ float - partial frequency (in cycles per buffer) float - partial amplitude ] * N

Similar to sine1 except that each partial frequency is specified explicitly instead of being an integer series of partials. Non-integer partial frequencies are possible.

sine3 int - flags, see above [ float - partial frequency (in cycles per buffer) float - partial amplitude float - partial phase ] * N

Similar to sine2 except that each partial may have a nonzero starting phase.

cheby int - flags, see above [ float - amplitude ] * N

Fills a buffer with a series of chebyshev polynomials, which can be defined as: cheby(n) = amplitude * cos(n * acos(x)). The first float value specifies the amplitude for n = 1, the second float value specifies the amplitude for n = 2, and so on. To eliminate a DC offset when used as a waveshaper, the wavetable is offset so that the center value is zero.

copy int - sample position in destination int - source buffer number int - sample position in source int - number of samples to copy

Copy samples from the source buffer to the destination buffer specified in the b_gen command. If the number of samples to copy is negative, the maximum number of samples possible is copied. Asynchronous. Replies to sender with /done when complete.

1.8 /n_trace Trace a node

[ int - node ID ] * N

Causes a synth to print out the values of the inputs and outputs of its unit generators for one control period. Causes a group to print the node IDs and names of each node in the group for one control period.

1.9 /b_alloc Allocate buffer space.

int - buffer number int - number of frames int - number of channels (optional. default = 1 channel) bytes - an OSC message to execute upon completion. (optional)

Allocates zero filled buffer to number of channels and samples.

Asynchronous. Replies to sender with /done when complete.

1.10 /n_query Get info about a node

[ int - node ID ] * N

The server sends an /n_info message for each node to registered clients.

See Node Notifications below for the format of the /n_info message.

1.11 /d_load Load synth definition

string - pathname of file. Can be a pattern like "synthdefs/perc-*" bytes - an OSC message to execute upon completion. (optional)

Loads a file of synth definitions. Resident definitions with the same names are overwritten.

Asynchronous. Replies to sender with /done when complete.

1.12 /n_fill Fill ranges of a node’s control value(s)

int - node ID [ int or string - a control index or name int - number of values to fill (M) float - value ] * N

Set contiguous ranges of control indices to single values. For each range, the starting control index is given followed by the number of controls to change, followed by the value to fill. If the node is a group, then it sets the controls of every node in the group.

1.13 /n_before Place a node before another

[ int - the ID of the node to place (A) int - the ID of the node before which the above is placed (B) ] * N

Places node A in the same group as node B, to execute immediately before node B.

1.14 /b_close

int - buffer number

After using a buffer with DiskOut, close the soundfile and write header information.

1.15 see s-new

1.16 /s_new Create a new synth

string - synth definition name int - synth ID int - add action (0,1,2, 3 or 4 see below) int - add target ID [ int or string - a control index or name float - a control value ] * N

Create a new synth from a synth definition, give it an ID, and add it to the tree of nodes. There are four ways to add the node to the tree as determined by the add action argument which is defined as follows:

0 - add the new node to the the head of the group specified by the add target ID.

1 - add the new node to the the tail of the group specified by the add target ID.

2 - add the new node just before the node specified by the add target ID.

3 - add the new node just after the node specified by the add target ID.

4 - the new node replaces the node specified by the add target ID. The target node is freed.

Controls may be set when creating the synth. The control arguments are the same as for the n_set command.

If you send /s_new with a synth ID of -1, then the server will generate an ID for you. The server reserves all negative IDs. Since you don’t know what the ID is, you cannot talk to this node directly later. So this is useful for nodes that are of finite duration and that get the control information they need from arguments and buses or messages directed to their group. In addition no notifications are sent when there are changes of state for this node, such as /go, /end, /on, /off.

If you use a node ID of -1 for any other command, such as /n_map, then it refers to the most recently created node by /s_new (auto generated ID or not). This is how you can map the controls of a node with an auto generated ID. In a multi-client situation, the only way you can be sure what node -1 refers to is to put the messages in a bundle.

1.17 /b_setn Set ranges of sample value(s)

int - buffer number [ int - sample starting index int - number of sequential samples to change (M) [ float - a sample value ] * M ] * N

Set contiguous ranges of sample indices to sets of values. For each range, the starting sample index is given followed by the number of samples to change, followed by the values.

1.18 /c_set Set bus value(s)

[ int - a bus index float - a control value ] * N

Takes a list of pairs of bus indices and values and sets the buses to those values.

1.19 /n_free Delete a node.

[ int - node ID ] * N

Stops a node abruptly, removes it from its group, and frees its memory. A list of node IDs may be specified. Using this method can cause a click if the node is not silent at the time it is freed.

1.20 see n-set

1.21 /n_run Turn node on or off

[ int - node ID int - run flag ] * N

If the run flag set to zero then the node will not be executed. If the run flag is set back to one, then it will be executed. Using this method to start and stop nodes can cause a click if the node is not silent at the time run flag is toggled.

1.22 /b_read Read sound file data into an existing buffer.

int - buffer number string - path name of a sound file. int - starting frame in file (optional. default = 0) int - number of frames to read (optional. default = -1, see below) int - starting frame in buffer (optional. default = 0) int - leave file open (optional. default = 0) bytes - an OSC message to execute upon completion. (optional)

Reads sound file data from the given starting frame in the file and writes it to the given starting frame in the buffer. If number of frames is less than zero, the entire file is read. If reading a file to be used by DiskIn ugen then you will want to set "leave file open" to one, otherwise set it to zero.

Asynchronous. Replies to sender with /done when complete.

1.23 /nrt_end end real time mode, close file

**NOT YET IMPLEMENTED**

no arguments.

This message should be sent in a bundle in non real time mode. The bundle timestamp will establish the ending time of the file. This command will end non real time mode and close the sound file. Replies to sender with /done when complete.

1.24 /b_get Get sample value(s)

int - buffer number [ int - a sample index ] * N

Replies to sender with the corresponding /b_set command.

1.25 /n_after Place a node after another

[ int - the ID of the node to place (A) int - the ID of the node after which the above is placed (B) ] * N

Places node A in the same group as node B, to execute immediately after node B.

1.26 /d_free delete synth definition

[ string - synth def name ] * N

Removes a synth definition once all synths using it have ended.

1.27 /n_set Set a node’s control value(s)

int - node ID [ int or string - a control index or name float - a control value ] * N

Takes a list of pairs of control indices and values and sets the controls to those values. If the node is a group, then it sets the controls of every node in the group.

(with-sc3 (lambda (fd) (letc ((f 440) (a 0.1)) (send-synth fd "sin" (out 0 (mul (sin-osc ar f 0) a)))) (send fd (s-new0 "sin" 1001 add-to-tail 1))))

(with-sc3 (lambda (fd) (send fd (n-set1 1001 "f" 1280))))

(with-sc3 (lambda (fd) (send fd (n-set 1001 (list (tuple2 "f" (random 60 900)) (tuple2 "a" (random 0.05 0.25)))))))

1.28 /b_write Write sound file data.

int - buffer number string - path name of a sound file. string - header format. string - sample format. int - number of frames to write (optional. default = -1, see below) int - starting frame in buffer (optional. default = 0) int - leave file open (optional. default = 0) bytes - an OSC message to execute upon completion. (optional)

Write a buffer as a sound file. Header format is one of: "aiff", "next", "wav", "ircam"", "raw" Sample format is one of: "int8", "int16", "int24", "int32", "float", "double", "mulaw", "alaw"

Not all combinations of header format and sample format are possible. If number of frames is less than zero, all samples from the starting frame to the end of the buffer are written. If opening a file to be used by DiskOut ugen then you will want to set "leave file open" to one, otherwise set it to zero. If "leave file open" is set to one then the file is created, but no frames are written until the DiskOut ugen does so.

Asynchronous. Replies to sender with /done when complete.

1.29 /b_getn Get ranges of sample value(s)

int - buffer number [ int - starting sample index int - number of sequential samples to get (M) ] * N

Get contiguous ranges of samples. Replies to sender with the corresponding /b_setn command. This is only meant for getting a few samples, not whole buffers or large sections.

1.30 /b_fill Fill ranges of sample value(s)

int - buffer number [ int - sample starting index int - number of samples to fill (M) float - value ] * N

Set contiguous ranges of sample indices to single values. For each range, the starting sample index is given followed by the number of samples to change, followed by the value to fill. This is only meant for setting a few samples, not whole buffers or large sections.

1.31 /s_noid Auto-reassign synth’s ID to a reserved value

[ int - synth ID ] * N

This command is used when the client no longer needs to communicate with the synth and wants to have the freedom to reuse the ID. The server will reassign this synth to a reserved negative number. This command is purely for bookkeeping convenience of the client. No notification is sent when this occurs.

1.32 /d_recv Receive a synth definition file

bytes - buffer of data. bytes - an OSC message to execute upon completion. (optional)

Loads a file of synth definitions from a buffer in the message. Resident definitions with the same names are overwritten.

Asynchronous. Replies to sender with /done when complete.

1.33 /u_cmd send a command to a unit generator

int - node ID int - unit generator index string - command name ...any arguments

Sends all arguments following the command name to the unit generator to be performed. Commands are defined by unit generator plug ins.

1.34 /b_allocRead Allocate buffer space and read a sound file.

int - buffer number string - path name of a sound file. int - starting frame in file (optional. default = 0) int - number of frames to read (optional. default = 0, see below) bytes - an OSC message to execute upon completion. (optional)

Allocates buffer to number of channels of file and number of samples requested, or fewer if sound file is smaller than requested. Reads sound file data from the given starting frame in the file. If the number of frames argument is less than or equal to zero, the entire file is read.

Asynchronous. Replies to sender with /done when complete.

1.35 /n_map Map a node’s controls to read from a bus

int - node ID [ int or string - a control index or name int - control bus index ] * N

Takes a list of pairs of control names or indices and bus indices and causes those controls to be read continuously from a global control bus instead of responding to n_set, n_setn and n_fill commands. If the node is a group, then it maps the controls of every node in the group. If the control bus index is -1 then any current mapping is undone and control reverts to normal.

1.36 /status Query the status

No arguments.

Replies to sender with the following message.

/status.reply int - 1. unused. int - number of unit generators. int - number of synths. int - number of groups. int - number of loaded synth definitions. float - average percent CPU usage for signal processing float - peak percent CPU usage for signal processing double - nominal sample rate double - actual sample rate

1.37 /g_new Create a new group

[ int - new group ID int - add action (0,1,2, 3 or 4 see below) int - add target ID ] * N

Create a new group and add it to the tree of nodes.

There are four ways to add the group to the tree as determined by the add action argument which is defined as follows (the same as for "/s_new"):

0 - add the new group to the the head of the group specified by the add target ID.

1 - add the new group to the the tail of the group specified by the add target ID.

2 - add the new group just before the node specified by the add target ID.

3 - add the new group just after the node specified by the add target ID.

4 - the new node replaces the node specified by the add target ID. The target node is freed.

Multiple groups may be created in one command by adding arguments.

1.38 /c_get Get bus value(s)

[ int - a bus index ] * N

Takes a list of buses and replies to sender with the corresponding /c_set command.

1.39 /b_set Set sample value(s)

int - buffer number [ int - a sample index float - a sample value ] * N

Takes a list of pairs of sample indices and values and sets the samples to those values.

1.40 /b_zero Zero sample data

int - buffer number bytes - an OSC message to execute upon completion. (optional)

Sets all samples in the buffer to zero.

Asynchronous. Replies to sender with /done when complete.

1.41 /tr A trigger message

int - node ID int - trigger ID float - trigger value

This command is the mechanism that synths can use to trigger events in clients.

The node ID is the node that is sending the trigger. The trigger ID and value are determined by inputs to the SendTrig unit generator which is the originator of this message.

1.42 /dumpOSC Display incoming OSC messages

int - code

Turns on and off printing of the contents of incoming Open Sound Control messages. This is useful when debugging your command stream.

The values for the code are as follows: 0 - turn dumping OFF. 1 - print the parsed contents of the message. 2 - print the contents in hexadecimal. 3 - print both the parsed and hexadecimal representations of the contents.

1.43 /n_setn Set ranges of a node’s control value(s)

int - node ID [ int or string - a control index or name int - number of sequential controls to change (M) [ float - a control value ] * M ] * N

Set contiguous ranges of control indices to sets of values. For each range, the starting control index is given followed by the number of controls to change, followed by the values. If the node is a group, then it sets the controls of every node in the group.

1.44 /b_free Free buffer data.

int - buffer number bytes - an OSC message to execute upon completion. (optional)

Frees buffer space allocated for this buffer.

Asynchronous. Replies to sender with /done when complete.

1.45 /notify Register to receive notifications from server

int - one to receive notifications, zero to stop receiving them.

If argument is one, server will remember your return address and send you notifications. if argument is zero, server will stop sending you notifications.

Asynchronous. Replies to sender with /done when complete.

1.46 /b_query

[ int - buffer number ] * N

Responds to the sender with a /b_info message. The arguments to /b_info are as follows:

[ int - buffer number int - number of frames int - number of channels float - sample rate ] * N

(with-sc3 (lambda (fd) (async fd (/b_alloc 10 6 1)) (async fd (/b_query 10))))

1.47 /g_tail Add node to tail of group

[ int - group ID int - node ID ] * N

Adds the node to the tail (last to be executed) of the group.

1.48 /clearSched Clear all scheduled bundles.

Removes all bundles from the scheduling queue.

1.49 /g_freeAll Delete all nodes in a group.

[ int - group ID ] * N

Frees all nodes in the group. A list of groups may be specified.

1.50 /g_head Add node to head of group

[ int - group ID int - node ID ] * N

Adds the node to the head (first to be executed) of the group.

1.51 /c_getn Get ranges of bus value(s)

[ int - starting bus index int - number of sequential buses to get (M) ] * N

Get contiguous ranges of buses. Replies to sender with the corresponding /c_setn command.

1.52 /quit Quit program

No arguments.

Exits the synthesis server.

Asynchronous. Replies to sender with /done just before completion.

1.53 see g-new

1.54 /c_fill Fill ranges of bus value(s)

[ int - starting bus index int - number of buses to fill (M) float - value ] * N

Set contiguous ranges of buses to single values. For each range, the starting sample index is given followed by the number of buses to change, followed by the value to fill.