Sound.Sc3.Server.Command.Plain

Functions from Sound.Sc3.Server.Command.Generic specialised to Int and Double.

Types

type Buffer_Id = Int

Buffer identifier (buffer number).

type Buffer_Ix = Int

Buffer index (frame index).

type Buffer_Leave_File_Open = Bool

File connection flag.

type Bus_Id = Int

Audio/control bus identifier (number).

type Node_Id = Int

Node identifier (number).

type Group_Id = Int

Group-node identifier (number).

type Synth_Id = Int

Synth-node identifier (number).

Buffer commands (b_)

b_alloc :: Buffer_Id -> Int -> Int -> Message

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

b_allocRead :: Buffer_Id -> String -> Int -> Int -> Message

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

b_allocReadChannel :: Buffer_Id -> String -> Int -> Int -> [Int] -> Message

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

b_close :: Buffer_Id -> Message

Close attached soundfile and write header information. (Asynchronous)

b_fill :: Buffer_Id -> [(Buffer_Ix, Int, Double)] -> Message

Fill ranges of sample values.

b_free :: Buffer_Id -> Message

Free buffer data. (Asynchronous)

b_gen :: Buffer_Id -> String -> [Datum] -> Message

Call a command to fill a buffer. (Asynchronous)

b_get :: Buffer_Id -> [Buffer_Ix] -> Message

Get sample values.

b_getn :: Buffer_Id -> [(Buffer_Ix, Int)] -> Message

Get ranges of sample values.

b_query :: [Buffer_Id] -> Message

Request /b_info messages.

b_read :: Buffer_Id -> String -> Int -> Int -> Buffer_Ix -> Buffer_Leave_File_Open -> Message

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

b_readChannel :: Buffer_Id -> String -> Int -> Int -> Buffer_Ix -> Buffer_Leave_File_Open -> [Int] -> Message

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

b_set :: Buffer_Id -> [(Buffer_Ix, Double)] -> Message

Set sample values.

b_setn :: Buffer_Id -> [(Buffer_Ix, [Double])] -> Message

Set ranges of sample values.

b_write :: Buffer_Id -> String -> SoundFileFormat -> SampleFormat -> Int -> Buffer_Ix -> Buffer_Leave_File_Open -> Message

Write sound file data. (Asynchronous)

b_zero :: Buffer_Id -> Message

Zero sample data. (Asynchronous)

Control bus commands

c_fill :: [(Bus_Id, Int, Double)] -> Message

Fill ranges of bus values.

c_get :: [Bus_Id] -> Message

Get bus values.

c_getn :: [(Bus_Id, Int)] -> Message

Get ranges of bus values.

c_set :: [(Bus_Id, Double)] -> Message

Set bus values.

c_setn :: [(Bus_Id, [Double])] -> Message

Set ranges of bus values.

Instrument definition commands (d_)

d_recv_bytes :: Blob -> Message

Install a bytecode instrument definition. (Asynchronous)

d_recv_gr :: Graphdef -> Message

Graphdef encoding variant.

d_recv :: Synthdef -> Message

Synthdef encoding variant.

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 :: [Group_Id] -> Message

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

g_freeAll :: [Group_Id] -> Message

Delete all nodes in a set of groups.

g_head :: [(Group_Id, Node_Id)] -> Message

Add node to head of group.

g_new :: [(Group_Id, AddAction, Node_Id)] -> Message

Create a new group.

g_tail :: [(Group_Id, Node_Id)] -> Message

Add node to tail of group.

g_dumpTree :: [(Group_Id, Bool)] -> Message

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

g_queryTree :: [(Group_Id, Bool)] -> Message

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

Node commands (n_)

n_after :: [(Node_Id, Node_Id)] -> Message

Place a node after another.

n_before :: [(Node_Id, Node_Id)] -> Message

Place a node before another.

n_fill :: Node_Id -> [(String, Int, Double)] -> Message

Fill ranges of a node's control values.

n_free :: [Node_Id] -> Message

Delete a node.

n_map :: Node_Id -> [(String, Bus_Id)] -> Message

n_mapn :: Node_Id -> [(Int, Bus_Id, Int)] -> Message

Map a node's controls to read from buses. n_mapn only works if the control is given as an index and not as a name (3.8.0).

