Safe Haskell	None

Sound.OpenSoundControl.Type

Contents

Datum
Address
Packet
Pretty printing

Description

Alegbraic data types for OSC datum and packets.

Synopsis

Documentation

type Datum_Type = Char Source

Type enumerating Datum categories.

data Datum Source

The basic elements of OSC messages.

Constructors

Int Int
Float Double
Double Double
String String
Blob ByteString
TimeStamp Time
Midi (Word8, Word8, Word8, Word8)

Instances

Eq Datum
Read Datum
Show Datum

type Address_Pattern = String Source

OSC address pattern.

data Message Source

An OSC message.

Constructors

Message
Fields messageAddress :: Address_Pattern messageDatum :: [Datum]

Instances

Eq Message
Read Message
Show Message
OSC Message

data Bundle Source

An OSC bundle.

Constructors

Bundle
Fields bundleTime :: Time bundleMessages :: [Message]

Instances

Eq Bundle
Ord Bundle	OSC `Bundle`s can be ordered (time ascending).
Read Bundle
Show Bundle
OSC Bundle

data Packet Source

An OSC Packet is either a Message or a Bundle.

Constructors

Packet_Message
Fields packetMessage :: Message
Packet_Bundle
Fields packetBundle :: Bundle

Instances

Eq Packet
Read Packet
Show Packet
OSC Packet

bundle :: Time -> [Message] -> Bundle Source

Bundle constructor. It is an error if the Message list is empty.

message :: Address_Pattern -> [Datum] -> Message Source

Message constructor. It is an error if the Address_Pattern doesn't conform to the OSC specification.

p_bundle :: Time -> [Message] -> Packet Source

Packet_Bundle . bundle.

p_message :: Address_Pattern -> [Datum] -> Packet Source

Packet_Message . message.

Datum

datum_tag :: Datum -> Datum_Type Source

Single character identifier of an OSC datum.

readMaybe :: Read a => String -> Maybe aSource

Variant of read.

parse_datum :: Datum_Type -> String -> Maybe Datum Source

Given Datum_Type attempt to parse Datum at String.

 parse_datum 'i' "42" == Just (Int 42)
 parse_datum 'f' "3.14159" == Just (Float 3.14159)
 parse_datum 'd' "3.14159" == Just (Double 3.14159)
 parse_datum 's' "\"pi\"" == Just (String "pi")
 parse_datum 'b' "pi" == Just (Blob (B.pack [112,105]))
 parse_datum 'm' "(0,144,60,90)" == Just (Midi (0,144,60,90))

datum_real :: Datum -> Maybe Double Source

Datum as real number if Double, Float or Int, else Nothing.

 map datum_real [Int 5,Float 5,String "5"] == [Just 5,Just 5,Nothing]

datum_real_err :: Datum -> Double Source

A fromJust variant of datum_real.

 map datum_real_err [Int 5,Float 5] == [5,5]

datum_int :: Integral i => Datum -> Maybe iSource

Datum as integral number if Double, Float or Int, else Nothing.

 map datum_int [Int 5,Float 5.5,String "5"] == [Just 5,Just 5,Nothing]

datum_int_err :: Integral i => Datum -> iSource

A fromJust variant of datum_int.

 map datum_int_err [Int 5,Float 5.5] == [5,5]

datum_string :: Datum -> Maybe String Source

Datum as String if String or Blob, else Nothing.

 map datum_string [String "5",Blob (B.pack [53])] == [Just "5",Just "5"]

datum_string_err :: Datum -> String Source

A fromJust variant of datum_string.

 map datum_string_err [String "5",Blob (B.pack [53])] == ["5","5"]

Address

message_has_address :: Address_Pattern -> Message -> Bool Source

Does Message have the specified Address_Pattern.

bundle_has_address :: Address_Pattern -> Bundle -> Bool Source

Do any of the Messages at Bundle have the specified Address_Pattern.

Packet

packet_has_address :: Address_Pattern -> Packet -> Bool Source

Does Packet have the specified Address_Pattern, ie. message_has_address or bundle_has_address.

packetTime :: Packet -> Time Source

The Time of Packet, if the Packet is a Message this is immediately.

packetMessages :: Packet -> [Message]Source

Retrieve the set of Messages from a Packet.

packet_to_bundle :: Packet -> Bundle Source

If Packet is a Message add immediately timestamp, else id.

packet_to_message :: Packet -> Maybe Message Source

If Packet is a Message or a Bundle with an immediate time tag and with one element, return the Message, else Nothing.

packet_is_immediate :: Packet -> Bool Source

Is Packet immediate, ie. a Bundle with timestamp immediately, or a plain Message.

at_packet :: (Message -> a) -> (Bundle -> a) -> Packet -> aSource

Variant of either for Packet.

Pretty printing

timePP :: Time -> String Source

Pretty printer for Time.

datumPP :: Datum -> String Source

Pretty printer for Datum.

 map datumPP [Float 1.2,String "str",Midi (0,0x90,0x40,0x60)]

messagePP :: Message -> String Source

Pretty printer for Message.

bundlePP :: Bundle -> String Source

Pretty printer for Bundle.

packetPP :: Packet -> String Source

Pretty printer for Packet.