Sound.Jack.Bindings

Low level bindings to the JACK <jack.h> functionality

This is a faithfull representation of the C api. For now please refer to the JACK api documentation for a complete description of the functionality

http://jackaudio.org/files/docs/html/jack_8h.html

A somewhat safer interface can be found at Sound.Jack.JackMonad

Documentation

withOpenClient

Arguments

:: String

server name

-> [Options]

client options

-> String

client name

-> (Client -> [Status] -> IO a)

action to be run with the open client

-> ([Status] -> IO a)

action to be run on error

-> IO a

Open a Jack client and run the supplied action, handling errors and closing the client

withOpenClientDefaultServer

Arguments

:: [Options]

client options

-> String

The client name

-> (Client -> [Status] -> IO a)

action to be run with the open client

-> ([Status] -> IO a)

action to be run at error

-> IO a

Open a Jack client on the default server and run the supplied action, handling errors and closing the client

clientOpenWithDefaultServer :: String -> [Options] -> IO (Client, [Status])

open an external client with the defailt server

clientOpenWithServerName :: String -> [Options] -> String -> IO (Client, [Status])

open an external client with the specified server

clientClose :: Client -> IO ()

clientNameSize :: IO Int

getClientName :: Client -> IO String

internalClientNew :: String -> String -> String -> IO Int

DEPRECATED. Use internalClientOpen

internalClientClose :: String -> IO ()

DEPRECATED. use internalClientLoad

activate :: Client -> IO Int

deactivate :: Client -> IO Int

clientThreadId :: Client -> IO PThread

isRealtime :: Client -> IO Bool

cycleWait :: Client -> IO Word32

cycleSignal :: Client -> Int -> IO ()

setProcessThread :: Client -> ThreadCallback -> Ptr () -> IO Int

setThreadInitCallback :: Client -> ThreadInitCallback -> Ptr () -> IO Int

setProcessCallback :: Client -> ProcessCallback -> Ptr () -> IO Int

setFreewheelCallback :: Client -> FreewheelCallback -> Ptr () -> IO Int

setBufferSizeCallback :: Client -> BufferSizeCallback -> Ptr () -> IO Int

setSampleRateCallback :: Client -> SampleRateCallback -> Ptr () -> IO Int

setClientRegistrationCallback :: Client -> ClientRegistrationCallback -> Ptr () -> IO Int

setPortRegistrationCallback :: Client -> PortRegistrationCallback -> Ptr () -> IO Int

setPortConnectCallback :: Client -> PortConnectCallback -> Ptr () -> IO Int

setGraphOrderCallback :: Client -> GraphOrderCallback -> Ptr () -> IO Int

setXrunCallback :: Client -> XRunCallback -> Ptr () -> IO Int

setFreewheel :: Client -> Bool -> IO Int

setBufferSize :: Client -> Word32 -> IO Int

getSampleRate :: Client -> IO CUInt

getBufferSize :: Client -> IO Word32

engineTakeoverTimebase :: Client -> IO Int

cpuLoad :: Client -> IO Float

portRegister :: Client -> String -> String -> [PortFlags] -> Int -> IO Port

portUnregister :: Client -> Port -> IO Int

portGetBuffer :: Port -> Word32 -> IO (Ptr AudioSample)

portName :: Port -> IO String

portShortName :: Port -> IO String

portFlags :: Port -> IO [PortFlags]

portType :: Port -> IO String

portIsMine :: Client -> Port -> IO Bool

portConnected :: Port -> IO Int

portGetConnections :: Port -> IO [String]

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

jackPortGetLatency :: Port -> IO Word32

jackPortGetTotalLatency :: Client -> Port -> IO Word32

portSetLatency :: Port -> Word32 -> IO ()

recomputeTotalLatencies :: Client -> IO Int

portSetName :: Port -> String -> IO Int

portSetAlias :: Port -> String -> IO Int

portUnsetAlias :: Port -> String -> IO Int

portRequestMonitor :: Port -> Bool -> IO Int

portRequestMonitorByName :: Client -> String -> Bool -> IO Int

portEnsureMonitor :: Port -> Bool -> IO Int

portMonitoringInput :: Port -> IO Int

connect :: Client -> String -> String -> IO Int

disconnect :: Client -> String -> String -> IO Int

portDisconnect :: Client -> Port -> IO Int

portNameSize :: IO Int

portTypeSize :: IO Int

getPorts :: Client -> String -> String -> [PortFlags] -> IO [String]

portByName :: Client -> String -> IO Port

portById :: Client -> PortID -> IO Port

framesSinceCycleStart :: Client -> IO Word32

frameTime :: Client -> IO Word32

framesToTime :: Client -> Word32 -> IO Time

timeToFrames :: Client -> Time -> IO Word32

getTime :: IO Time

data Port

Opaque.

data PortFlags

Constructors

PortIsInput

PortIsOutput

PortIsPhysical

PortCanMonitor

PortIsTerminal

Instances

Enum PortFlags

Eq PortFlags

Read PortFlags

Show PortFlags

type AudioSample = CFloat

type BufferSizeCallback = CUInt -> Ptr () -> IO CInt

type ClientRegistrationCallback = Ptr CChar -> CInt -> Ptr () -> IO ()

type FreewheelCallback = CInt -> Ptr () -> IO ()

type GraphOrderCallback = Ptr () -> IO CInt

type PortConnectCallback = CUInt -> CUInt -> CInt -> Ptr () -> IO ()

type PortRegistrationCallback = CUInt -> CInt -> Ptr () -> IO ()

type ProcessCallback

Arguments

 = CUInt

Number of Frames to Process

-> Ptr ()

User Data

-> IO CInt

type SampleRateCallback = CUInt -> Ptr () -> IO CInt

type ThreadCallback = Ptr () -> IO (Ptr ())

type ThreadInitCallback = Ptr () -> IO ()

type XRunCallback = Ptr () -> IO CInt

data Options

Constructors

NullOption

NoStartServer

UseExactName

ServerName

LoadName

LoadInit

Instances

Enum Options

Eq Options

Read Options

Show Options

data Client

Opaque.

data Status

Constructors

Failure

InvalidOption

NameNotUnique

ServerStarted

ServerFailed

ServerError

NoSuchClient

LoadFailure

InitFailure

ShmFailure

VersionError

BackendError

ClientZombie

Instances

Enum Status

Eq Status

Read Status

Show Status

data PortID

Opaque.

defaultAudioType :: String

defaultMidiType :: String

fromPThread :: PThread -> CULong

type NFrames = CUInt

data PThread

type Time = CULLong