Bindings.Sound.SC3

Documentation

data C'World

Synthesis engine handle.

Constructors

C'World

data C'WorldOptions

Synthesis engine options.

Constructors

C'WorldOptions

Fields

c'WorldOptions'mPassword :: CString

c'WorldOptions'mNumBuffers :: CUInt

c'WorldOptions'mMaxLogins :: CUInt

c'WorldOptions'mMaxNodes :: CUInt

c'WorldOptions'mMaxGraphDefs :: CUInt

c'WorldOptions'mMaxWireBufs :: CUInt

c'WorldOptions'mNumAudioBusChannels :: CUInt

c'WorldOptions'mNumInputBusChannels :: CUInt

c'WorldOptions'mNumOutputBusChannels :: CUInt

c'WorldOptions'mNumControlBusChannels :: CUInt

c'WorldOptions'mBufLength :: CUInt

c'WorldOptions'mRealTimeMemorySize :: CUInt

c'WorldOptions'mNumSharedControls :: CInt

c'WorldOptions'mSharedControls :: Ptr CFloat

c'WorldOptions'mRealTime :: CInt

c'WorldOptions'mMemoryLocking :: CInt

c'WorldOptions'mNonRealTimeCmdFilename :: CString

c'WorldOptions'mNonRealTimeInputFilename :: CString

c'WorldOptions'mNonRealTimeOutputFilename :: CString

c'WorldOptions'mNonRealTimeOutputHeaderFormat :: CString

c'WorldOptions'mNonRealTimeOutputSampleFormat :: CString

c'WorldOptions'mPreferredSampleRate :: CUInt

c'WorldOptions'mNumRGens :: CUInt

c'WorldOptions'mPreferredHardwareBufferFrameSize :: CUInt

c'WorldOptions'mLoadGraphDefs :: CUInt

c'WorldOptions'mInputStreamsEnabled :: CString

c'WorldOptions'mOutputStreamsEnabled :: CString

c'WorldOptions'mInDeviceName :: CString

c'WorldOptions'mVerbosity :: CInt

c'WorldOptions'mRendezvous :: CInt

c'WorldOptions'mUGensPluginPath :: CString

c'WorldOptions'mOutDeviceName :: CString

c'WorldOptions'mRestrictedPath :: CString

c'WorldOptions'mSharedMemoryID :: CInt

Instances

Eq C'WorldOptions

Show C'WorldOptions

Storable C'WorldOptions

c'kDefaultWorldOptions :: IO (Ptr C'WorldOptions)

Default synthesis engine options.

data C'ReplyAddress

Reply address.

Constructors

C'ReplyAddress

c'ReplyAddress_ReplyData :: Ptr C'ReplyAddress -> IO (Ptr ())

Access the callback data pointer in a reply address.

p'ReplyAddress_ReplyData :: FunPtr (Ptr C'ReplyAddress -> IO (Ptr ()))

type C'ReplyFunc = FunPtr (Ptr C'ReplyAddress -> Ptr CChar -> CInt -> IO ())

Reply function callback.

Arguments:

• Ptr C'ReplyAddress - Reply address handle
• Ptr CChar - OSC packet data
• CInt - OSC packet size in bytes

mk'ReplyFunc :: (Ptr C'ReplyAddress -> Ptr CChar -> CInt -> IO ()) -> IO C'ReplyFunc

c'World_New :: Ptr C'WorldOptions -> IO (Ptr C'World)

Create a new synthesis engine.

mK'ReplyFunc :: C'ReplyFunc -> Ptr C'ReplyAddress -> Ptr CChar -> CInt -> IO ()

p'World_New :: FunPtr (Ptr C'WorldOptions -> IO (Ptr C'World))

c'World_Cleanup :: Ptr C'World -> IO ()

Free the synthesis engine.

This function should only be called after c'World_WaitForQuit has returned.

p'World_Cleanup :: FunPtr (Ptr C'World -> IO ())

Perform non-realtime synthesis with the given C'WorldOptions.

c'World_NonRealTimeSynthesis :: Ptr C'World -> Ptr C'WorldOptions -> IO ()

p'World_NonRealTimeSynthesis :: FunPtr (Ptr C'World -> Ptr C'WorldOptions -> IO ())

c'World_OpenUDP :: Ptr C'World -> CInt -> IO CInt

p'WorldOptions'mPassword :: Ptr C'WorldOptions -> Ptr CString

Open a UDP input port for receiving OSC commands.

Returns non-zero if the call was successful.

p'World_OpenUDP :: FunPtr (Ptr C'World -> CInt -> IO CInt)

p'WorldOptions'mNumBuffers :: Ptr C'WorldOptions -> Ptr CUInt

Open a TCP input port for receiving OSC commands.

Returns non-zero if the call was successful.

p'WorldOptions'mMaxLogins :: Ptr C'WorldOptions -> Ptr CUInt

c'World_OpenTCP :: Ptr C'World -> CInt -> CInt -> CInt -> IO CInt

p'WorldOptions'mMaxNodes :: Ptr C'WorldOptions -> Ptr CUInt

p'World_OpenTCP :: FunPtr (Ptr C'World -> CInt -> CInt -> CInt -> IO CInt)

p'WorldOptions'mMaxGraphDefs :: Ptr C'WorldOptions -> Ptr CUInt

