Sound.SC3.UGen.Type

Basic types

data UGenId

Data type for internalised identifier at UGen.

Constructors

NoId

UId Int

Instances

Eq UGenId

Show UGenId

no_id :: UGenId

Alias of NoId, the UGenId used for deterministic UGens.

type Sample = Double

SC3 samples are 32-bit Float. hsc3 represents data as 64-bit Double. If UGen values are used more generally (ie. see hsc3-forth) Float may be too imprecise, ie. for representing time stamps.

data Constant

Constants.

Constant 3 == Constant 3
(Constant 3 > Constant 1) == True

Constructors

Constant

Fields

constantValue :: Sample

Instances

Eq Constant

Ord Constant

Show Constant

data C_Meta n

Control meta-data.

Constructors

C_Meta

Fields

ctl_min :: n

Minimum

ctl_max :: n

Maximum

ctl_warp :: String

(0,1) (min,max) transfer function.

ctl_step :: n

The step to increment & decrement by.

ctl_units :: String

Unit of measure (ie hz, ms etc.).

Instances

Eq n => Eq (C_Meta n)

Show n => Show (C_Meta n)

type C_Meta' n = (n, n, String, n, String)

5-tuple form of C_Meta data.

c_meta' :: (n -> m) -> C_Meta' n -> C_Meta m

Lift C_Meta' to C_Meta allowing type coercion.

data Control

Control inputs. It is an invariant that controls with equal names within a UGen graph must be equal in all other respects.

Constructors

Control

Fields

controlOperatingRate :: Rate

controlIndex :: Maybe Int

controlName :: String

controlDefault :: Sample

controlTriggered :: Bool

controlMeta :: Maybe (C_Meta Sample)

Instances

Eq Control

Show Control

data Label

Labels.

Constructors

Label

Fields

ugenLabel :: String

Instances

Eq Label

Show Label

type Output = Rate

Unit generator output descriptor.

newtype Special

Operating mode of unary and binary operators.

Constructors

Special Int

Instances

Eq Special

Show Special

data Primitive

UGen primitives.

Constructors

Primitive

Fields

ugenRate :: Rate

ugenName :: String

ugenInputs :: [UGen]

ugenOutputs :: [Output]

ugenSpecial :: Special

ugenId :: UGenId

Instances

Eq Primitive

Show Primitive

data Proxy

Proxy to multiple channel input.

Constructors

Proxy

Fields

proxySource :: Primitive

proxyIndex :: Int

Instances

Eq Proxy

Show Proxy

data MRG

Multiple root graph.

Constructors

MRG

Fields

mrgLeft :: UGen

mrgRight :: UGen

Instances

Eq MRG

Show MRG

data UGen

Union type of Unit Generator forms.

Constructors

Constant_U Constant

Control_U Control

Label_U Label

Primitive_U Primitive

Proxy_U Proxy

MCE_U (MCE UGen)

MRG_U MRG

Instances

Enum UGen

Unit generators are enumerable.

Eq UGen

Floating UGen

Unit generators are floating point.

Fractional UGen

Unit generators are fractional.

Integral UGen

Unit generators are integral.

Num UGen

Unit generators are numbers.

Ord UGen

Unit generators are orderable (when Constants).

(constant 2 > constant 1) == True

Real UGen

Unit generators are real.

RealFrac UGen

Show UGen

Bits UGen

UGens are bit patterns.

Random UGen

Unit generators are stochastic.

TernaryOp UGen

BinaryOp UGen

UnaryOp UGen

RealFracE UGen

OrdE UGen

EqE UGen

Audible UGen

Audible UGen

Parser

parse_constant :: String -> Maybe UGen

Accessors

un_constant :: UGen -> Maybe Constant

See into Constant_U.

u_constant :: UGen -> Maybe Sample

Value of Constant_U Constant.

Predicates

isConstant :: UGen -> Bool

Constant node predicate.

isSink :: UGen -> Bool

True if input is a sink UGen, ie. has no outputs.

un_proxy :: UGen -> Maybe Proxy

See into Proxy_U.

isProxy :: UGen -> Bool

Validators

checkInput :: UGen -> UGen

Ensure input UGen is valid, ie. not a sink.

Constructors

constant :: Real n => n -> UGen

Constant value node constructor.

int_to_ugen :: Int -> UGen

Type specialised constant.

float_to_ugen :: Float -> UGen

Type specialised constant.

double_to_ugen :: Double -> UGen

Type specialised constant.

mce :: [UGen] -> UGen

Multiple channel expansion node constructor.

mrg :: [UGen] -> UGen

Multiple root graph constructor.

proxy :: UGen -> Int -> UGen

Unit generator proxy node constructor.

MCE

mceProxies :: MCE UGen -> [UGen]

Type specified mce_elem.

isMCE :: UGen -> Bool

Multiple channel expansion node (MCE_U) predicate.

mceChannels :: UGen -> [UGen]

Output channels of UGen as a list.

mceDegree :: UGen -> Int

Number of channels to expand to.

mceExtend :: Int -> UGen -> [UGen]

Extend UGen to specified degree.

mceInputTransform :: [UGen] -> Maybe [[UGen]]

Apply MCE transform to a list of inputs.

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

Build a UGen after MCE transformation of inputs.

mce_is_direct_proxy :: MCE UGen -> Bool

True if MCE is an immediate proxy for a multiple-out Primitive.

rateOf :: UGen -> Rate

Determine the rate of a UGen.

proxify :: UGen -> UGen

Apply proxy transformation if required.

mkUGen :: Maybe ([Sample] -> Sample) -> [Rate] -> Either Rate [Int] -> String -> [UGen] -> Maybe UGen -> Int -> Special -> UGenId -> UGen

Construct proxied and multiple channel expanded UGen.

cf = constant function, rs = rate set, r = rate, nm = name, i = inputs, o = outputs.

Operators

mkOperator :: ([Sample] -> Sample) -> String -> [UGen] -> Int -> UGen

Operator UGen constructor.

mkUnaryOperator :: Unary -> (Sample -> Sample) -> UGen -> UGen

Unary math constructor with constant optimization.

mkBinaryOperator_optimize :: Binary -> (Sample -> Sample -> Sample) -> (Either Sample Sample -> Bool) -> UGen -> UGen -> UGen

Binary math constructor with constant optimization.

let o = sinOsc AR 440 0

o * 1 == o && 1 * o == o && o * 2 /= o
o + 0 == o && 0 + o == o && o + 1 /= o
o - 0 == o && 0 - o /= o
o / 1 == o && 1 / o /= o
o ** 1 == o && o ** 2 /= o

mkBinaryOperator :: Binary -> (Sample -> Sample -> Sample) -> UGen -> UGen -> UGen

Binary math constructor with constant optimization.

Numeric instances