Sound.DF

Interaction with jack.dl server

b_alloc :: Int -> Int -> OSC

Allocate buffer.

g_load :: Int -> String -> OSC

Load graph.

g_unload :: Int -> OSC

Load graph.

with_jack_dl :: (UDP -> IO a) -> IO a

Run action with UDP link to jack.dl.

audition :: [OSC] -> Node -> IO ()

Audition graph n after sending initialisation messages is.

C code generator

code_gen :: Node -> String

Generate C code for graph.

dl_gen :: FilePath -> Node -> IO ()

Generate C code, write file disk and call GNU C compiler to build shared library.

Graph drawing

view :: Node -> IO ()

Draw graph using graphviz.

Graph analysis

nodes :: Node -> [Node]

List of nodes, in left biased order.

label :: [(NodeID, Node)] -> Node -> NodeID

Read label of node.

source :: [(NodeID, Node)] -> Node -> (NodeID, PortID)

Transform node to source, see through rec_r and proxy and mrg.

type Edge = ((NodeID, PortID), (NodeID, PortID))

Edge between ports.

edges :: [(NodeID, Node)] -> Node -> [Edge]

List incoming node edges,

analyse :: [Node] -> [((NodeID, Node), [Edge])]

Label nodes and list edges. Proxy and multiple-root nodes are erased.

mod_e :: Edge -> (NodeID, NodeID, (PortID, PortID))

Transform edge into form required by fgl.

graph :: Node -> Gr Node (PortID, PortID)

Generate graph.

tsort :: Node -> [Node]

Topological sort of nodes (via graph).

The Node data type

data R_ID

Recursion identifer.

Constructors

R_ID Int

Instances

Eq R_ID

data Type

Enumeration of types of data on ports.

Constructors

Real_Type

Integer_Type

Boolean_Type

Instances

Eq Type

Show Type

data Constant

Constant values.

Constructors

Real_Constant Double

Integer_Constant Int

Instances

Eq Constant

Show Constant

How to display constants.

data Port

Port meta data.

Constructors

Port

Fields

port_data_type :: Type

port_tokens :: Int

Instances

Eq Port

data Node

Data flow node.

Constructors

S

Fields

constant :: Constant

A

Fields

operator :: String

inputs :: [Node]

outputs :: [Port]

R

Fields

identifier :: R_ID

input :: Either Constant (Node, Node)

P

Fields

proxy :: Node

port :: Int

M

Fields

mleft :: Node

mright :: Node

Instances

Eq Node

Floating Node

Fractional Node

Num Node

Ord Node

Show Node

How to display nodes.

type NodeID = Int

Node identifier.

type PortID = Int

Port identifier.

mrg :: Node -> Node -> Node

Multiple root graph (alias for M).

Querying data type on ports

constant_type :: Constant -> Type

Type of a constant value.

node_type :: Node -> Type

Type of a node.

Numeric primitives for class instances

n_real_constant :: Double -> Node

Lift constant to node.

n_integer_constant :: Int -> Node

Lift constant to node.

numerical_unary_operator :: String -> Node -> Node

Unary operator over Real and Integer values.

numerical_binary_operator :: String -> Node -> Node -> Node

Binary operator over Real and Integer values.

real_unary_operator :: String -> Node -> Node

Unary operator over Real values.

real_binary_operator :: String -> Node -> Node -> Node

Binary operator over Real values.

n_add :: Node -> Node -> Node

Addition.

n_mul :: Node -> Node -> Node

Multiplication.

n_sub :: Node -> Node -> Node

Subtraction.

n_negate :: Node -> Node

Negation.

n_abs :: Node -> Node

Absolute value.

n_signum :: Node -> Node

Sign of.

n_div :: Node -> Node -> Node

Division.

n_recip :: Node -> Node

Reciprocal.

n_exp :: Node -> Node

Natural exponential.

n_sqrt :: Node -> Node

Square root.

n_log :: Node -> Node

Natural logarithm.

n_pow :: Node -> Node -> Node

p to the power of q.

n_sin :: Node -> Node

Sine.

n_cos :: Node -> Node

Cosine.

n_tan :: Node -> Node

Tangent.

numerical_comparison_operator :: String -> Node -> Node -> Node

Operator from Real or Integer values to a Boolean value.

n_lt :: Node -> Node -> Node

Less than.

n_gte :: Node -> Node -> Node

Greater than or equal to.

n_gt :: Node -> Node -> Node

Greater than.

n_lte :: Node -> Node -> Node

Less than or equal to.

n_max :: Node -> Node -> Node

Maximum.

n_min :: Node -> Node -> Node

Minimum.

n_floor :: Node -> Node

Real valued floor.

n_lrint :: Node -> Node

Integer valued floor.

Class of monads generating identifers

class Monad m => ID m where

Methods

generateID :: m Int

Instances

ID IO

Backward arcs

rec_r :: R_ID -> Constant -> (Node -> (Node, Node)) -> Node

Introduce backward arc with implicit unit delay.

rec :: ID m => Constant -> (Node -> (Node, Node)) -> m Node

Monadic variant of rec_r.

recm :: ID m => Constant -> (Node -> m (Node, Node)) -> m Node

