Safe Haskell	None
Language	Haskell98

Sound.PortMidi

Contents

Data Types
Constants
PortMidi functions
Time function

Description

Interface to PortMidi

Synopsis

data PMError
- = HostError
- | InvalidDeviceId
- | InsufficientMemory
- | BufferTooSmall
- | BufferOverflow
- | BadPtr
- | BadData
- | InternalError
- | BufferMaxSize
data PMSuccess
- = NoError'NoData
- | GotData
newtype PMEventCount = PMEventCount CInt
type PMStream = ForeignPtr PortMidiStream
data DeviceInfo = DeviceInfo {
- interface :: String
- name :: String
- input :: Bool
- output :: Bool
- opened :: Bool
}
type DeviceID = Int
data PMMsg = PMMsg {
- status :: !CLong
- data1 :: !CLong
- data2 :: !CLong
}
data PMEvent = PMEvent {
- message :: !CLong
- timestamp :: !Timestamp
}
filterActive :: CLong
filterSysex :: CLong
filterClock :: CLong
filterPlay :: CLong
filterTick :: CLong
filterFD :: CLong
filterUndefined :: CLong
filterReset :: CLong
filterRealtime :: CLong
filterNote :: CLong
filterChannelAftertouch :: CLong
filterPolyAftertouch :: CLong
filterAftertouch :: CLong
filterProgram :: CLong
filterControl :: CLong
filterPitchBend :: CLong
filterMTC :: CLong
filterSongPosition :: CLong
filterSongSelect :: CLong
filterTune :: CLong
filterSystemCommon :: CLong
initialize :: IO (Either PMError PMSuccess)
terminate :: IO (Either PMError PMSuccess)
hasHostError :: PMStream -> IO Bool
getErrorText :: PMError -> IO String
getSuccessText :: PMSuccess -> IO String
getText :: Either PMError PMSuccess -> IO String
countDevices :: IO DeviceID
getDefaultInputDeviceID :: IO (Maybe DeviceID)
getDefaultOutputDeviceID :: IO (Maybe DeviceID)
getDeviceInfo :: DeviceID -> IO DeviceInfo
openInput :: DeviceID -> IO (Either PMError PMStream)
openOutput :: DeviceID -> Int -> IO (Either PMError PMStream)
setFilter :: PMStream -> CLong -> IO (Either PMError PMSuccess)
channel :: Int -> CLong
setChannelMask :: PMStream -> CLong -> IO (Either PMError PMSuccess)
abort :: PMStream -> IO (Either PMError PMSuccess)
close :: PMStream -> IO (Either PMError PMSuccess)
poll :: PMStream -> IO (Either PMError PMSuccess)
readEvents :: PMStream -> IO (Either PMError [PMEvent])
readEventsToBuffer :: PMStream -> Ptr PMEvent -> CLong -> IO (Either PMError PMEventCount)
writeEvents :: PMStream -> [PMEvent] -> IO (Either PMError PMSuccess)
writeShort :: PMStream -> PMEvent -> IO (Either PMError PMSuccess)
writeSysEx :: PMStream -> Timestamp -> String -> IO (Either PMError PMSuccess)
time :: IO Timestamp
encodeMsg :: PMMsg -> CLong
decodeMsg :: CLong -> PMMsg

Data Types

data PMError Source #

Represents real errors of the C enum PmError

Constructors

HostError
InvalidDeviceId
InsufficientMemory
BufferTooSmall
BufferOverflow
BadPtr
BadData
InternalError
BufferMaxSize

Instances

Enum PMError Source #
Instance details Defined in Sound.PortMidi Methods succ :: PMError -> PMError # pred :: PMError -> PMError # toEnum :: Int -> PMError # fromEnum :: PMError -> Int # enumFrom :: PMError -> [PMError] # enumFromThen :: PMError -> PMError -> [PMError] # enumFromTo :: PMError -> PMError -> [PMError] # enumFromThenTo :: PMError -> PMError -> PMError -> [PMError] #
Eq PMError Source #
Instance details Defined in Sound.PortMidi Methods (==) :: PMError -> PMError -> Bool # (/=) :: PMError -> PMError -> Bool #
Show PMError Source #
Instance details Defined in Sound.PortMidi Methods showsPrec :: Int -> PMError -> ShowS # show :: PMError -> String # showList :: [PMError] -> ShowS #

data PMSuccess Source #

Represents non-errors of the C enum PmError

Constructors

NoError'NoData	Returned by `poll` when there is no data, and returned by other functions when there is no error.
GotData	Only returned by `poll` when data is available.

Instances

