Sound.SC3.UGen.Graph

Graph and related types.

Type

type NodeId = Int

Node identifier.

type PortIndex = Int

Port index.

data Graph

Type to represent unit generator graph.

Constructors

Graph

Fields

• nextId :: NodeId
• constants :: [Node]
• controls :: [Node]
• ugens :: [Node]

Instances

Show Graph

Methods

showsPrec :: Int -> Graph -> ShowS

show :: Graph -> String

showList :: [Graph] -> ShowS

data KType

Enumeration of the four operating rates for controls.

Constructors

K_IR

K_KR

K_TR

K_AR

Instances

Eq KType

Methods

(==) :: KType -> KType -> Bool

(/=) :: KType -> KType -> Bool

Ord KType

Methods

compare :: KType -> KType -> Ordering

(<) :: KType -> KType -> Bool

(<=) :: KType -> KType -> Bool

(>) :: KType -> KType -> Bool

(>=) :: KType -> KType -> Bool

max :: KType -> KType -> KType

min :: KType -> KType -> KType

Show KType

Methods

showsPrec :: Int -> KType -> ShowS

show :: KType -> String

showList :: [KType] -> ShowS

data FromPort

Type to represent the left hand side of an edge in a unit generator graph.

Constructors

FromPort_C

Fields

• port_nid :: NodeId

FromPort_K

Fields

• port_nid :: NodeId
• port_kt :: KType

FromPort_U

Fields

• port_nid :: NodeId
• port_idx :: Maybe PortIndex

Instances

Eq FromPort

Methods

(==) :: FromPort -> FromPort -> Bool

(/=) :: FromPort -> FromPort -> Bool

Show FromPort

Methods

showsPrec :: Int -> FromPort -> ShowS

show :: FromPort -> String

showList :: [FromPort] -> ShowS

data ToPort

A destination port.

Constructors

ToPort NodeId PortIndex

Instances

Eq ToPort

Methods

(==) :: ToPort -> ToPort -> Bool

(/=) :: ToPort -> ToPort -> Bool

Show ToPort

Methods

showsPrec :: Int -> ToPort -> ShowS

show :: ToPort -> String

showList :: [ToPort] -> ShowS

type Edge = (FromPort, ToPort)

A connection from FromPort to ToPort.

data Node

Type to represent nodes in unit generator graph.

Constructors

NodeC

Fields

• node_id :: NodeId
• node_c_value :: Sample

NodeK

Fields

• node_id :: NodeId
• node_k_rate :: Rate
• node_k_index :: Maybe Int
• node_k_name :: String
• node_k_default :: Sample
• node_k_type :: KType
• node_k_meta :: Maybe (C_Meta Sample)

NodeU

Fields

• node_id :: NodeId
• node_u_rate :: Rate
• node_u_name :: String
• node_u_inputs :: [FromPort]
• node_u_outputs :: [Output]
• node_u_special :: Special
• node_u_ugenid :: UGenId

NodeP

Fields

• node_id :: NodeId
• node_p_node :: Node
• node_p_index :: PortIndex

Instances

Show Node

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

node_k_eq :: Node -> Node -> Bool

node_rate :: Node -> Rate

Rate of Node, ie. IR for constants, & see through NodeP.

Building

find_node :: Graph -> NodeId -> Maybe Node

Find Node with indicated NodeId.

node_label :: Node -> String

Generate a label for Node using the type and the node_id.

port_idx_or_zero :: FromPort -> PortIndex

Get port_idx for FromPort_U, else 0.

is_node_c :: Node -> Bool

Is Node a constant.

is_node_k :: Node -> Bool

Is Node a control.

is_node_u :: Node -> Bool

Is Node a UGen.

edges :: [Node] -> [Edge]

Calculate all edges given a set of NodeU.

as_from_port :: Node -> FromPort

Transform Node to FromPort.

from_port_node :: Graph -> FromPort -> Maybe Node

Locate Node of FromPort in Graph.

empty_graph :: Graph

The empty Graph.

graph_maximum_id :: Graph -> NodeId

Find the maximum NodeId used at Graph (this ought normally be the nextId).

node_k_cmp :: Node -> Node -> Ordering

Compare NodeK values on node_k_type.

ktype :: Rate -> Bool -> KType