Variant or rec with monadic action in backward arc.

Primitive unit generators

uniform_operator :: Type -> Int -> String -> [Node] -> Node

Uniform input type operator.

out1 :: Node -> Node

Single channel output.

out2 :: (Node, Node) -> Node

Two channel output.

out3 :: (Node, Node, Node) -> Node

Three channel output.

sample_rate :: Node

Operating sample rate.

eq :: Node -> Node -> Node

Equal to.

select2 :: Node -> Node -> Node -> Node

If p then q else r.

logical_operator :: String -> Node -> Node -> Node

Binary boolean valued operator.

n_and :: Node -> Node -> Node

Logical and.

n_or :: Node -> Node -> Node

Logical or.

b_read :: Node -> Node -> Node

Buffer read.

b_write :: Node -> Node -> Node -> Node

Buffer write.

white_noise_u :: Node -> Node

White noise (0, 1).

Ordinary unit generators

pan2 :: Node -> Node -> (Node, Node)

Linear pan.

swap :: a -> b -> (b, a)

Reversed tuple constructor, (ie. flip (,))

split :: a -> (a, a)

Duplicate a value into a tuple.

unit_delay :: ID m => Constant -> Node -> m Node

Single sample delay with indicated initial value.

iir1 :: ID m => Constant -> (Node -> Node -> Node) -> Node -> m Node

Single place infinte impulse response filter with indicated initial value.

iir2 :: ID m => (Node -> Node -> Node -> Node) -> Node -> m Node

Two place infinte impulse response filter.

fir1 :: ID m => (Node -> Node -> Node) -> Node -> m Node

Single place finte impulse response filter.

fir2 :: ID m => (Node -> Node -> Node -> Node) -> Node -> m Node

Two place finte impulse response filter.

biquad :: ID m => (Node -> Node -> Node -> Node -> Node -> Node) -> Node -> m Node

Ordinary biquad filter section.

counter :: ID m => Constant -> Node -> m Node

Counter from indicated initial value.

radians_per_sample :: Node

Environment value, equal to two_pi / sample_rate.

hz_to_incr :: Node -> Node -> Node -> Node

r = cycle (two-pi), hz = frequency, sr = sample rate

two_pi :: Floating a => a

Two pi.

clipr :: Node -> Node -> Node

If 'q >= p' then 'q - p' else q.

phasor :: ID m => Constant -> Node -> Node -> m Node

r = right hand edge, ip = initial phase, x = increment

sin_osc :: ID m => Node -> Double -> m Node

Sine oscillator, f = frequency in hz.

lf_saw :: ID m => Node -> Double -> m Node

Non-band limited sawtooth oscillator.

lf_pulse :: ID m => Node -> Double -> Node -> m Node

Non-band limited pulse oscillator, w = width (0,1).

midi_cps :: Floating a => a -> a

Midi note number to cycles per second.

mul_add :: Num a => a -> a -> a -> a

Multiply and add.

calc_fb :: Floating a => a -> a -> a

delay :: ID m => Node -> Node -> Node -> m Node

Delay.

buf_comb_n :: ID m => Node -> Node -> Node -> Node -> m Node

Comb filter.

rlpf :: ID m => Node -> Node -> Node -> m Node

Resonant low pass filter, f = frequency, r = resonance.

clip2 :: Node -> Node -> Node

Constrain p in (-q, q).

white_noise :: Node -> Node

White noise (-1, 1).

white_noise_m :: ID m => m Node

White noise (-1, 1).

brown_noise_m :: ID m => m Node

Brown noise (-1, 1).

bpz2 :: ID m => Node -> m Node

Two zero fixed midpass filter.

brz2 :: ID m => Node -> m Node

Two zero fixed midcut filter.

lpz1 :: ID m => Node -> m Node

Two point average filter

lpz2 :: ID m => Node -> m Node

Two zero fixed lowpass filter

one_pole :: ID m => Node -> Node -> m Node

One pole filter.

one_zero :: ID m => Node -> Node -> m Node

One zero filter.

sos :: ID m => Node -> Node -> Node -> Node -> Node -> Node -> m Node

Second order filter section.

impulse :: ID m => Node -> Double -> m Node

Impulse oscillator (non band limited).

resonz :: ID m => Node -> Node -> Node -> m Node

Two pole resonant filter.

latch :: ID m => Node -> Node -> m Node

Sample and hold.

lin_lin :: Fractional a => a -> a -> a -> a -> a -> a

Linear range conversion.

lin_exp :: Floating a => a -> a -> a -> a -> a -> a

Exponential range conversion.

decay :: ID m => Node -> Node -> m Node

Exponential decay.

decay2 :: ID m => Node -> Node -> Node -> m Node

Exponential decay (equvalent to decay dcy - decay atk).

delay1 :: ID m => Node -> m Node

Single sample delay.

delay2 :: ID m => Node -> m Node

Two sample delay.

lag :: ID m => Node -> Node -> m Node

Simple averaging filter.

lag2 :: ID m => Node -> Node -> m Node

Nested lag filter.

lag3 :: ID m => Node -> Node -> m Node

Twice nested lag filter.