Enum PMSuccess Source #
Instance details Defined in Sound.PortMidi Methods succ :: PMSuccess -> PMSuccess # pred :: PMSuccess -> PMSuccess # toEnum :: Int -> PMSuccess # fromEnum :: PMSuccess -> Int # enumFrom :: PMSuccess -> [PMSuccess] # enumFromThen :: PMSuccess -> PMSuccess -> [PMSuccess] # enumFromTo :: PMSuccess -> PMSuccess -> [PMSuccess] # enumFromThenTo :: PMSuccess -> PMSuccess -> PMSuccess -> [PMSuccess] #
Eq PMSuccess Source #
Instance details Defined in Sound.PortMidi Methods (==) :: PMSuccess -> PMSuccess -> Bool # (/=) :: PMSuccess -> PMSuccess -> Bool #
Show PMSuccess Source #
Instance details Defined in Sound.PortMidi Methods showsPrec :: Int -> PMSuccess -> ShowS # show :: PMSuccess -> String # showList :: [PMSuccess] -> ShowS #

newtype PMEventCount Source #

Represents a count of PMEvents

Constructors

PMEventCount CInt

Instances

Enum PMEventCount Source #
Instance details Defined in Sound.PortMidi Methods succ :: PMEventCount -> PMEventCount # pred :: PMEventCount -> PMEventCount # toEnum :: Int -> PMEventCount # fromEnum :: PMEventCount -> Int # enumFrom :: PMEventCount -> [PMEventCount] # enumFromThen :: PMEventCount -> PMEventCount -> [PMEventCount] # enumFromTo :: PMEventCount -> PMEventCount -> [PMEventCount] # enumFromThenTo :: PMEventCount -> PMEventCount -> PMEventCount -> [PMEventCount] #
Eq PMEventCount Source #
Instance details Defined in Sound.PortMidi Methods (==) :: PMEventCount -> PMEventCount -> Bool # (/=) :: PMEventCount -> PMEventCount -> Bool #
Integral PMEventCount Source #
Instance details Defined in Sound.PortMidi Methods quot :: PMEventCount -> PMEventCount -> PMEventCount # rem :: PMEventCount -> PMEventCount -> PMEventCount # div :: PMEventCount -> PMEventCount -> PMEventCount # mod :: PMEventCount -> PMEventCount -> PMEventCount # quotRem :: PMEventCount -> PMEventCount -> (PMEventCount, PMEventCount) # divMod :: PMEventCount -> PMEventCount -> (PMEventCount, PMEventCount) # toInteger :: PMEventCount -> Integer #
Num PMEventCount Source #
Instance details Defined in Sound.PortMidi Methods (+) :: PMEventCount -> PMEventCount -> PMEventCount # (-) :: PMEventCount -> PMEventCount -> PMEventCount # (*) :: PMEventCount -> PMEventCount -> PMEventCount # negate :: PMEventCount -> PMEventCount # abs :: PMEventCount -> PMEventCount # signum :: PMEventCount -> PMEventCount # fromInteger :: Integer -> PMEventCount #
Ord PMEventCount Source #
Instance details Defined in Sound.PortMidi Methods compare :: PMEventCount -> PMEventCount -> Ordering # (<) :: PMEventCount -> PMEventCount -> Bool # (<=) :: PMEventCount -> PMEventCount -> Bool # (>) :: PMEventCount -> PMEventCount -> Bool # (>=) :: PMEventCount -> PMEventCount -> Bool # max :: PMEventCount -> PMEventCount -> PMEventCount # min :: PMEventCount -> PMEventCount -> PMEventCount #
Real PMEventCount Source #
Instance details Defined in Sound.PortMidi Methods toRational :: PMEventCount -> Rational #
Show PMEventCount Source #
Instance details Defined in Sound.PortMidi Methods showsPrec :: Int -> PMEventCount -> ShowS # show :: PMEventCount -> String # showList :: [PMEventCount] -> ShowS #

type PMStream = ForeignPtr PortMidiStream Source #

data DeviceInfo Source #

Constructors

DeviceInfo
Fields interface :: String name :: String input :: Bool output :: Bool opened :: Bool

Instances

Eq DeviceInfo Source #
Instance details Defined in Sound.PortMidi.DeviceInfo Methods (==) :: DeviceInfo -> DeviceInfo -> Bool # (/=) :: DeviceInfo -> DeviceInfo -> Bool #
Show DeviceInfo Source #
Instance details Defined in Sound.PortMidi.DeviceInfo Methods showsPrec :: Int -> DeviceInfo -> ShowS # show :: DeviceInfo -> String # showList :: [DeviceInfo] -> ShowS #

type DeviceID = Int Source #

data PMMsg Source #

Constructors

PMMsg
Fields status :: !CLong data1 :: !CLong data2 :: !CLong

Instances

