Sound.SC3.Server.Graphdef

Binary 'Graph Definition' as understood by scsynth. There are both encoders and decoders.

Type

type Name = ASCII

Names are ASCII strings (ie. ByteString.Char8)

type Control = (Name, Int)

Controls are a name and a ugen-index.

type Sample = Double

Constants are floating point.

type UGen_Index = Int

UGen indices are Int.

type Port_Index = Int

Port indices are Int.

constant_index :: UGen_Index

Index used to indicate constants at UGen inputs. Ie. if the ugen-index is this value (-1) it indicates a constant.

data Input

Inputs are a ugen-index and a port-index.

Constructors

Input UGen_Index Port_Index

Instances

Eq Input

Defined in Sound.SC3.Server.Graphdef

Methods

(==) :: Input -> Input -> Bool

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

Show Input

Defined in Sound.SC3.Server.Graphdef

Methods

showsPrec :: Int -> Input -> ShowS

show :: Input -> String

showList :: [Input] -> ShowS

type Rate = Int

Rates are encoded as integers (IR = 0, KR = 1, AR = 2, DR = 3).

type Output = Rate

Outputs each indicate a Rate.

type Special = Int

Secondary (special) index, used by operator UGens to select operation.

type UGen = (Name, Rate, [Input], [Output], Special)

Unit generator type.

ugen_name_str :: UGen -> String

UGen name.

ugen_name_op :: UGen -> String

UGen name, using operator name if appropriate.

ugen_rate :: UGen -> Rate

UGen Rate.

ugen_rate_enum :: UGen -> Rate

ugen_inputs :: UGen -> [Input]

UGen Inputs.

ugen_outputs :: UGen -> [Output]

UGen Outputs.

ugen_is_control :: UGen -> Bool

Predicate to examine UGen name and decide if it is a control.

input_is_control :: Graphdef -> Input -> Bool

Input is a UGen (ie. not a constant, indicated by a ugen-index of -1) and the UGen is a control.

data Graphdef

Graph definition type.

Constructors

Graphdef

Fields

• graphdef_name :: Name
• graphdef_constants :: [Sample]
• graphdef_controls :: [(Control, Sample)]
• graphdef_ugens :: [UGen]

Instances

Eq Graphdef

Defined in Sound.SC3.Server.Graphdef

Methods

(==) :: Graphdef -> Graphdef -> Bool

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

Show Graphdef

Defined in Sound.SC3.Server.Graphdef

Methods

showsPrec :: Int -> Graphdef -> ShowS

show :: Graphdef -> String

showList :: [Graphdef] -> ShowS

Audible Graphdef

Defined in Sound.SC3.Server.Transport.FD

Methods

play_id :: Transport t => Int -> t -> Graphdef -> IO ()

play :: Transport t => t -> Graphdef -> IO ()

Audible Graphdef

Defined in Sound.SC3.Server.Transport.Monad

Methods

play_at :: Transport m => Play_Opt -> Graphdef -> m ()

play :: Transport m => Graphdef -> m ()

graphdef_ugen :: Graphdef -> UGen_Index -> UGen

Lookup UGen by index.

graphdef_control :: Graphdef -> Int -> (Control, Sample)

Lookup Control and default value by index.

graphdef_constant_nid :: Graphdef -> Int -> Int

nid of constant.

graphdef_control_nid :: Graphdef -> Int -> Int

nid of control.

graphdef_ugen_nid :: Graphdef -> Int -> Int

nid of UGen.

BINARY GET (version 0|1 or 2)

get_pstr :: Get Name

Get a Name (Pascal string).

type GET_F m = (m Name, m Int, m Int, m Int, m Double)

Get functions for Graphdef types, (str_f,i8_f,i16_f,i32_f,f32_f)

binary_get_f :: GET_F Get

GET_F for binary .scsyndef files.

get_control :: Monad m => (GET_F m, m Int) -> m Control

Get a Control.

get_input :: Monad m => m Int -> m Input

Get an Input.

get_ugen :: Monad m => (GET_F m, m Int) -> m UGen

Get a UGen

get_graphdef :: Monad m => GET_F m -> m Graphdef

Get a Graphdef. Supports version 0|1 and version 2 files. Ignores variants.

READ

read_graphdef_file :: FilePath -> IO Graphdef

Read Graphdef from .scsyndef file.

dir = "/home/rohan/sw/rsc3-disassembler/scsyndef/"
pp nm = read_graphdef_file (dir ++ nm) >>= putStrLn . graphdef_stat
pp "simple.scsyndef"
pp "with-ctl.scsyndef"
pp "mce.scsyndef"
pp "mrg.scsyndef"

STAT

scsyndef_stat :: FilePath -> IO String

read_graphdef_file and run graphdef_stat.

Encode (version zero)

type ENCODE_F t = ([t] -> t, Name -> t, Int -> t, Int -> t, Int -> t, Double -> t, String -> t)

(join_f,str_f,i8_f,i16_f,i32_f,f32_f,com_f)

enc_bytestring :: ENCODE_F ByteString

ENCODE_F for ByteString

encode_pstr :: Name -> ByteString

Pascal (length prefixed) encoding of Name.

encode_input_f :: ENCODE_F t -> Input -> t

encode_input :: Input -> ByteString

Byte-encode Input.

encode_control_f :: ENCODE_F t -> Control -> t

encode_control :: Control -> ByteString

Byte-encode Control.

encode_ugen_f :: ENCODE_F t -> UGen -> t

encode_ugen :: UGen -> ByteString

Byte-encode UGen.

encode_sample :: Sample -> ByteString

Encode Sample as 32-bit IEEE float.

encode_graphdef_f :: ENCODE_F t -> Graphdef -> t

encode_graphdef :: Graphdef -> ByteString

Encode Graphdef.

scgf_i32 :: Num n => n

SCgf encoded as 32-bit unsigned integer.

Byte.decode_i32 (Byte.encode_ascii (Datum.ascii "SCgf"))

IO

graphdefWrite :: FilePath -> Graphdef -> IO ()

Write Graphdef to indicated file.

graphdefWrite_dir :: FilePath -> Graphdef -> IO ()

Write Graphdef to indicated directory. The filename is the graphdef_name with the appropriate extension (scsyndef).

Stat

graphdef_stat :: Graphdef -> String

Simple statistics printer for Graphdef.

Dump UGens

ugen_dump_ugen_str :: [Sample] -> [UGen] -> UGen_Index -> UGen -> String

Pretty print UGen in the manner of SynthDef>>dumpUGens.

graphdef_dump_ugens_str :: Graphdef -> [String]

Print graphdef in format equivalent to SynthDef>>dumpUGens in SuperCollider

graphdef_dump_ugens :: Graphdef -> IO ()

putStrLn of unlines of graphdef_dump_ugens_str

dir = "/home/rohan/sw/rsc3-disassembler/scsyndef/"
pp nm = read_graphdef_file (dir ++ nm) >>= graphdef_dump_ugens
pp "simple.scsyndef"
pp "with-ctl.scsyndef"
pp "mce.scsyndef"
pp "mrg.scsyndef"