Determine class of control given Rate and trigger status.

find_c_p :: Sample -> Node -> Bool

Predicate to determine if Node is a constant with indicated value.

push_c :: Sample -> Graph -> (Node, Graph)

Insert a constant Node into the Graph.

mk_node_c :: Constant -> Graph -> (Node, Graph)

Either find existing Constant Node, or insert a new Node.

find_k_p :: String -> Node -> Bool

Predicate to determine if Node is a control with indicated name. Names must be unique.

push_k :: Control -> Graph -> (Node, Graph)

Insert a control node into the Graph.

mk_node_k :: Control -> Graph -> (Node, Graph)

Either find existing Control Node, or insert a new Node.

type UGenParts = (Rate, String, [FromPort], [Output], Special, UGenId)

find_u_p :: UGenParts -> Node -> Bool

Predicate to locate primitive, names must be unique.

push_u :: UGenParts -> Graph -> (Node, Graph)

Insert a primitive NodeU into the Graph.

mk_node_u_acc :: [UGen] -> [Node] -> Graph -> ([Node], Graph)

mk_node_u :: Primitive -> Graph -> (Node, Graph)

Either find existing Primitive node, or insert a new Node.

mk_node_p :: Node -> PortIndex -> Graph -> (Node, Graph)

Proxies do not get stored in the graph.

mk_node :: UGen -> Graph -> (Node, Graph)

Transform UGen into Graph, appending to existing Graph.

prepare_root :: UGen -> UGen

Transform mce nodes to mrg nodes

sort_controls :: [Node] -> [Node]

If controls have been given indices they must be coherent.

mk_graph :: UGen -> Graph

Variant on mk_node starting with an empty graph, reverses the UGen list and sorts the Control list, and adds implicit nodes.

Encoding

type Map = IntMap Int

type Maps = (Map, [Node], Map, Map, [(KType, Int)])

node_ktype :: Node -> Maybe KType

Determine KType of a control UGen at NodeU, or not.

mk_ktype_map :: [Node] -> [(KType, Int)]

Map associating KType with UGen index.

ktype_map_lookup :: KType -> [(KType, Int)] -> Int

Lookup KType index from map (erroring variant of lookup).

mk_maps :: Graph -> Maps

Generate Maps translating node identifiers to synthdef indexes.

fetch :: NodeId -> Map -> Int

Locate index in map given node identifer NodeId.

fetch_k :: NodeId -> KType -> [Node] -> Int

Controls are a special case. We need to know not the overall index but the index in relation to controls of the same type.

Implicit (Control, MaxLocalBuf)

type KS_COUNT = (Int, Int, Int, Int)

4-tuple to count KTypes.

ks_count :: [Node] -> KS_COUNT

Count the number of controls of each KType.

mk_implicit_ctl :: [Node] -> [Node]

Construct implicit control unit generator Nodes. Unit generators are only constructed for instances of control types that are present.

add_implicit_ctl :: Graph -> Graph

Add implicit control UGens to Graph.

localbuf_count :: [Node] -> Int

Zero if no local buffers, or if maxLocalBufs is given.

add_implicit_buf :: Graph -> Graph

Add implicit maxLocalBufs if not present.

add_implicit :: Graph -> Graph

add_implicit_buf and add_implicit_ctl.

is_implicit_control :: Node -> Bool

Is Node an implicit control UGen?

is_implicit :: Node -> Bool

Is Node implicit?

remove_implicit :: Graph -> Graph

Remove implicit UGens from Graph

Queries

is_from_port_u :: FromPort -> Bool

Is FromPort FromPort_U.

multiple_u_out_edges :: [Edge] -> [FromPort]

List of FromPort_U at e with multiple out edges.

node_descendents :: Graph -> Node -> [Node]

Descendents at Graph of Node.

PV edge accounting

pv_multiple_out_edges :: Graph -> [Node]

List PV Nodes at Graph with multiple out edges.

pv_validate :: Graph -> Graph

Error if graph has invalid PV subgraph, ie. multiple out edges at PV node not connecting to Unpack1FFT & PackFFT.

ugen_to_graph :: UGen -> Graph

Transform a unit generator into a graph.

import Sound.SC3.UGen
ugen_to_graph (out 0 (pan2 (sinOsc AR 440 0) 0.5 0.1))