Safe Haskell	None
Language	Haskell98

Sound.SoxLib

Synopsis

with :: IO a -> IO a
formatWith :: IO a -> IO a
openRead :: ReaderInfo -> FilePath -> IO (FormatPtr ReadMode)
withRead :: ReaderInfo -> FilePath -> (FormatPtr ReadMode -> IO a) -> IO a
readStorableVector :: FormatPtr ReadMode -> Int -> IO (Vector Int32)
readStorableVectorLazy :: FormatPtr ReadMode -> ChunkSize -> IO (Vector Int32)
openWrite :: WriterInfo -> FilePath -> IO (FormatPtr WriteMode)
withWrite :: WriterInfo -> FilePath -> (FormatPtr WriteMode -> IO a) -> IO a
writeStorableVector :: FormatPtr WriteMode -> Vector Int32 -> IO ()
writeStorableVectorLazy :: FormatPtr WriteMode -> Vector Int32 -> IO ()
storableVectorLazyFromByteString :: ReaderInfo -> ByteString -> ChunkSize -> Maybe (Vector Int32)
close :: Mode mode => FormatPtr mode -> IO ()
seek :: Mode mode => FormatPtr mode -> Int -> IO ()
class Mode mode where
- getModeChar :: Format mode -> CChar
data ReadMode
data WriteMode
data ReaderInfo = ReaderInfo {
- readerSignalInfo :: Maybe SignalInfo
- readerEncodingInfo :: Maybe EncodingInfo
- readerFileType :: Maybe FileType
}
defaultReaderInfo :: ReaderInfo
data WriterInfo = WriterInfo {
- writerSignalInfo :: Maybe SignalInfo
- writerEncodingInfo :: Maybe EncodingInfo
- writerFileType :: Maybe FileType
}
defaultWriterInfo :: WriterInfo
type Rate = Double
newtype FileType = FileType {
- unFileType :: String
}
data Format mode = Format {
- filename :: FilePath
- signalInfo :: SignalInfo
- encodingInfo :: EncodingInfo
- filetype :: FileType
- seekable :: Bool
- olength :: Int
- clips :: Int
- soxErrno :: Errno
- soxErrStr :: String
- fp :: Ptr CFile
- ioType :: IOType
- tellOff :: CLong
- dataStart :: CLong
- priv :: Ptr ()
}
data SignalInfo = SignalInfo {
- rate :: Maybe Rate
- channels :: Maybe Int
- precision :: Maybe Int
- length :: Maybe Int
- mult :: Maybe Double
}
data EncodingInfo = EncodingInfo {
- encoding :: Encoding
- bitsPerSample :: Int
- compression :: Double
- reverseBytes, reverseNibbles, reverseBits :: Option
- oppositeEndian :: Bool
}
defaultSignalInfo :: SignalInfo
data IOType
ioFile :: IOType
ioPipe :: IOType
ioURL :: IOType
data Option
optionNo :: Option
optionYes :: Option
optionDefault :: Option
data Encoding
encodingUnknown :: Encoding
encodingSign2 :: Encoding
encodingUnsigned :: Encoding
encodingFloat :: Encoding
encodingFloatText :: Encoding
encodingFlac :: Encoding
encodingHcom :: Encoding
encodingWavpack :: Encoding
encodingWavpackf :: Encoding
encodingUlaw :: Encoding
encodingAlaw :: Encoding
encodingG721 :: Encoding
encodingG723 :: Encoding
encodingClADPCM :: Encoding
encodingClADPCM16 :: Encoding
encodingMsADPCM :: Encoding
encodingImaADPCM :: Encoding
encodingOkiADPCM :: Encoding
encodingDPCM :: Encoding
encodingDWVW :: Encoding
encodingDWVWN :: Encoding
encodingGSM :: Encoding
encodingMP3 :: Encoding
encodingVorbis :: Encoding
encodingAmrWB :: Encoding
encodingAmrNB :: Encoding
encodingCVSD :: Encoding
encodingLPC10 :: Encoding

Documentation

with :: IO a -> IO a Source #

formatWith :: IO a -> IO a Source #

All SoxLib operations must be enclosed in formatWith. You must only call it once per program.

openRead :: ReaderInfo -> FilePath -> IO (FormatPtr ReadMode) Source #

This function will never return a nullPtr. Instead it throws a user exception if the file cannot be opened.

withRead :: ReaderInfo -> FilePath -> (FormatPtr ReadMode -> IO a) -> IO a Source #

readStorableVector :: FormatPtr ReadMode -> Int -> IO (Vector Int32) Source #

