Sound.SC3.UGen.UGen

UGen data structure representation and associated functions.

Documentation

toUId :: ID a => a -> UGenId

UId of resolveID.

ugen_user_name :: String -> Special -> String

Lookup operator name for operator UGens, else UGen name.

UGen graph functions

ugenTraverse :: (UGen -> UGen) -> UGen -> UGen

Depth first traversal of graph at u applying f to each node.

ugenFoldr :: (UGen -> a -> a) -> a -> UGen -> a

Right fold of UGen graph.

Unit generator node constructors

control_f64 :: Rate -> Maybe Int -> String -> Sample -> UGen

Control input node constructor.

control :: Rate -> String -> Double -> UGen

Control input node constructor.

Note that if the name begins with a t_ prefix the control is not converted to a triggered control. Please see tr_control.

meta_control :: Rate -> String -> Double -> C_Meta' Double -> UGen

Variant of control with meta data.

tr_control_f64 :: Maybe Int -> String -> Sample -> UGen

Triggered (kr) control input node constructor.

tr_control :: String -> Double -> UGen

Triggered (kr) control input node constructor.

control_set :: [UGen] -> [UGen]

Set indices at a list of controls.

mrg2 :: UGen -> UGen -> UGen

Multiple root graph node constructor.

Multiple channel expansion

mce2 :: UGen -> UGen -> UGen

Multiple channel expansion for two inputs.

mce2c :: UGen -> (UGen, UGen)

Extract two channels from possible MCE.

mce3 :: UGen -> UGen -> UGen -> UGen

Multiple channel expansion for two inputs.

mceMap :: (UGen -> UGen) -> UGen -> UGen

Apply a function to each channel at a unit generator.

mceEdit :: ([UGen] -> [UGen]) -> UGen -> UGen

Apply UGen list operation on MCE contents.

mceReverse :: UGen -> UGen

Reverse order of channels at MCE.

mceChannel :: Int -> UGen -> UGen

Obtain indexed channel at MCE.

mceTranspose :: UGen -> UGen

Transpose rows and columns, ie. {{a,b},{c,d}} to {{a,c},{b,d}}.

mceSum :: UGen -> UGen

Collapse mce by summing (see also mix and mixN).

Transform

sep_first :: [t] -> Maybe (t, [t])

Separate first list element.

sep_first "astring" == Just ('a',"string")

sep_last :: [t] -> Maybe ([t], t)

Separate last list element.

sep_last "stringb" == Just ("string",'b')

halt_mce_transform' :: (a -> [a]) -> [a] -> [a]

Given unmce function make halt mce transform.

halt_mce_transform :: [UGen] -> [UGen]

The halt MCE transform, ie. lift channels of last input into list.

halt_mce_transform [1,2,mce2 3 4] == [1,2,3,4]

Multiple root graphs

Labels

label :: String -> UGen

Lift a String to a UGen label (ie. for poll).

equal_length_p :: [[a]] -> Bool

Are lists of equal length?

equal_length_p ["t1","t2"] == True
equal_length_p ["t","t1","t2"] == False

unpackLabel :: UGen -> [UGen]

Unpack a label to a length prefixed list of Constants. There is a special case for mce nodes, but it requires labels to be equal length. Properly, poll would not unpack the label, it would be done by the synthdef builder.

Bitwise

bitAnd :: UGen -> UGen -> UGen

bitOr :: UGen -> UGen -> UGen

bitXOr :: UGen -> UGen -> UGen

bitNot :: UGen -> UGen

shiftLeft :: UGen -> UGen -> UGen

shiftRight :: UGen -> UGen -> UGen

unsignedShift :: UGen -> UGen -> UGen

(.<<.) :: UGen -> UGen -> UGen

(.>>.) :: UGen -> UGen -> UGen

Analysis

ugen_primitive :: UGen -> [Primitive]

UGen primitive. Sees through Proxy and MRG, possible multiple primitives for MCE.

primitive_is_pv_rate :: String -> Bool

Heuristic based on primitive name (FFT, PV_). Note that IFFT is at control rate, not PV rate.

ugen_is_pv_rate :: UGen -> Bool

Variant on primitive_is_pv_rate.

pv_track_buffer :: UGen -> Either String UGen

Traverse input graph until an FFT or PV_Split node is encountered, and then locate the buffer input. Biases left at MCE nodes.

import Sound.SC3
let z = soundIn 4
let f1 = fft 10 z 0.5 0 1 0
let f2 = ffta 'a' 1024 z 0.5 0 1 0
pv_track_buffer (pv_BrickWall f1 0.5) == Right 10
pv_track_buffer (pv_BrickWall f2 0.5) == Right (localBuf 'a' 1024 1)

buffer_nframes :: UGen -> UGen

Buffer node number of frames. Biases left at MCE nodes. Sees through LocalBuf, otherwise uses bufFrames.

buffer_nframes 10 == bufFrames IR 10
buffer_nframes (control KR "b" 0) == bufFrames KR (control KR "b" 0)
buffer_nframes (localBuf 'α' 2048 1) == 2048

pv_track_nframes :: UGen -> Either String UGen

pv_track_buffer then buffer_nframes.