Sound.SC3.Server.State.Monad.Command

Requests

data Request m a

Server-side action (or sequence of actions).

Instances

Monad m => Monad (Request m)

Functor m => Functor (Request m)

(Monad m, Functor m) => Applicative (Request m)

Monad m => SendOSC (Request m)

Bundles are flattened into the resulting bundle because scsynth doesn't support nested bundles.

MonadIdAllocator m => MonadIdAllocator (Request m)

MonadServer m => MonadServer (Request m)

exec :: (MonadIdAllocator m, RequestOSC m) => Time -> Request m a -> m a

Execute a request.

The commands after the last asynchronous command will be scheduled at the given time.

exec_ :: (MonadIdAllocator m, RequestOSC m) => Request m a -> m a

Execute a request immediately.

data Result a

Representation of a deferred server resource.

Resource resource values can only be observed with extract after the surrounding Request action has been executed with exec.

Instances

Monad Result

Functor Result

Applicative Result

extract :: MonadIO m => Result a -> m a

Extract a 'Result'\'s value.

Master controls

status :: MonadIO m => Request m (Result Status)

Request server status.

statusM :: (MonadIdAllocator m, RequestOSC m, MonadIO m) => m Status

Request server status.

data PrintLevel

Enumeration of Message printer types.

Constructors

NoPrinter

TextPrinter

HexPrinter

AllPrinter

Instances

Enum PrintLevel

Eq PrintLevel

Show PrintLevel

dumpOSC :: MonadIdAllocator m => PrintLevel -> Request m ()

Select printing of incoming Open Sound Control messages.

clearSched :: Monad m => Request m ()

Remove all bundles from the scheduling queue.

data ErrorScope

Error posting scope.

Constructors

Globally

Global scope

Locally

Bundle scope

Instances

Enum ErrorScope

Eq ErrorScope

Show ErrorScope

data ErrorMode

Error posting mode.

Constructors

ErrorsOff

Turn error posting off

ErrorsOn

Turn error posting on

Instances

Enum ErrorMode

Eq ErrorMode

Show ErrorMode

errorMode :: Monad m => ErrorScope -> ErrorMode -> Request m ()

Set error posting scope and mode.

Synth definitions

data SynthDef

Instances

Eq SynthDef

Show SynthDef

d_named :: String -> SynthDef

Construct a synth definition from a name.

d_default :: SynthDef

The default synth definition.

d_recv :: Monad m => String -> UGen -> Request m SynthDef

Compute a unique name for a UGen graph. graphName :: UGen -> String graphName = SHA.showBSasHex . SHA.hash SHA.SHA256 . BZip.compress . Synthdef.graphdef . Synthdef.synth

