Modulesdl2-2.5.5.0Haskell2010

SDL.Audio

SDL.Audio provides a high-level API to SDL's audio device capabilities.

11 types
10 values

Packagesdl2-2.5.5.0
Exports21
LanguageHaskell2010
LicenceBSD-3-Clause
SourceAudio.hs

Managing AudioDevices

1 declaration

newtypenewtype AudioDevice

An open audio device. These can be created via openAudioDevice and should be closed with closeAudioDevice

Instances1Eq

Eq AudioDeviceDefined in sdl2-2.5.5.0 · SDL.Audio

Opening and Closing AudioDevices

valueopenAudioDevice :: MonadIO m => OpenDeviceSpec -> m (AudioDevice, AudioSpec)

Attempt to open the closest matching AudioDevice, as specified by the given OpenDeviceSpec.

See SDL_OpenAudioDevice for C documentation.

valuecloseAudioDevice :: MonadIO m => AudioDevice -> m ()

See SDL_CloseAudioDevice for C documentation.

datadata OpenDeviceSpec

A specification to openAudioDevice, indicating the desired output format. Note that many of these properties are Changeable, meaning that you can choose whether or not SDL should interpret your specification as an unbreakable request (Mandate), or as an approximation Desire.

Constructors

forall sampleType. OpenDeviceSpec
- openDeviceFreq :: !Changeable CInt
  The output audio frequency in herts.
- openDeviceFormat :: !Changeable (AudioFormat sampleType)
  The format of audio that will be sampled from the output buffer.
- openDeviceChannels :: !Changeable Channels
  The amount of audio channels.
- openDeviceSamples :: !Word16
  Output audio buffer size in samples. This should be a power of 2.
- openDeviceCallback :: forall actualSampleType. AudioFormat actualSampleType -> IOVector actualSampleType -> IO ()
  A callback to invoke whenever new sample data is required. The callback will be passed a single MVector that must be filled with audio data.
- openDeviceUsage :: !AudioDeviceUsage
  How you intend to use the opened AudioDevice - either for outputting or capturing audio.
- openDeviceName :: !Maybe Text
  The name of the AudioDevice that should be opened. If Nothing, any suitable AudioDevice will be used.

datadata AudioDeviceUsage

How you intend to use an AudioDevice

Constructors

ForPlayback
The device will be used for sample playback.
ForCapture
The device will be used for sample capture.

Instances9Bounded, Enum, Eq, Data, Ord, Read, …

