Sound.SC3.Lang.Control.Event

An Event is a (Key,Value) map.

Documentation

type Key = String

The type of the key at an Event.

type Value = Double

The type of the value at an Event.

type Type = String

The type of an Event.

data Event

An Event has a Type, possibly an integer identifier, possibly an Instrument and a map of (Key,Value) pairs.

Constructors

Event

Fields

e_type :: Type

e_id :: Maybe Int

e_instrument :: Maybe Instrument

e_map :: Map Key Value

Instances

Eq Event

Show Event

Audible (P Event)

Audible (String, P Event)

Audible (Synthdef, P Event)

defaultEvent :: Event

The default empty event.

lookup_m :: Key -> Event -> Maybe Value

Lookup k in e.

 lookup_m "k" defaultEvent == Nothing

lookup_v :: Value -> Key -> Event -> Value

Variant of lookup_m with a default value v.

 lookup_v 1 "k" defaultEvent == 1

lookup_t :: t -> (Value -> t) -> Key -> Event -> t

Variant of lookup_v with a transformation function.

 lookup_t 1 negate "k" defaultEvent == 1
 lookup_t 1 negate "k" (insert "k" 1 defaultEvent) == -1

pitch :: Event -> Pitch Double

Lookup Pitch model parameters at e and construct a Pitch value.

duration :: Event -> Duration Double

Lookup Duration model parameters at an Event and construct a Duration value.

insert :: Key -> Value -> Event -> Event

Insert (k,v) into e.

 lookup_m "k" (insert "k" 1 defaultEvent) == Just 1

freq :: Event -> Double

The frequency of the pitch of e.

 freq (event [("degree",5)]) == 440
 freq (event [("midinote",69)]) == 440

db :: Event -> Value

Lookup db field of Event, the default value is -20db.

dbAmp' :: Floating a => a -> a

Function to convert from decibels to linear amplitude.

amp :: Event -> Value

The linear amplitude of the amplitude model at e.

 amp (event [("db",-20)]) == 0.1

fwd :: Event -> Double

The fwd value of the duration model at e.

 fwd (event [("dur",1),("stretch",2)]) == 2

sustain :: Event -> Double

The sustain value of the duration model at e.

 sustain (event [("dur",1),("legato",0.5)]) == 0.5

reserved :: [Key]

List of reserved keys for pitch, duration and amplitude models.

 ("degree" `elem` reserved) == True

parameters' :: (Key, Value) -> Maybe (Key, Value)

If Key is reserved then Nothing, else id.

parameters :: Event -> [(Key, Value)]

Extract non-reserved Keys from Event.

edit_v :: Key -> Value -> (Value -> Value) -> Event -> Event

Value editor for Key at Event, with default value in case Key is not present.

edit :: Key -> (Value -> Value) -> Event -> Event

Variant of edit_v with no default value.

from_list :: Type -> Maybe Int -> Maybe Instrument -> [(Key, Value)] -> Event

Basic Event constructor function with e_map given as a list.

event :: [(Key, Value)] -> Event

Construct an Event from a list of (key,value) pairs.

 lookup_m "k" (event [("k",1)]) == Just 1

instrument_name :: Event -> String

Extract Instrument name from Event, or default.

instrument_def :: Event -> Maybe Synthdef

Extract Instrument definition from Event if present.

f_merge :: Ord a => [(a, t)] -> [(a, t)] -> [(a, t)]

Merge two sorted sequence of (location,value) pairs.

 let m = f_merge (zip [0,2..6] ['a'..]) (zip [0,3,6] ['A'..])
 in m == [(0,'a'),(0,'A'),(2,'b'),(3,'B'),(4,'c'),(6,'d'),(6,'C')]

type Time = Double

Times are real valued UTC.

merge' :: (Time, [Event]) -> (Time, [Event]) -> [(Time, Event)]

Merge two time-stamped Event sequences. Note that this uses fwd to calculate start times.

add_fwd :: [(Time, Event)] -> [Event]

Insert fwd Keys into a time-stamped Event sequence.

merge :: (Time, [Event]) -> (Time, [Event]) -> [Event]

Composition of add_fwd and merge'.

to_sc3_osc :: Time -> Int -> Event -> Maybe (OSC, OSC)

Generate SC3 OSC messages describing Event. If the Event Type has a _p suffix, where p stands for persist, this does not generate a gate command.