Sound.JACK

The Jack module defines types and functions that allows you to use the JACK Audio Connection Kit.

general stuff

data Client

Handles of Jack clients

newClient

Arguments

:: ThrowsStatus e

=> String

name of the JACK server

-> String

name of the client

-> ExceptionalT e IO Client

Constructs a new Jack client.

newClientDefault

Arguments

:: ThrowsStatus e

=> String

name of the client

-> ExceptionalT e IO Client

Creates a new JACK client with the default server

disposeClient :: ThrowsErrno e => Client -> ExceptionalT e IO ()

withClient

Arguments

:: ThrowsStatus e

=> String

name of the JACK server

-> String

name of the client

-> (Client -> ExceptionalT e IO a)

-> ExceptionalT e IO a

Run a block of code with a newly allocated client. Do not use the client outside the block.

withClientDefault

Arguments

:: ThrowsStatus e

=> String

name of the client

-> (Client -> ExceptionalT e IO a)

-> ExceptionalT e IO a

clientClose :: ThrowsErrno e => Client -> PortSet -> ExceptionalT e IO ()

closes the given Jack client without causing any trouble (hopefully)

getPorts

Arguments

:: Client

the Jack client

-> IO [String]

the names as a list of strings

returns the names of all existing ports of the given Jack client

activate :: ThrowsErrno e => Client -> ExceptionalT e IO ()

activates the given Jack client

deactivate :: ThrowsErrno e => Client -> ExceptionalT e IO ()

withActivation :: ThrowsErrno e => Client -> ExceptionalT e IO () -> ExceptionalT e IO ()

class PortType typ

Jack Port Type

Instances

PortType CFloat

PortType EventBuffer

class Direction dir

Instances

Direction Output

Direction Input

data Input

Handles of Jack input ports

Instances

Direction Input

data Output

Handles of Jack output ports

Instances

Direction Output

data Port typ dir

newPort

Arguments

:: (PortType typ, Direction dir, ThrowsPortRegister e)

=> Client

Jack client

-> String

name of the input port

-> ExceptionalT e IO (Port typ dir)

Better use withPort that also handles freeing the port.

disposePort :: (PortType typ, Direction dir, ThrowsErrno e) => Client -> Port typ dir -> ExceptionalT e IO ()

withPort

Arguments

:: (PortType typ, Direction dir, ThrowsPortRegister e, ThrowsErrno e)

=> Client

Jack client

-> String

name of the input port

-> (Port typ dir -> ExceptionalT e IO a)

-> ExceptionalT e IO a

Creates a new port for the given client and delete it after usage. The port manages audio or MIDI data in input or output direction depending on the Port type. Usually the required port type can be inferred from following actions that use that port.

Do not use the port outside the enclosed block.

data PortSet

A collection of mixed types of ports. It is mainly needed for freeing all allocated ports.

Instances

Monoid PortSet

setOfPort :: (PortType typ, Direction dir) => Port typ dir -> PortSet

setOfPorts :: (PortType typ, Direction dir) => [Port typ dir] -> PortSet

type Process = NFrames -> Ptr CallbackArg -> IO Errno

connect :: ThrowsErrno e => Client -> String -> String -> ExceptionalT e IO ()

mkProcess :: Process -> IO (FunPtr Process)

setProcess :: ThrowsErrno e => Client -> FunPtr Process -> ExceptionalT e IO ()

data CallbackArg

getSampleRate :: Client -> IO Int

newtype NFrames

represents absolute frame time

Constructors

NFrames CUInt

Instances

Eq NFrames

Ord NFrames

Show NFrames

Ix NFrames

Monoid NFrames

nframesIndices :: NFrames -> [NFrames]

nframesBounds :: NFrames -> (NFrames, NFrames)

quit :: MVar () -> Client -> PortSet -> IO ()

waitForBreakAndClose :: Client -> PortSet -> IO ()

waitForBreak :: IO ()

Exceptions

handleExceptions :: ExceptionalT All IO () -> IO ()