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)

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

Type argument for Jack input ports

Instances

Direction Input

data Output

Type argument for Jack output ports

Instances

Direction Output

data UnknownType

Type argument for Jack ports where the type of samples transported by the port is unknown.

data UnknownDirection

Type argument for Jack ports where we do not know whether it is an input or an output port.

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 arg = NFrames -> Ptr arg -> IO Errno

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

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

makeProcess :: Process arg -> IO (FunPtr (Process arg))

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

withProcess :: ThrowsErrno e => Client -> (NFrames -> ExceptionalT Errno IO ()) -> ExceptionalT e IO a -> ExceptionalT e IO a

The callback function must respond in real-time, i.e. in a bounded amout of time. That is, strictly spoken it must not wait for anything, e.g. it must not wait for locks and it must not allocate memory. In Haskell this is practically impossible because even simplest operations allocate memory. If the callback needs to much time, JACK will shut down your client. The best you can do is to hope that nothing evil happens.

getBufferSize :: Client -> IO Int

getSampleRate :: Client -> IO Int

lastFrameTime :: Client -> IO NFrames

makeClientRegistration :: ClientRegistration arg -> IO (FunPtr (ClientRegistration arg))

Create a client registration callback FunPtr.

setClientRegistration :: ThrowsErrno e => Client -> FunPtr (ClientRegistration arg) -> Ptr arg -> ExceptionalT e IO ()

Set the client registration callback.

withClientRegistration :: ThrowsErrno e => Client -> (String -> Bool -> IO ()) -> ExceptionalT e IO a -> ExceptionalT e IO a

data PortId

Instances

Eq PortId

Ord PortId

Show PortId

makePortRegistration :: PortRegistration arg -> IO (FunPtr (PortRegistration arg))

Create a port registration callback FunPtr.

setPortRegistration :: ThrowsErrno e => Client -> FunPtr (PortRegistration arg) -> Ptr arg -> ExceptionalT e IO ()

Set the port registration callback.

withPortRegistration :: ThrowsErrno e => Client -> (PortId -> Bool -> IO ()) -> ExceptionalT e IO a -> ExceptionalT e IO a

makePortConnect :: PortConnect arg -> IO (FunPtr (PortConnect arg))

Create a port connect callback FunPtr.

setPortConnect :: ThrowsErrno e => Client -> FunPtr (PortConnect arg) -> Ptr arg -> ExceptionalT e IO ()

Set the port connect callback.

withPortConnect :: ThrowsErrno e => Client -> (PortId -> PortId -> Bool -> IO ()) -> ExceptionalT e IO a -> ExceptionalT e IO a

portById :: Client -> PortId -> IO (Port UnknownType UnknownDirection)

portByName :: Client -> String -> IO (Port UnknownType UnknownDirection)

portName :: Port typ dir -> IO String

Return the full port name, including the client_name: prefix.

portShortName :: Port typ dir -> IO String

Return the short port name, not including the client_name: prefix.

portAliases :: Port typ dir -> IO [String]

Return the port aliases, including the client_name: prefixes.

This is especially useful for external midi devices, as the alias names are usually more descriptive than system:midi_capture_1.

getPorts

Arguments

:: Client

the Jack client

-> IO [String]

the names as a list of strings

Returns the names of all existing ports.

portGetAllConnections :: Client -> Port typ dir -> IO [String]

Return all the port names a given port is connected to.

This function must not be called from a JACK event callback.

narrowPort :: (PortType typ, Direction dir, ThrowsPortMismatch e) => Port UnknownType UnknownDirection -> ExceptionalT e IO (Port typ dir)

narrowPortType :: (PortType typ, ThrowsPortMismatch e) => Port UnknownType dir -> ExceptionalT e IO (Port typ dir)

narrowPortDirection :: (Direction dir, ThrowsPortMismatch e) => Port typ UnknownDirection -> ExceptionalT e IO (Port typ dir)

switchUnknownTypePort :: ThrowsPortMismatch e => Port UnknownType dir -> (Port CFloat dir -> ExceptionalT e IO a) -> (Port EventBuffer dir -> ExceptionalT e IO a) -> ExceptionalT e IO a

switchUnknownDirectionPort :: ThrowsPortMismatch e => Port typ UnknownDirection -> (Port typ Input -> ExceptionalT e IO a) -> (Port typ Output -> ExceptionalT e IO a) -> ExceptionalT e IO a

newtype NFrames

represents absolute frame time

Constructors

NFrames Word32

Instances

Eq NFrames

Ord NFrames

Show NFrames

Ix NFrames

Monoid NFrames

C NFrames

nframesIndices :: NFrames -> [NFrames]

nframesBounds :: NFrames -> (NFrames, NFrames)

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

Deprecated: Write your own function instead.

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

Deprecated: Write your own function instead.

waitForBreak :: IO ()

Exceptions

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