Sound.Osc.Coding.Byte · hosc-0.20

Encode

10 declarations

valueencode_int8 :: Int8 -> ByteString

Type specialised encode (big-endian).

valueencode_int16 :: Int16 -> ByteString

Type specialised encode (big-endian).

encode_int16 0x0102 == L.pack [0x01,0x02]

valueencode_int16_le :: Int16 -> ByteString

#

Little-endian.

encode_int16_le 0x0102 == L.pack [0x02,0x01]

valueencode_int64 :: Int64 -> ByteString

#

Encode a signed 64-bit integer (big-endian).

valueencode_word8 :: Word8 -> ByteString

#

Type specialised encode (big-endian).

valueencode_word16 :: Word16 -> ByteString

#

Type specialised encode (big-endian).

encode_word16 0x0102 == L.pack [0x01,0x02]

valueencode_word16_le :: Word16 -> ByteString

#

Little-endian.

encode_word16_le 0x0102 == L.pack [0x02,0x01]

valueencode_word32 :: Word32 -> ByteString

#

Type specialised encode.

valueencode_word32_le :: Word32 -> ByteString

#

Little-endian variant of encode_word32.

valueencode_word64 :: Word64 -> ByteString

#

Encode an unsigned 64-bit integer.

Encode/Int

8 declarations

valueencode_i8 :: Int -> ByteString

#

Encode a signed 8-bit integer.

valueencode_u8 :: Int -> ByteString

#

Encode an un-signed 8-bit integer.

valueencode_u16 :: Int -> ByteString

#

Encode an un-signed 16-bit integer.

encode_u16 0x0102 == L.pack [1,2]

valueencode_u16_le :: Int -> ByteString

#

Little-endian.

encode_u16_le 0x0102 == L.pack [2,1]

valueencode_i16 :: Int -> ByteString

#

Encode a signed 16-bit integer.

valueencode_i32 :: Int -> ByteString

#

Encode a signed 32-bit integer.

valueencode_u32 :: Int -> ByteString

#

Encode an unsigned 32-bit integer.

encode_u32 0x01020304 == L.pack [1,2,3,4]

valueencode_u32_le :: Int -> ByteString

#

Little-endian.

encode_u32_le 0x01020304 == L.pack [4,3,2,1]

Encode/Float

4 declarations

valueencode_f32 :: Float -> ByteString

#

Encode a 32-bit IEEE floating point number.

encode_f32 1.0 == L.pack [63, 128, 0, 0]

valueencode_f32_le :: Float -> ByteString

#

Little-endian variant of encode_f32.

valueencode_f64 :: Double -> ByteString

#

Encode a 64-bit IEEE floating point number.

valueencode_f64_le :: Double -> ByteString

#

Little-endian variant of encode_f64.

Encode/Ascii

1 declaration

valueencode_ascii :: ByteString -> ByteString

#

Encode an Ascii string (Ascii at Datum is an alias for a Char8 Bytetring).

Decode

7 declarations

valuedecode_word16 :: ByteString -> Word16

#

Type specialised decode.

valuedecode_word16_le :: ByteString -> Word16

#

Little-endian variant of decode_word16.

valuedecode_int16 :: ByteString -> Int16

#

Type specialised decode.

valuedecode_word32 :: ByteString -> Word32

#

Type specialised decode.

valuedecode_word32_le :: ByteString -> Word32

#

Little-endian variant of decode_word32.

valuedecode_int64 :: ByteString -> Int64

#

Type specialised decode.

valuedecode_word64 :: ByteString -> Word64

#

Type specialised decode.

Decode/Int

10 declarations

valuedecode_u8 :: ByteString -> Int

#

Decode an un-signed 8-bit integer.

valuedecode_i8 :: ByteString -> Int

#

Decode a signed 8-bit integer.

valuedecode_u16 :: ByteString -> Int

#

Decode an unsigned 8-bit integer.

valuedecode_u16_le :: ByteString -> Int

#

Little-endian variant of decode_u16.

valuedecode_i16 :: ByteString -> Int

#

Decode a signed 16-bit integer.

valuedecode_i16_le :: ByteString -> Int

#

Little-endian variant of decode_i16.

valuedecode_i32 :: ByteString -> Int

#

Decode a signed 32-bit integer.

decode_i32 (L.pack [0x00,0x00,0x03,0xe7]) == 0x03e7

valuedecode_i32_le :: ByteString -> Int

#

Little-endian variant of decode_i32.

decode_i32_le (L.pack [0xe7,0x03,0x00,0x00]) == 0x03e7

valuedecode_u32 :: ByteString -> Int

#

Decode an unsigned 32-bit integer.

decode_u32 (L.pack [1,2,3,4]) == 0x01020304

valuedecode_u32_le :: ByteString -> Int

#

Little-endian variant of decode_u32.

decode_u32_le (L.pack [1,2,3,4]) == 0x04030201

Decode/Float

3 declarations

valuedecode_f32 :: ByteString -> Float

#

Decode a 32-bit IEEE floating point number.

valuedecode_f32_le :: ByteString -> Float

#

Little-endian variant of decode_f32.

valuedecode_f64 :: ByteString -> Double

#

Decode a 64-bit IEEE floating point number.

Decode/Ascii

1 declaration

valuedecode_ascii :: ByteString -> ByteString

#

Decode an Ascii string, inverse of encode_ascii.

IO

5 declarations

valueread_decode :: (ByteString -> t) -> Int -> Handle -> IO t

#

Read n bytes from h and run f.

valueread_word32 :: Handle -> IO Word32

#

Type-specialised reader for decode.

valueread_word32_le :: Handle -> IO Word32

#

read_decode of decode_word32_le.

valuewrite_word32 :: Handle -> Word32 -> IO ()

#

hPut of encode_word32.

valuewrite_word32_le :: Handle -> Word32 -> IO ()

#

hPut of encode_word32_le.

Io/Int

8 declarations

valueread_i8 :: Handle -> IO Int

#

decode_i8 of hGet.

valueread_i16 :: Handle -> IO Int

#

decode_i16 of hGet.

valueread_i32 :: Handle -> IO Int

#

decode_i32 of hGet.

valueread_i32_le :: Handle -> IO Int

#

decode_i32_le of hGet.

valueread_u32 :: Handle -> IO Int

#

decode_u32 of hGet.

valueread_u32_le :: Handle -> IO Int

#

decode_u32_le of hGet.

valuewrite_u32 :: Handle -> Int -> IO ()

#

hPut of encode_u32.

valuewrite_u32_le :: Handle -> Int -> IO ()

#

hPut of encode_u32_le.

Io/Float

2 declarations

valueread_f32 :: Handle -> IO Float

#

decode_f32 of hGet.

valueread_f32_le :: Handle -> IO Float

#

decode_f32_le of hGet.

Io/Ascii

1 declaration

valueread_pstr :: Handle -> IO ByteString

#

Read u8 length prefixed Ascii string (pascal string).

Util

3 declarations

valuebundleHeader_strict :: ByteString

#

Bundle header as a (strict) ByteString.

S.C.length bundleHeader_strict == 8

valuebundleHeader :: ByteString

#

Bundle header as a lazy ByteString.

L.length bundleHeader == 8

valuealign :: (Num i, Bits i) => i -> i

#

The number of bytes required to align an Osc value to the next 4-byte boundary.

map align [0::Int .. 7] == [0,3,2,1,0,3,2,1]
map align [512::Int .. 519] == [0,3,2,1,0,3,2,1]