bindings-sc3-0.4.1: Low-level bindings to the SuperCollider synthesis engine library.

Safe HaskellSafe-Inferred

Bindings.Sound.SC3

Synopsis

Documentation

data C'World Source

Synthesis engine handle.

Constructors

C'World 

data C'WorldOptions Source

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

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

Default synthesis engine options.

data C'ReplyAddress Source

Reply address.

Constructors

C'ReplyAddress 

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

Access the callback data pointer in a reply address.

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

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

Reply function callback.

Arguments:

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

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

Create a new synthesis engine.

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

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

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

Free the synthesis engine.

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

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

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

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

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

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

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

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)Source

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

Open a TCP input port for receiving OSC commands.

Returns non-zero if the call was successful.

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

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

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

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

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

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 CUIntSource

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

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

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

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

Send an OSC packet to the synthesis engine.

Returns True if the packet was sent successfully.

Arguments:

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

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

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

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

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

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

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

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

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

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 CIntSource

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

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

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

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

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

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

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

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

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

Haskell print function.

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

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

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

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

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 CUIntSource

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

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

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

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

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

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

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

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

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

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

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