n_mapa :: Node_Id -> [(String, Bus_Id)] -> Message

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

n_mapan :: Node_Id -> [(String, Bus_Id, Int)] -> Message

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

n_query :: [Node_Id] -> Message

Get info about a node.

n_run :: [(Node_Id, Bool)] -> Message

Turn node on or off.

n_set :: Node_Id -> [(String, Double)] -> Message

Set a node's control values.

n_setn :: Node_Id -> [(Int, [Double])] -> Message

Set ranges of a node's control values.

n_trace :: [Node_Id] -> Message

Trace a node.

n_order :: AddAction -> Node_Id -> [Node_Id] -> Message

Move and order a sequence of nodes.

Par commands (p_)

p_new :: [(Group_Id, AddAction, Node_Id)] -> Message

Create a new parallel group (supernova specific).

Synthesis node commands (s_)

s_get :: Synth_Id -> [String] -> Message

Get control values.

s_getn :: Synth_Id -> [(String, Int)] -> Message

Get ranges of control values.

s_new :: String -> Synth_Id -> AddAction -> Node_Id -> [(String, Double)] -> Message

Create a new synth.

s_noid :: [Synth_Id] -> Message

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

Unit Generator commands (u_)

u_cmd :: Int -> Int -> 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 :: Int -> Message

Request /synced message when all current asynchronous commands complete.

Variants to simplify common cases

b_getn1 :: Buffer_Id -> (Buffer_Ix, Int) -> Message

Get ranges of sample values.

b_query1 :: Buffer_Id -> Message

Variant on b_query.

c_getn1 :: (Bus_Id, Int) -> Message

Get ranges of sample values.

c_set1 :: Bus_Id -> Double -> Message

Set single bus values.

c_setn1 :: (Bus_Id, [Double]) -> Message

Set single range of bus values.

n_run1 :: Node_Id -> Bool -> Message

Turn a single node on or off.

n_set1 :: Node_Id -> String -> Double -> Message

Set a single node control value.

s_new0 :: String -> Synth_Id -> AddAction -> Node_Id -> Message

s_new with no parameters.

Buffer segmentation and indices

b_segment :: Int -> Int -> [Int]

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
True

b_indices :: Int -> Int -> Int -> [(Int, Int)]

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)
True

>>> b_indices 1024 2056 16
[(16,8),(24,1024),(1048,1024)]

b_gen_copy :: Buffer_Id -> Int -> Buffer_Id -> Int -> Maybe Int -> Message

Call copy b_gen command.

b_gen_sine1 :: Buffer_Id -> [B_Gen] -> [Double] -> Message

Call sine1 b_gen command.

b_gen_sine2 :: Buffer_Id -> [B_Gen] -> [(Double, Double)] -> Message

Call sine2 b_gen command.

b_gen_sine3 :: Buffer_Id -> [B_Gen] -> [(Double, Double, Double)] -> Message

Call sine3 b_gen command.

b_gen_cheby :: Buffer_Id -> [B_Gen] -> [Double] -> Message

Call cheby b_gen command.

b_alloc_setn1 :: Buffer_Id -> Buffer_Ix -> [Double] -> Message

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

b_set1 :: Buffer_Id -> Buffer_Ix -> Double -> Message

Set single sample value.

b_setn1 :: Buffer_Id -> Buffer_Ix -> [Double] -> Message

Set a range of sample values.

b_setn1_segmented :: Int -> Buffer_Id -> Buffer_Ix -> [Double] -> [Message]

Segmented variant of b_setn1.

Ugen commands.

partConv_preparePartConv :: Int -> Int -> Int -> Message

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

Unpack

unpack_n_info_plain :: Message -> [Int]

unpack_n_info :: Message -> Maybe (Int, Int, Int, Int, Int, Maybe (Int, Int))

unpack_n_info_err :: Message -> (Int, Int, Int, Int, Int, Maybe (Int, Int))

unpack_tr :: Message -> Maybe (Int, Int, Double)

unpack_tr_err :: Message -> (Int, Int, Double)

unpack_b_setn :: Message -> Maybe (Int, Int, Int, [Double])

unpack_b_setn_err :: Message -> (Int, Int, Int, [Double])

unpack_b_info :: Message -> Maybe (Int, Int, Int, Double)

unpack_b_info_err :: Message -> (Int, Int, Int, Double)