Bounded AudioDeviceUsageDefined in sdl2-2.5.5.0 · SDL.Audio
Enum AudioDeviceUsageDefined in sdl2-2.5.5.0 · SDL.Audio
Eq AudioDeviceUsageDefined in sdl2-2.5.5.0 · SDL.Audio
Data AudioDeviceUsageDefined in sdl2-2.5.5.0 · SDL.Audio
Ord AudioDeviceUsageDefined in sdl2-2.5.5.0 · SDL.Audio
Read AudioDeviceUsageDefined in sdl2-2.5.5.0 · SDL.Audio
Show AudioDeviceUsageDefined in sdl2-2.5.5.0 · SDL.Audio
Generic AudioDeviceUsageDefined in sdl2-2.5.5.0 · SDL.Audio
type Rep AudioDeviceUsage = D1 ('MetaData "AudioDeviceUsage" "SDL.Audio" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "ForPlayback" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ForCapture" 'PrefixI 'False) U1)Defined in sdl2-2.5.5.0 · SDL.Audio

datadata Channels

How many channels audio should be played on

Constructors

Mono
A single speaker configuration
Stereo
A traditional left/right stereo system
Quad
FivePointOne
1. 1 surround sound

Instances9Bounded, Enum, Eq, Data, Ord, Read, …

Bounded ChannelsDefined in sdl2-2.5.5.0 · SDL.Audio
Enum ChannelsDefined in sdl2-2.5.5.0 · SDL.Audio
Eq ChannelsDefined in sdl2-2.5.5.0 · SDL.Audio
Data ChannelsDefined in sdl2-2.5.5.0 · SDL.Audio
Ord ChannelsDefined in sdl2-2.5.5.0 · SDL.Audio
Read ChannelsDefined in sdl2-2.5.5.0 · SDL.Audio
Show ChannelsDefined in sdl2-2.5.5.0 · SDL.Audio
Generic ChannelsDefined in sdl2-2.5.5.0 · SDL.Audio
type Rep Channels = D1 ('MetaData "Channels" "SDL.Audio" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) ((C1 ('MetaCons "Mono" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Stereo" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "Quad" 'PrefixI 'False) U1 :+: C1 ('MetaCons "FivePointOne" 'PrefixI 'False) U1))Defined in sdl2-2.5.5.0 · SDL.Audio

datadata Changeable a

Used to indicate to SDL whether it is allowed to open other audio devices (if a property is marked as a Desire) or if it should fail if the device is unavailable (Mandate).

Constructors

Mandate !a
Mandate this exact property value, and fail if a matching audio device cannot be found.
Desire !a
Desire this property value, but allow other audio devices to be opened.

Instances9Functor, Foldable, Traversable, Eq, Data, Read, …

Functor ChangeableDefined in sdl2-2.5.5.0 · SDL.Audio
Foldable ChangeableDefined in sdl2-2.5.5.0 · SDL.Audio
Traversable ChangeableDefined in sdl2-2.5.5.0 · SDL.Audio
Eq a => Eq (Changeable a)Defined in sdl2-2.5.5.0 · SDL.Audio
Data a => Data (Changeable a)Defined in sdl2-2.5.5.0 · SDL.Audio
Read a => Read (Changeable a)Defined in sdl2-2.5.5.0 · SDL.Audio
Show a => Show (Changeable a)Defined in sdl2-2.5.5.0 · SDL.Audio
Generic (Changeable a)Defined in sdl2-2.5.5.0 · SDL.Audio
type Rep (Changeable a) = D1 ('MetaData "Changeable" "SDL.Audio" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "Mandate" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)) :+: C1 ('MetaCons "Desire" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))Defined in sdl2-2.5.5.0 · SDL.Audio

Working with Opened Devices

Locking AudioDevices

valuesetAudioDeviceLocked :: MonadIO m => AudioDevice -> LockState -> m ()

Lock an AudioDevice such that its associated callback will not be called until the device is unlocked.

datadata LockState

Whether a device should be locked or unlocked.

Constructors

Locked
Lock the device, preventing the callback from producing data.
Unlocked
Unlock the device, resuming calls to the callback.

Instances9Bounded, Enum, Eq, Data, Ord, Read, …

Bounded LockStateDefined in sdl2-2.5.5.0 · SDL.Audio
Enum LockStateDefined in sdl2-2.5.5.0 · SDL.Audio
Eq LockStateDefined in sdl2-2.5.5.0 · SDL.Audio
Data LockStateDefined in sdl2-2.5.5.0 · SDL.Audio
Ord LockStateDefined in sdl2-2.5.5.0 · SDL.Audio
Read LockStateDefined in sdl2-2.5.5.0 · SDL.Audio
Show LockStateDefined in sdl2-2.5.5.0 · SDL.Audio
Generic LockStateDefined in sdl2-2.5.5.0 · SDL.Audio
type Rep LockState = D1 ('MetaData "LockState" "SDL.Audio" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "Locked" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Unlocked" 'PrefixI 'False) U1)Defined in sdl2-2.5.5.0 · SDL.Audio

Switching Playback States

datadata PlaybackState

Whether to allow an AudioDevice to play sound or remain paused.

Constructors

Pause
Pause the AudioDevice, which will stop producing/capturing audio.
Play
Resume the AudioDevice.

Instances9Bounded, Enum, Eq, Data, Ord, Read, …

Bounded PlaybackStateDefined in sdl2-2.5.5.0 · SDL.Audio
Enum PlaybackStateDefined in sdl2-2.5.5.0 · SDL.Audio
Eq PlaybackStateDefined in sdl2-2.5.5.0 · SDL.Audio
Data PlaybackStateDefined in sdl2-2.5.5.0 · SDL.Audio
Ord PlaybackStateDefined in sdl2-2.5.5.0 · SDL.Audio
Read PlaybackStateDefined in sdl2-2.5.5.0 · SDL.Audio
Show PlaybackStateDefined in sdl2-2.5.5.0 · SDL.Audio
Generic PlaybackStateDefined in sdl2-2.5.5.0 · SDL.Audio
type Rep PlaybackState = D1 ('MetaData "PlaybackState" "SDL.Audio" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "Pause" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Play" 'PrefixI 'False) U1)Defined in sdl2-2.5.5.0 · SDL.Audio

valuesetAudioDevicePlaybackState

:: MonadIO m
=> AudioDevice
-> PlaybackState
-> m ()

Change the playback state of an AudioDevice.

Querying an AudioDevices Status.

datadata AudioDeviceStatus

Opened devices are always Playing or Paused in normal circumstances. A failing device may change its status to Stopped at any time, and closing a device will progress to Stopped too.

Constructors

Playing
The AudioDevice is playing.
Paused
The AudioDevice is paused.
Stopped
The AudioDevice is stopped.

Instances9Bounded, Enum, Eq, Data, Ord, Read, …

Bounded AudioDeviceStatusDefined in sdl2-2.5.5.0 · SDL.Audio
Enum AudioDeviceStatusDefined in sdl2-2.5.5.0 · SDL.Audio
Eq AudioDeviceStatusDefined in sdl2-2.5.5.0 · SDL.Audio
Data AudioDeviceStatusDefined in sdl2-2.5.5.0 · SDL.Audio
Ord AudioDeviceStatusDefined in sdl2-2.5.5.0 · SDL.Audio
Read AudioDeviceStatusDefined in sdl2-2.5.5.0 · SDL.Audio
Show AudioDeviceStatusDefined in sdl2-2.5.5.0 · SDL.Audio
Generic AudioDeviceStatusDefined in sdl2-2.5.5.0 · SDL.Audio
type Rep AudioDeviceStatus = D1 ('MetaData "AudioDeviceStatus" "SDL.Audio" "sdl2-2.5.5.0-3sH3mgPhw4837qWuaPOiH" 'False) (C1 ('MetaCons "Playing" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Paused" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Stopped" 'PrefixI 'False) U1))Defined in sdl2-2.5.5.0 · SDL.Audio

valueaudioDeviceStatus :: MonadIO m => AudioDevice -> m AudioDeviceStatus

Query the state of an AudioDevice.

AudioFormat

datadata AudioFormat sampleType where

Information about what format an audio bytestream is. The type variable t indicates the type used for audio buffer samples. It is determined by the choice of the provided SampleBitSize. For example:

AudioFormat UnsignedInteger Sample8Bit Native :: AudioFormat Word8

Indicating that an 8-bit audio format in the platforms native endianness uses a buffer of Word8 values.

Constructors

Signed8BitAudio :: AudioFormat Int8
Unsigned8BitAudio :: AudioFormat Word8
Signed16BitLEAudio :: AudioFormat Int16
Signed16BitBEAudio :: AudioFormat Int16
Signed16BitNativeAudio :: AudioFormat Int16
Unsigned16BitLEAudio :: AudioFormat Word16
Unsigned16BitBEAudio :: AudioFormat Word16
Unsigned16BitNativeAudio :: AudioFormat Word16
Signed32BitLEAudio :: AudioFormat Int32
Signed32BitBEAudio :: AudioFormat Int32
Signed32BitNativeAudio :: AudioFormat Int32
FloatingLEAudio :: AudioFormat Float
FloatingBEAudio :: AudioFormat Float
FloatingNativeAudio :: AudioFormat Float

Instances3Eq, Ord, Show

Eq (AudioFormat sampleType)Defined in sdl2-2.5.5.0 · SDL.Audio
Ord (AudioFormat sampleType)Defined in sdl2-2.5.5.0 · SDL.Audio
Show (AudioFormat sampleType)Defined in sdl2-2.5.5.0 · SDL.Audio

Enumerating AudioDevices

valuegetAudioDeviceNames

:: MonadIO m
=> AudioDeviceUsage
-> m (Maybe (Vector Text))

Enumerate all AudioDevices attached to this system, that can be used as specified by the given AudioDeviceUsage. SDL cannot always guarantee that this list can be produced, in which case Nothing will be returned.

AudioSpec

1 declaration

datadata AudioSpec

AudioSpec is the concrete specification of how an AudioDevice was sucessfully opened. Unlike OpenDeviceSpec, which specifies what you want, AudioSpec specifies what you have.

Constructors

forall sampleType. AudioSpec
- audioSpecFreq :: !CInt
  DSP frequency (samples per second)
- audioSpecFormat :: !AudioFormat sampleType
  Audio data format
- audioSpecChannels :: !Channels
  Number of separate sound channels
- audioSpecSilence :: !Word8
  Calculated udio buffer silence value
- audioSpecSamples :: !Word16
  Audio buffer size in samples (power of 2)
- audioSpecSize :: !Word32
  Calculated audio buffer size in bytes
- audioSpecCallback :: AudioFormat sampleType -> IOVector sampleType -> IO ()
  The function to call when the audio device needs more data

Audio Drivers

4 declarations

valuegetAudioDrivers :: MonadIO m => m (Vector AudioDriver)

Obtain a list of all possible audio drivers for this system. These drivers can be used to specificially initialize the audio system.

valuecurrentAudioDriver :: MonadIO m => m (Maybe Text)

Query SDL for the name of the currently initialized audio driver, if possible. This will return Nothing if no driver has been initialized.

newtypenewtype AudioDriver

An abstract description of an audio driver on the host machine.

Instances2Eq, Show

Eq AudioDriverDefined in sdl2-2.5.5.0 · SDL.Audio
Show AudioDriverDefined in sdl2-2.5.5.0 · SDL.Audio

valueaudioDriverName :: AudioDriver -> Text

Get the human readable name of an AudioDriver

Explicit Initialization

1 declaration

valueaudioInit :: MonadIO m => AudioDriver -> m ()

Explicitly initialize the audio system against a specific AudioDriver. Note that most users will not need to do this, as the normal initialization routines will already take care of this for you.