Multi-channel data is interleaved. size must be divisible by the number of channels.

readStorableVectorLazy :: FormatPtr ReadMode -> ChunkSize -> IO (Vector Int32) Source #

Read complete file lazily into chunky storable vector. The chunkSize must be divisible by the number of channels.

openWrite :: WriterInfo -> FilePath -> IO (FormatPtr WriteMode) Source #

This function will never return a nullPtr. Instead it throws a user exception if the file cannot be opened.

withWrite :: WriterInfo -> FilePath -> (FormatPtr WriteMode -> IO a) -> IO a Source #

writeStorableVector :: FormatPtr WriteMode -> Vector Int32 -> IO () Source #

Multi-channel data is interleaved. size must be divisible by the number of channels.

Caution: Writing large chunks (e.g. more than 8192 samples) may crash the FLAC backend.

writeStorableVectorLazy :: FormatPtr WriteMode -> Vector Int32 -> IO () Source #

The chunkSize must be divisible by the number of channels.

storableVectorLazyFromByteString :: ReaderInfo -> ByteString -> ChunkSize -> Maybe (Vector Int32) Source #

It reads lazily to lazy storable vector. That is, the whole ByteString is kept as long as we process the lazy storable vector.

close :: Mode mode => FormatPtr mode -> IO () Source #

seek :: Mode mode => FormatPtr mode -> Int -> IO () Source #

class Mode mode where Source #

Methods

getModeChar :: Format mode -> CChar Source #

Instances

Mode WriteMode Source #
Instance details Defined in Sound.SoxLib.FFI Methods getModeChar :: Format WriteMode -> CChar Source #
Mode ReadMode Source #
Instance details Defined in Sound.SoxLib.FFI Methods getModeChar :: Format ReadMode -> CChar Source #

data ReadMode Source #

Instances

Mode ReadMode Source #
Instance details Defined in Sound.SoxLib.FFI Methods getModeChar :: Format ReadMode -> CChar Source #

data WriteMode Source #

Instances

Mode WriteMode Source #
Instance details Defined in Sound.SoxLib.FFI Methods getModeChar :: Format WriteMode -> CChar Source #

data ReaderInfo Source #

Constructors

ReaderInfo
Fields readerSignalInfo :: Maybe SignalInfo readerEncodingInfo :: Maybe EncodingInfo readerFileType :: Maybe FileType

defaultReaderInfo :: ReaderInfo Source #

data WriterInfo Source #

Constructors

WriterInfo
Fields writerSignalInfo :: Maybe SignalInfo writerEncodingInfo :: Maybe EncodingInfo writerFileType :: Maybe FileType

defaultWriterInfo :: WriterInfo Source #

type Rate = Double Source #

newtype FileType Source #

Constructors

FileType
Fields unFileType :: String

Instances

Show FileType Source #
Instance details Defined in Sound.SoxLib.FFI Methods showsPrec :: Int -> FileType -> ShowS # show :: FileType -> String # showList :: [FileType] -> ShowS #

data Format mode Source #

Constructors

Format
Fields filename :: FilePath signalInfo :: SignalInfo encodingInfo :: EncodingInfo filetype :: FileType seekable :: Bool olength :: Int clips :: Int soxErrno :: Errno soxErrStr :: String fp :: Ptr CFile ioType :: IOType tellOff :: CLong dataStart :: CLong priv :: Ptr ()

Instances

Mode mode => Storable (Format mode) Source #

Instance details

Defined in Sound.SoxLib.FFI

Methods

sizeOf :: Format mode -> Int #

alignment :: Format mode -> Int #

peekElemOff :: Ptr (Format mode) -> Int -> IO (Format mode) #

pokeElemOff :: Ptr (Format mode) -> Int -> Format mode -> IO () #

peekByteOff :: Ptr b -> Int -> IO (Format mode) #

pokeByteOff :: Ptr b -> Int -> Format mode -> IO () #

peek :: Ptr (Format mode) -> IO (Format mode) #

poke :: Ptr (Format mode) -> Format mode -> IO () #

data SignalInfo Source #

Constructors

SignalInfo
Fields rate :: Maybe Rate channels :: Maybe Int precision :: Maybe Int length :: Maybe Int mult :: Maybe Double

Instances