Create a new synth definition. d_new :: Monad m => String -> UGen -> Async m SynthDef d_new prefix ugen | length prefix < 127 = mkAsync $ return (sd, f) | otherwise = error d_new: name prefix too long, resulting string exceeds 255 characters where sd = SynthDef (prefix ++ - ++ graphName ugen) f osc = (mkC C.d_recv C.d_recv' osc) (Synthdef.synthdef (name sd) ugen)

Create a synth definition from a name and a UGen graph.

d_load :: Monad m => FilePath -> Request m ()

Load a synth definition from a named file. (Asynchronous)

d_loadDir :: Monad m => FilePath -> Request m ()

Load a directory of synth definition files. (Asynchronous)

d_free :: Monad m => SynthDef -> Request m ()

Remove definition once all nodes using it have ended.

Resources

Nodes

class Node a where

Methods

nodeId :: a -> NodeId

Instances

Node Group

Node Synth

Node AbstractNode

data AddAction

Enumeration of possible locations to add new nodes (s_new and g_new).

Constructors

AddToHead

AddToTail

AddBefore

AddAfter

AddReplace

Instances

Enum AddAction

Eq AddAction

Show AddAction

data AbstractNode

Instances

Eq AbstractNode

Show AbstractNode

Node AbstractNode

node :: (Eq n, Node n, Show n) => n -> AbstractNode

Construct an abstract node wrapper.

n_after :: (Node a, Node b, Monad m) => a -> b -> Request m ()

Place node a after node b.

n_before :: (Node a, Node b, Monad m) => a -> b -> Request m ()

Place node a before node b.

n_fill :: (Node a, Monad m) => a -> [(String, Int, Double)] -> Request m ()

Fill ranges of a node's control values.

n_free :: (Node a, MonadIdAllocator m) => a -> Request m ()

Delete a node.

class BusMapping n b where

Mapping node controls to buses.

Methods

n_map :: (Node n, Bus b, Monad m) => n -> String -> b -> Request m ()

Map a node's controls to read from a control bus.

n_unmap :: (Node n, Bus b, Monad m) => n -> String -> b -> Request m ()

Remove a control's mapping to a control bus.

Instances

BusMapping n AudioBus

BusMapping n ControlBus

n_query_ :: (Node a, Monad m) => a -> Request m ()

Query a node.

n_query :: (Node a, MonadIO m) => a -> Request m (Result NodeNotification)

Query a node.

n_queryM :: (Node a, MonadIdAllocator m, RequestOSC m, MonadIO m) => a -> m NodeNotification

Query a node.

n_run_ :: (Node a, Monad m) => a -> Bool -> Request m ()

Turn node on or off.

n_set :: (Node a, Monad m) => a -> [(String, Double)] -> Request m ()

Set a node's control values.

n_setn :: (Node a, Monad m) => a -> [(String, [Double])] -> Request m ()

Set ranges of a node's control values.

n_trace :: (Node a, Monad m) => a -> Request m ()

Trace a node.

n_order :: (Node n, Monad m) => AddAction -> n -> [AbstractNode] -> Request m ()

Move an ordered sequence of nodes.

Synths

newtype Synth

Constructors

Synth NodeId

Instances

Eq Synth

Ord Synth

Show Synth

Node Synth

s_new :: MonadIdAllocator m => SynthDef -> AddAction -> Group -> [(String, Double)] -> Request m Synth

Create a new synth.

s_new_ :: (MonadServer m, MonadIdAllocator m) => SynthDef -> AddAction -> [(String, Double)] -> Request m Synth

Create a new synth in the root group.

s_release :: MonadIdAllocator m => Double -> Synth -> Request m ()

Release a synth with a gate envelope control.

s_get :: MonadIO m => Synth -> [String] -> Request m (Result [(Either Int32 String, Float)])

Get control values.

s_getn :: MonadIO m => Synth -> [(String, Int)] -> Request m (Result [(Either Int32 String, [Float])])

Get ranges of control values.

s_noid :: MonadIdAllocator m => Synth -> Request m ()

Free a synth's ID and auto-reassign it to a reserved value (the node is not freed!).

Groups

newtype Group

Constructors

Group NodeId

Instances

Eq Group

Ord Group

Show Group

Node Group

rootNode :: MonadServer m => m Group

Return the server's root group.

g_new :: MonadIdAllocator m => AddAction -> Group -> Request m Group

Create a new group.

g_new_ :: (MonadServer m, MonadIdAllocator m) => AddAction -> Request m Group

Create a new group in the top level group.

g_deepFree :: Monad m => Group -> Request m ()

Free all synths in this group and all its sub-groups.

g_freeAll :: Monad m => Group -> Request m ()

Delete all nodes in a group.

g_head :: (Node n, Monad m) => Group -> n -> Request m ()

Add node to head of group.

g_tail :: (Node n, Monad m) => Group -> n -> Request m ()

Add node to tail of group.

g_dumpTree :: Monad m => [(Group, Bool)] -> Request m ()

Post a representation of a group's node subtree, optionally including the current control values for synths.

Plugin Commands

cmd :: Monad m => String -> [Datum] -> Request m ()

Send a plugin command.

Unit Generator Commands

u_cmd :: Monad m => AbstractNode -> Int -> String -> [Datum] -> Request m ()

Send a command to a unit generator.

Buffers

data Buffer

Instances

Eq Buffer

Ord Buffer

Show Buffer

bufferId :: Buffer -> BufferId

b_alloc :: MonadIdAllocator m => Int -> Int -> Request m Buffer

Allocates zero filled buffer to number of channels and samples. (Asynchronous)

b_allocRead :: MonadIdAllocator m => FilePath -> Maybe Int -> Maybe Int -> Request m Buffer

Allocate buffer space and read a sound file. (Asynchronous)

b_allocReadChannel :: MonadIdAllocator m => FilePath -> Maybe Int -> Maybe Int -> [Int] -> Request m Buffer

Allocate buffer space and read a sound file, picking specific channels. (Asynchronous)

b_read :: Monad m => Buffer -> FilePath -> Maybe Int -> Maybe Int -> Maybe Int -> Bool -> Request m ()

Read sound file data into an existing buffer. (Asynchronous)

b_readChannel :: MonadIO m => Buffer -> FilePath -> Maybe Int -> Maybe Int -> Maybe Int -> Bool -> [Int] -> Request m ()

Read sound file data into an existing buffer, picking specific channels. (Asynchronous)

data SoundFileFormat

Sound file format.

Constructors

Aiff

Flac

Ircam

Next

Raw

Wave

Instances

Enum SoundFileFormat

Eq SoundFileFormat

Read SoundFileFormat

Show SoundFileFormat

data SampleFormat

Sample format.

Constructors

PcmInt8

PcmInt16

PcmInt24

PcmInt32

PcmFloat

PcmDouble

PcmMulaw

PcmAlaw

Instances

Enum SampleFormat

Eq SampleFormat

Read SampleFormat

Show SampleFormat

b_write :: MonadIO m => Buffer -> FilePath -> SoundFileFormat -> SampleFormat -> Maybe Int -> Maybe Int -> Bool -> Request m ()

Write sound file data. (Asynchronous)

b_free :: MonadIdAllocator m => Buffer -> Request m ()

Free buffer. (Asynchronous)

b_zero :: MonadIO m => Buffer -> Request m ()

Zero sample data. (Asynchronous)

b_set :: Monad m => Buffer -> [(Int, Double)] -> Request m ()

Set sample values.

b_setn :: Monad m => Buffer -> [(Int, [Double])] -> Request m ()

Set ranges of sample values.

b_fill :: Monad m => Buffer -> [(Int, Int, Double)] -> Request m ()

Fill ranges of sample values.

b_gen :: MonadIdAllocator m => Buffer -> String -> [Datum] -> Request m ()

Call a command to fill a buffer. (Asynchronous)

b_gen_sine1 :: MonadIdAllocator m => Buffer -> [B_Gen] -> [Double] -> Request m ()

Fill a buffer with partials, specifying amplitudes.

b_gen_sine2 :: MonadIdAllocator m => Buffer -> [B_Gen] -> [(Double, Double)] -> Request m ()

Fill a buffer with partials, specifying frequencies (in cycles per buffer) and amplitudes.

b_gen_sine3 :: MonadIdAllocator m => Buffer -> [B_Gen] -> [(Double, Double, Double)] -> Request m ()

Fill a buffer with partials, specifying frequencies (in cycles per buffer), amplitudes and phases.

b_gen_cheby :: MonadIdAllocator m => Buffer -> [B_Gen] -> [Double] -> Request m ()

Fills a buffer with a series of chebyshev polynomials.

b_gen_copy :: MonadIdAllocator m => Buffer -> Int -> Buffer -> Int -> Maybe Int -> Request m ()

Copy samples from the source buffer to the destination buffer.

b_close :: Monad m => Buffer -> Request m ()

Close attached soundfile and write header information. (Asynchronous)

b_query :: MonadIO m => Buffer -> Request m (Result BufferInfo)

Request BufferInfo.

b_queryM :: (MonadIdAllocator m, RequestOSC m, MonadIO m) => Buffer -> m BufferInfo

Request BufferInfo.

Buses

class Bus a where

Abstract interface for control and audio rate buses.

Methods

rate :: a -> Rate

Rate of computation.

numChannels :: a -> Int

Number of channels.

freeBus :: (MonadServer m, MonadIdAllocator m) => a -> m ()

Free bus.

Instances

Bus ControlBus

Bus AudioBus

data AudioBus

Audio bus.

Instances

Eq AudioBus

Show AudioBus

Bus AudioBus

BusMapping n AudioBus

audioBusId :: AudioBus -> AudioBusId

Get audio bus id.

inputBus :: (MonadServer m, Failure AllocFailure m) => Int -> Int -> m AudioBus

Get hardware input bus.

outputBus :: (MonadServer m, Failure AllocFailure m) => Int -> Int -> m AudioBus

Get hardware output bus.

newAudioBus :: MonadIdAllocator m => Int -> m AudioBus

Allocate audio bus with the specified number of channels.

data ControlBus

Control bus.

Instances

Eq ControlBus

Show ControlBus

Bus ControlBus

BusMapping n ControlBus

controlBusId :: ControlBus -> ControlBusId

Get control bus ID.

newControlBus :: MonadIdAllocator m => Int -> m ControlBus

Allocate control bus with the specified number of channels.

Control Bus Commands