Wait for the synthesis engine to quit.

In order to stop the synthesis engine, send a "/quit" OSC message with c'World_SendPacket, c'World_SendPacketWithContext or through an open network port.

p'WorldOptions'mMaxWireBufs :: Ptr C'WorldOptions -> Ptr CUInt

c'World_WaitForQuit :: Ptr C'World -> IO ()

p'WorldOptions'mNumAudioBusChannels :: Ptr C'WorldOptions -> Ptr CUInt

p'World_WaitForQuit :: FunPtr (Ptr C'World -> IO ())

p'WorldOptions'mNumInputBusChannels :: Ptr C'WorldOptions -> Ptr CUInt

Send an OSC packet to the synthesis engine.

Returns True if the packet was sent successfully.

Arguments:

• CInt - OSC packet size in bytes
• Ptr CChar - OSC packet data
• C'ReplyFunc - Reply function callback.

p'WorldOptions'mNumOutputBusChannels :: Ptr C'WorldOptions -> Ptr CUInt

p'WorldOptions'mNumControlBusChannels :: Ptr C'WorldOptions -> Ptr CUInt

p'WorldOptions'mBufLength :: Ptr C'WorldOptions -> Ptr CUInt

p'WorldOptions'mRealTimeMemorySize :: Ptr C'WorldOptions -> Ptr CUInt

p'WorldOptions'mNumSharedControls :: Ptr C'WorldOptions -> Ptr CInt

c'World_SendPacket :: Ptr C'World -> CInt -> Ptr CChar -> C'ReplyFunc -> IO Bool

p'WorldOptions'mSharedControls :: Ptr C'WorldOptions -> Ptr (Ptr CFloat)

p'World_SendPacket :: FunPtr (Ptr C'World -> CInt -> Ptr CChar -> C'ReplyFunc -> IO Bool)

p'WorldOptions'mRealTime :: Ptr C'WorldOptions -> Ptr CInt

Send an OSC packet to the synthesis engine with callback data.

Returns True if the packet was sent successfully.

Arguments:

• CInt - OSC packet size in bytes
• Ptr CChar - OSC packet data
• C'ReplyFunc - Reply function callback.
• Ptr () - Reply function callback data.

p'WorldOptions'mMemoryLocking :: Ptr C'WorldOptions -> Ptr CInt

p'WorldOptions'mNonRealTimeCmdFilename :: Ptr C'WorldOptions -> Ptr CString

p'WorldOptions'mNonRealTimeInputFilename :: Ptr C'WorldOptions -> Ptr CString

p'WorldOptions'mNonRealTimeOutputFilename :: Ptr C'WorldOptions -> Ptr CString

p'WorldOptions'mNonRealTimeOutputHeaderFormat :: Ptr C'WorldOptions -> Ptr CString

c'World_SendPacketWithContext :: Ptr C'World -> CInt -> Ptr CChar -> C'ReplyFunc -> Ptr () -> IO Bool

p'WorldOptions'mNonRealTimeOutputSampleFormat :: Ptr C'WorldOptions -> Ptr CString

p'World_SendPacketWithContext :: FunPtr (Ptr C'World -> CInt -> Ptr CChar -> C'ReplyFunc -> Ptr () -> IO Bool)

type C'HaskellPrintFunc = FunPtr (Ptr CChar -> IO ())

p'WorldOptions'mPreferredSampleRate :: Ptr C'WorldOptions -> Ptr CUInt

Haskell print function.

mk'HaskellPrintFunc :: (Ptr CChar -> IO ()) -> IO C'HaskellPrintFunc

p'WorldOptions'mNumRGens :: Ptr C'WorldOptions -> Ptr CUInt

mK'HaskellPrintFunc :: C'HaskellPrintFunc -> Ptr CChar -> IO ()

p'WorldOptions'mPreferredHardwareBufferFrameSize :: Ptr C'WorldOptions -> Ptr CUInt

Set the global Haskell print function.

This function, when set, is called by the synthesis engine to print character strings to an appropriate output channel.

p'WorldOptions'mLoadGraphDefs :: Ptr C'WorldOptions -> Ptr CUInt

c'SetHaskellPrintFunc :: C'HaskellPrintFunc -> IO ()

p'WorldOptions'mInputStreamsEnabled :: Ptr C'WorldOptions -> Ptr CString

p'SetHaskellPrintFunc :: FunPtr (C'HaskellPrintFunc -> IO ())

p'WorldOptions'mOutputStreamsEnabled :: Ptr C'WorldOptions -> Ptr CString

p'WorldOptions'mInDeviceName :: Ptr C'WorldOptions -> Ptr CString

p'WorldOptions'mVerbosity :: Ptr C'WorldOptions -> Ptr CInt

p'WorldOptions'mRendezvous :: Ptr C'WorldOptions -> Ptr CInt

p'WorldOptions'mUGensPluginPath :: Ptr C'WorldOptions -> Ptr CString

p'WorldOptions'mOutDeviceName :: Ptr C'WorldOptions -> Ptr CString

p'WorldOptions'mRestrictedPath :: Ptr C'WorldOptions -> Ptr CString

p'WorldOptions'mSharedMemoryID :: Ptr C'WorldOptions -> Ptr CInt