Eq PMMsg Source #
Instance details Defined in Sound.PortMidi Methods (==) :: PMMsg -> PMMsg -> Bool # (/=) :: PMMsg -> PMMsg -> Bool #
Show PMMsg Source #
Instance details Defined in Sound.PortMidi Methods showsPrec :: Int -> PMMsg -> ShowS # show :: PMMsg -> String # showList :: [PMMsg] -> ShowS #

data PMEvent Source #

Constructors

PMEvent
Fields message :: !CLong timestamp :: !Timestamp

Instances

Eq PMEvent Source #
Instance details Defined in Sound.PortMidi Methods (==) :: PMEvent -> PMEvent -> Bool # (/=) :: PMEvent -> PMEvent -> Bool #
Show PMEvent Source #
Instance details Defined in Sound.PortMidi Methods showsPrec :: Int -> PMEvent -> ShowS # show :: PMEvent -> String # showList :: [PMEvent] -> ShowS #
Storable PMEvent Source #
Instance details Defined in Sound.PortMidi Methods sizeOf :: PMEvent -> Int # alignment :: PMEvent -> Int # peekElemOff :: Ptr PMEvent -> Int -> IO PMEvent # pokeElemOff :: Ptr PMEvent -> Int -> PMEvent -> IO () # peekByteOff :: Ptr b -> Int -> IO PMEvent # pokeByteOff :: Ptr b -> Int -> PMEvent -> IO () # peek :: Ptr PMEvent -> IO PMEvent # poke :: Ptr PMEvent -> PMEvent -> IO () #

Constants

filterActive :: CLong Source #

filterSysex :: CLong Source #

filterClock :: CLong Source #

filterPlay :: CLong Source #

filterTick :: CLong Source #

filterFD :: CLong Source #

filterUndefined :: CLong Source #

filterReset :: CLong Source #

filterRealtime :: CLong Source #

filterNote :: CLong Source #

filterChannelAftertouch :: CLong Source #

filterPolyAftertouch :: CLong Source #

filterAftertouch :: CLong Source #

filterProgram :: CLong Source #

filterControl :: CLong Source #

filterPitchBend :: CLong Source #

filterMTC :: CLong Source #

filterSongPosition :: CLong Source #

filterSongSelect :: CLong Source #

filterTune :: CLong Source #

filterSystemCommon :: CLong Source #

PortMidi functions

initialize :: IO (Either PMError PMSuccess) Source #

terminate :: IO (Either PMError PMSuccess) Source #

hasHostError :: PMStream -> IO Bool Source #

getErrorText :: PMError -> IO String Source #

getSuccessText :: PMSuccess -> IO String Source #

getText :: Either PMError PMSuccess -> IO String Source #

countDevices :: IO DeviceID Source #

getDefaultInputDeviceID :: IO (Maybe DeviceID) Source #

getDefaultOutputDeviceID :: IO (Maybe DeviceID) Source #

getDeviceInfo :: DeviceID -> IO DeviceInfo Source #

openInput :: DeviceID -> IO (Either PMError PMStream) Source #

openOutput :: DeviceID -> Int -> IO (Either PMError PMStream) Source #

setFilter :: PMStream -> CLong -> IO (Either PMError PMSuccess) Source #

channel :: Int -> CLong Source #

setChannelMask :: PMStream -> CLong -> IO (Either PMError PMSuccess) Source #

abort :: PMStream -> IO (Either PMError PMSuccess) Source #

close :: PMStream -> IO (Either PMError PMSuccess) Source #

poll :: PMStream -> IO (Either PMError PMSuccess) Source #

Returns wether or not a subsequent call to readEvents would return some PMEvents or not.

readEvents :: PMStream -> IO (Either PMError [PMEvent]) Source #

Reads at most 256 PMEvents, using a dynamically allocated buffer.

readEventsToBuffer Source #

Arguments

:: PMStream
-> Ptr PMEvent	The `PMEvent`s buffer which will contain the results.
-> CLong	The size of the `PMEvent` buffer, in number of elements. No more that this number of `PMEvent`s can be read at once.
-> IO (Either PMError PMEventCount)	When `Right`, returns the number of elements written to the `PMEvent` buffer.

Reads PMEvents and writes them to the buffer passed as argument.

writeEvents :: PMStream -> [PMEvent] -> IO (Either PMError PMSuccess) Source #

writeShort :: PMStream -> PMEvent -> IO (Either PMError PMSuccess) Source #

writeSysEx :: PMStream -> Timestamp -> String -> IO (Either PMError PMSuccess) Source #

Time function

time :: IO Timestamp Source #

encodeMsg :: PMMsg -> CLong Source #

decodeMsg :: CLong -> PMMsg Source #