Show SignalInfo Source #
Instance details Defined in Sound.SoxLib.FFI Methods showsPrec :: Int -> SignalInfo -> ShowS # show :: SignalInfo -> String # showList :: [SignalInfo] -> ShowS #
Storable SignalInfo Source #
Instance details Defined in Sound.SoxLib.FFI Methods sizeOf :: SignalInfo -> Int # alignment :: SignalInfo -> Int # peekElemOff :: Ptr SignalInfo -> Int -> IO SignalInfo # pokeElemOff :: Ptr SignalInfo -> Int -> SignalInfo -> IO () # peekByteOff :: Ptr b -> Int -> IO SignalInfo # pokeByteOff :: Ptr b -> Int -> SignalInfo -> IO () # peek :: Ptr SignalInfo -> IO SignalInfo # poke :: Ptr SignalInfo -> SignalInfo -> IO () #

data EncodingInfo Source #

Constructors

EncodingInfo
Fields encoding :: Encoding bitsPerSample :: Int compression :: Double reverseBytes, reverseNibbles, reverseBits :: Option oppositeEndian :: Bool

Instances

Show EncodingInfo Source #
Instance details Defined in Sound.SoxLib.FFI Methods showsPrec :: Int -> EncodingInfo -> ShowS # show :: EncodingInfo -> String # showList :: [EncodingInfo] -> ShowS #
Storable EncodingInfo Source #
Instance details Defined in Sound.SoxLib.FFI Methods sizeOf :: EncodingInfo -> Int # alignment :: EncodingInfo -> Int # peekElemOff :: Ptr EncodingInfo -> Int -> IO EncodingInfo # pokeElemOff :: Ptr EncodingInfo -> Int -> EncodingInfo -> IO () # peekByteOff :: Ptr b -> Int -> IO EncodingInfo # pokeByteOff :: Ptr b -> Int -> EncodingInfo -> IO () # peek :: Ptr EncodingInfo -> IO EncodingInfo # poke :: Ptr EncodingInfo -> EncodingInfo -> IO () #

defaultSignalInfo :: SignalInfo Source #

data IOType Source #

Instances

Show IOType Source #
Instance details Defined in Sound.SoxLib.FFI Methods showsPrec :: Int -> IOType -> ShowS # show :: IOType -> String # showList :: [IOType] -> ShowS #
Storable IOType Source #
Instance details Defined in Sound.SoxLib.FFI Methods sizeOf :: IOType -> Int # alignment :: IOType -> Int # peekElemOff :: Ptr IOType -> Int -> IO IOType # pokeElemOff :: Ptr IOType -> Int -> IOType -> IO () # peekByteOff :: Ptr b -> Int -> IO IOType # pokeByteOff :: Ptr b -> Int -> IOType -> IO () # peek :: Ptr IOType -> IO IOType # poke :: Ptr IOType -> IOType -> IO () #

ioFile :: IOType Source #

ioPipe :: IOType Source #

ioURL :: IOType Source #

data Option Source #

Instances

Show Option Source #
Instance details Defined in Sound.SoxLib.FFI Methods showsPrec :: Int -> Option -> ShowS # show :: Option -> String # showList :: [Option] -> ShowS #
Storable Option Source #
Instance details Defined in Sound.SoxLib.FFI Methods sizeOf :: Option -> Int # alignment :: Option -> Int # peekElemOff :: Ptr Option -> Int -> IO Option # pokeElemOff :: Ptr Option -> Int -> Option -> IO () # peekByteOff :: Ptr b -> Int -> IO Option # pokeByteOff :: Ptr b -> Int -> Option -> IO () # peek :: Ptr Option -> IO Option # poke :: Ptr Option -> Option -> IO () #

optionNo :: Option Source #

optionYes :: Option Source #

optionDefault :: Option Source #

data Encoding Source #

Instances

Bounded Encoding Source #
Instance details Defined in Sound.SoxLib.FFI Methods minBound :: Encoding # maxBound :: Encoding #
Show Encoding Source #
Instance details Defined in Sound.SoxLib.FFI Methods showsPrec :: Int -> Encoding -> ShowS # show :: Encoding -> String # showList :: [Encoding] -> ShowS #
Storable Encoding Source #
Instance details Defined in Sound.SoxLib.FFI Methods sizeOf :: Encoding -> Int # alignment :: Encoding -> Int # peekElemOff :: Ptr Encoding -> Int -> IO Encoding # pokeElemOff :: Ptr Encoding -> Int -> Encoding -> IO () # peekByteOff :: Ptr b -> Int -> IO Encoding # pokeByteOff :: Ptr b -> Int -> Encoding -> IO () # peek :: Ptr Encoding -> IO Encoding # poke :: Ptr Encoding -> Encoding -> IO () #