Sound.MikMod

MikMod bindings for Haskell

Overview

MikMod is a C library for playing music modules and sound samples.

The user controls MikMod by manipulating a handful of global variables, calling API functions, and manipulating fields of the Module and Sample structure. These low-level bindings are basically convenience wrappers for the above operations.

Module objects represent not only music but the playback state of a song. In this sense you can think of Modules as being like cassette tapes. For example if a playing module is paused or stopped, and another module begins playing, then resuming the original module will start from the position it was stopped at. You manipulate modules only via the type ModuleHandle.

Sample objects represent single sounds. Modules use samples to make music, but you can use samples independently for sound effects. Samples are similar to Modules in that they are only accessed via the type SampleHandle.

Music and sound effects both play samples on voices. There can be at most one sample playing on a voice at a time. Voices can be individually adjusted to change the characteristics of the samples that play on them. Voices are exposed by MikMod as indexes. These indexes are wrapped in the Voice newtype.

Modifying values of global variables and structure fields is allowed during playback and in most cases will have immediate effect.

MikMod allows loading modules and samples from the file system or from an arbitrary source via the MReader structure.

API functions that may fail come in two flavors: one that throws an exception and one that returns an Either.

The MikMod error callback mechanism and the MWriter are not supported yet.

Quickstart

import Control.Concurrent (threadDelay)
import Control.Monad.Loops (whileM_)
import Sound.MikMod

main = do
  mikmodRegisterAllDrivers
  mikmodRegisterAllLoaders
  mikmodInit ""
  mod <- playerLoad "rock on.mod" 128 NotCurious
  playerStart mod
  whileM_ playerActive $ do
    mikmodUpdate -- might be unnecessary on your system
    threadDelay 100000
  playerFree mod
  mikmodExit

Make sure to link your program to MikMod with -lmikmod. GHCI can be used to experiment by using ghci -lmikmod.

Example of playing sound effects.

import Control.Concurrent (threadDelay)
import Control.Monad.Loops (whileM_)
import Data.Functor ((<$>))
import Sound.MikMod

main = do
  mikmodRegisterAllDrivers
  mikmodRegisterAllLoaders
  mikmodInit ""
  mikmodSetNumVoices (-1) 4
  mikmodEnableOutput
  samp <- sampleLoad "wilhelm.wav"
  Just voice <- samplePlay samp 0
  whileM_ (not <$> voiceStopped voice) $ do
    mikmodUpdate -- might be unnecessary on your system
    threadDelay 100000
  sampleFree samp
  mikmodExit

Or using convenience wrappers for the initialization sequence,

import Control.Concurrent (threadDelay)
import Control.Monad.Loops (whileM_)
import Data.Functor ((<$>))
import Sound.MikMod

main = runMikMod 4 $ do
  samp <- sampleLoad "wilhelm.wav"
  Just voice <- samplePlay samp 0
  whileM_ (not <$> voiceStopped voice) $ do
    mikmodUpdate
    threadDelay 100000
  sampleFree samp

Globals

mikmodSetMusicVolume :: Int -> IO ()

Set the global music volume. The argument must be in the range 0 to 128 (There are 129 volume levels).

mikmodGetMusicVolume :: IO Int

mikmodSetPanSep :: Int -> IO ()

Set the global stereo separation. The argument must be in the range 0 to 128 where 0 means mono sound and 128 means full separation. The default pan sep is 128.

mikmodGetPanSep :: IO Int

mikmodSetReverb :: Int -> IO ()

Set the global reverb. The argument must be in the range 0 to 15 where 0 means no reverb and 15 means extreme reverb. The default reverb is zero.

mikmodGetReverb :: IO Int

mikmodSetSndFXVolume :: Int -> IO ()

Set the global sound effects volume. The argument must be in the range 0 to 128.

mikmodGetSndFXVolume :: IO Int

mikmodSetVolume :: Int -> IO ()

Set the global overall sound volume. The argument must be in the range 0 to 128.

mikmodGetVolume :: IO Int

mikmodSetDeviceIndex :: Int -> IO ()

Change the selected output driver by specifying a 1-based index into the global list of drivers. Setting this to zero, the default, means autodetect. To see the list use mikmodInfoDriver.

mikmodGetDeviceIndex :: IO Int

The selected output driver from the global 1-based list of drivers.

data MDriverInfo

Constructors

MDriverInfo

Fields

mdriverName :: String

mdriverHardVoiceLimit :: Int

mdriverSoftVoiceLimit :: Int

mdriverAlias :: String

Instances

Show MDriverInfo

mikmodGetDriver :: IO (Maybe MDriverInfo)

Get an info report of the sound driver currently in use, if any. MikMod does not expose any functionality via MDriver field manipulation.

mikmodGetMixFreq :: IO Int

mikmodSetMixFreq :: Int -> IO ()

Set the mix frequency measured in Hertz. Higher values mean more sound quality and more CPU usage. Common values are 8000, 11025, 22100, and 44100. The default is 44100.

data DriverModeFlag

Constructors

DMode16Bits

DModeStereo

DModeSoftSndfx

DModeSoftMusic

DModeHQMixer

DModeFloat

DModeSurround

DModeInterp

DModeReverse

DModeSIMDMixer

DModeNoiseReduction

Instances

Eq DriverModeFlag

Show DriverModeFlag

Flag DriverModeFlag

mikmodModifyDriverModeFlags :: ([DriverModeFlag] -> [DriverModeFlag]) -> IO ()

Modify the "mode flags". These flags affect sound output in various ways. For a full explanation of each one see the MikMod docs. Changing DModeInterp, DModeReverse, or DModeSurround will affect playing immediately. The other flags will require a reset. The default flags are set to [DModeStereo, DModeSurround, DMode16Bits, DModeSoftMusic, DModeSoftSndFX].

mikmodGetDriverModeFlags :: IO [DriverModeFlag]

mikmodSetDriverModeFlags :: [DriverModeFlag] -> IO ()

See mikmodModifyDriverModeFlags to avoid clobbering flags you aren't trying to clear.

Core Operations

runMikMod :: Int -> IO a -> IO a

Run an action between mikmodSetup and mikmodExit. It does not handle freeing of Modules or Samples.

mikmodSetup :: Int -> IO ()

Registers all drivers and loaders, initializes MikMod, sets a number of sample voices and enables output.

mikmodGetVersion :: IO (Int, Int, Int)

Get the MikMod version as (major, minor, revision).

mikmodGetError :: IO MikModError

Query the current MikMod global errno and get the MikModError expressed there, if any. This value is only valid if checked immediately after an error occurs. If you are interested in MikModErrors use the "Safe" versions of the API methods which return an Either MikModError.

mikmodRegisterAllDrivers :: IO ()

Register all drivers. Use this before initializing MikMod with mikmodInit.

mikmodRegisterAllLoaders :: IO ()

Register all loaders. Use this before loading any modules.

mikmodInit :: String -> IO ()

Initialize the MikMod system using an initialization string. An empty string is acceptable (see MikMod docs for more info). If initialization fails it will throw a MikModError.

Don't try this until you register a driver which is supported by your system. See mikmodRegisterAllDrivers.

See also the convenience functions mikmodSetup and runMikMod.

mikmodInitSafe :: String -> IO (Either MikModError ())

Same as mikmodInit but doesn't throw exceptions.

mikmodActive :: IO Bool

Returns True if and only if sound output is enabled.

mikmodInfoDriver :: IO (Maybe String)

Get a formatted string describing the available drivers, if any.

mikmodInfoLoader :: IO (Maybe String)

Get a formatted string describing the available loaders, if any.

mikmodSetNumVoices

Arguments

:: Int

Number of music voices or -1

-> Int

Number of sample voices or -1

-> IO ()

Set the number of music voices and sample voices to be used for playback. If either parameter is -1, the currently set value will be retained.

In particular the number of music voices is handled by the module player so probably shouldn't be manipulated. If this operation fails it will throw a MikModError.

mikmodSetNumVoicesSafe :: Int -> Int -> IO (Either MikModError ())

Same as mikmodSetNumVoices but doesn't throw exceptions.

mikmodReset :: String -> IO ()

Reset the driver using the new global variable settings. If the driver has not been initialized, it will be now. Throw a MikModError in case of failure.

mikmodResetSafe :: String -> IO (Either MikModError ())

Same as mikmodReset but doesn't throw exceptions.

mikmodDisableOutput :: IO ()

Disable output.

mikmodEnableOutput :: IO ()

Enable output. Playing modules will enable output automatically. However playing samples does not. Therefore use mikmodEnableOutput if you intend to play sound effects with no music. The convenience function mikmodSetup enables output among other things.

mikmodUpdate :: IO ()

Update the sound. If you don't call this often enough, then sound might drop out. If you call this too often, the audio driver may eat CPU in a busy loop. Higher quality audio requires calling mikmodUpdate more often (see mikmodSetMixFreq). And finally, on some drivers this is a no-op because there is a fill thread.

Known:

• On OSX there is a fill thread and polling mikmodUpdate is unnecessary.
• On Linux ALSA there is no fill thread and polling mikmodUpdate is necessary.

mikmodExit :: IO ()

Shutdown the MikMod system.

Module Player Operations

data CuriousFlag

When loading a module, Curious will cause the loader to attempt to load hidden tracks past the end of the song.

Constructors

Curious

NotCurious

Instances

Eq CuriousFlag

Show CuriousFlag

playerLoad :: FilePath -> Int -> CuriousFlag -> IO ModuleHandle

Load a module from a file. The second argument is the maximum number of channels to allow. If something goes wrong while loading the module it will throw a MikModError.

playerLoadSafe :: FilePath -> Int -> CuriousFlag -> IO (Either MikModError ModuleHandle)

Same as playerLoad but doesn't throw exceptions.

playerLoadGeneric :: MReader -> Int -> CuriousFlag -> IO ModuleHandle

Same as playerLoad but loads the module data from an MReader.

playerLoadGenericSafe :: MReader -> Int -> CuriousFlag -> IO (Either MikModError ModuleHandle)

Same as playerLoadGeneric but doesn't throw exceptions.

playerLoadTitle :: FilePath -> IO (Maybe String)

Load only the title from a module file. Returns Nothing if there is no title. If something goes wrong it will throw a MikModError.

playerStart :: ModuleHandle -> IO ()

Begin playing a module. If another module is already playing it will be stopped.

playerStop :: IO ()

Stop the player.

playerPaused :: IO Bool

Returns True if and only if the player is paused.

playerTogglePause :: IO ()

Pause the player if it isn't paused. Otherwise unpause it.

playerActive :: IO Bool

Returns True if and only if a song is playing.

playerFree :: ModuleHandle -> IO ()

Free a module and all its contents. If the module was playing then it will be stopped. Discard the ModuleHandle after using this operation.

playerGetChannelVoice :: Int -> IO (Maybe Voice)

Returns the voice corresponding to a module channel.

playerGetModule :: IO (Maybe ModuleHandle)

Get the currently playing module, if any.

data MuteOperation

Inclusive or exclusive selection of channels for muting.

Constructors

MuteInclusive

MuteExclusive

Instances

Eq MuteOperation

Show MuteOperation

playerMuteChannel :: Int -> IO ()

Mute a channel.

playerMuteChannels :: MuteOperation -> Int -> Int -> IO ()

Mute a range of channels. MuteOperation determines if the range is inclusive or exclusive.

playerUnmuteChannel :: Int -> IO ()

Unmute the given channel.

playerUnmuteChannels :: MuteOperation -> Int -> Int -> IO ()

Toggle the muting of a range of channels. MuteOperation determines if the range is inclusive or exclusive.

playerToggleMuteChannel :: Int -> IO ()

Toggle the muting of the specified channel.

playerToggleMuteChannels :: MuteOperation -> Int -> Int -> IO ()

Toggle the muting of a range of channels. MuteOperation determines if the range is inclusive or exclusive.

playerMuted :: Int -> IO Bool

Return True if and only if a channel is muted.

playerNextPosition :: IO ()

Skip to the next position in the current module.

playerPrevPosition :: IO ()

Go back to the previous position in the current module.

playerSetPosition :: Int -> IO ()

Set the position of the current module.

playerSetSpeed :: Int -> IO ()

Set the speed of the current module to a value in the range 1 to 32.

playerSetTempo :: Int -> IO ()

Set the tempo of the current module to a value in the range 32 to 255.

Module Operations

type ModuleHandle = Ptr Module

Handle to a Module object which contains the music data and current playback state of a song.

data ModuleInfo

Static info about a module.

Constructors

ModuleInfo

Fields

moduleSongname :: String

moduleModType :: String

moduleComment :: Maybe String

moduleFlags :: [ModuleFlag]

moduleNumChannels :: Int

moduleNumVoices :: Int

moduleNumPositions :: Int

moduleNumPatterns :: Int

moduleNumInstruments :: Int

moduleNumSamples :: Int

moduleInstruments :: Maybe [String]

Instances

Show ModuleInfo

data ModuleFlag

Constructors

UFARPMem

UFBGSlides

UFHighBPM

UFInst

UFLinear

UFNNA

UFNoWrap

UFS3MSlides

UFXMPeriods

UFT2Quirks

UFPanning

Instances

Eq ModuleFlag

Show ModuleFlag

Flag ModuleFlag

getModuleInfo :: ModuleHandle -> IO ModuleInfo

Get a report of the static aspects of a module.

getModuleRealChannels :: ModuleHandle -> IO Int

During playback, the number of active channels (not counting NNA channels).

getModuleTotalChannels :: ModuleHandle -> IO Int

During playback, the total number of channels (including NNA channels).

getModuleSongTime :: ModuleHandle -> IO Integer

Elapsed song time in units of 1/1024 seconds. That's not milliseconds.

getModuleSongPosition :: ModuleHandle -> IO Int

Current song position.

getModulePatternPosition :: ModuleHandle -> IO Int

Current position in the pattern being played.

setModuleInitSpeed :: ModuleHandle -> Int -> IO ()

Set the initial speed of the module. Must be in range 1 - 32.

getModuleInitSpeed :: ModuleHandle -> IO Int

setModuleInitTempo :: ModuleHandle -> Int -> IO ()

Set the initial tempo of the module. Must be in range 32 - 255.

getModuleInitTempo :: ModuleHandle -> IO Int

setModulePanning

Arguments

:: ModuleHandle

-> Int

Channel to set panning on.

-> Int

Pan position from 0 (far left) to 255 (far right).

-> IO ()

Set the pan position of a channel in a module.

getModulePanning :: ModuleHandle -> Int -> IO Int

Query the pan position of a particular channel.

setModuleChannelVolume

Arguments

:: ModuleHandle

-> Int

Channel to set volume on.

-> Int

Volume level from 0 to 128.

-> IO ()

Set the volume of a channel in a module.

getModuleChannelVolume :: ModuleHandle -> Int -> IO Int

Query the volume of a particular channel.

setModuleBPM :: ModuleHandle -> Int -> IO ()

Set the tempo of the module. See playerSetTempo.

getModuleBPM :: ModuleHandle -> IO Int

setModuleSongSpeed :: ModuleHandle -> Int -> IO ()

Set the speed of the module. See playerSetSpeed.

getModuleSongSpeed :: ModuleHandle -> IO Int

setModuleExtSpeed :: ModuleHandle -> Bool -> IO ()

Set the Protracker extended speed effect flag. True means process the effect. Default is True.

getModuleExtSpeed :: ModuleHandle -> IO Bool

setModulePanFlag :: ModuleHandle -> Bool -> IO ()

Set the pan flag. True means process pan effects. Default is True.

getModulePanFlag :: ModuleHandle -> IO Bool

setModuleWrap :: ModuleHandle -> Bool -> IO ()

Set the wrap flag. True means repeat from restart position at end of song. Default is False, song ends.

getModuleWrap :: ModuleHandle -> IO Bool

setModuleRepeatPosition :: ModuleHandle -> Int -> IO ()

Set the restart position.

getModuleRepeatPosition :: ModuleHandle -> IO Int

setModuleLoop :: ModuleHandle -> Bool -> IO ()

Set the loop flag. False means only process forward loops or same-pattern backward loops. Default is True, process all loops.

getModuleLoop :: ModuleHandle -> IO Bool

setModuleFadeout :: ModuleHandle -> Bool -> IO ()

Set the fadeout flag of the module. True means fade out. Default is False.

getModuleFadeout :: ModuleHandle -> IO Bool

setModuleRelativeSpeed :: ModuleHandle -> Int -> IO ()

This value is added to the module tempo to define actual playback speed. Default is zero.

getModuleRelativeSpeed :: ModuleHandle -> IO Int

getModuleSamples :: ModuleHandle -> IO [SampleHandle]

Get handles to the samples contained in a module. I don't think it would be wise to call sampleFree on these samples.

Sample Operations

type SampleHandle = Ptr Sample

data SampleInfo

Static info about a sample.

Constructors

SampleInfo

Fields

samplePanning :: Pan

sampleSpeed :: Int

sampleVolume :: Int

sampleFlags :: [SampleFlag]

sampleInflags :: [SampleFlag]

sampleLength :: Int

sampleLoopStart :: Int

sampleLoopEnd :: Int

Instances

Show SampleInfo

sampleLoad :: FilePath -> IO SampleHandle

Load a sample from a mono, uncompressed RIFF WAV file. If something goes wrong while loading the sample it will throw a MikModError.

sampleLoadSafe :: FilePath -> IO (Either MikModError SampleHandle)

Same as sampleLoad but doesn't throw exceptions.

sampleLoadGeneric :: MReader -> IO SampleHandle

Same as sampleLoad but read sample data from an MReader.

sampleLoadGenericSafe :: MReader -> IO (Either MikModError SampleHandle)

Same as sampleLoadGeneric but doesn't throw exceptions.

samplePlay :: SampleHandle -> Int -> IO (Maybe Voice)

Plays a sound effects sample. Picks a voice from the number of voices allocated for use as sound effects. Returns the voice that the sound is being played on. The oldest playing sample will be interrupted if necessary, unless all playing samples are "critical", in which case the sound will not play.

The second argument is the position, in samples, to start playing from.

samplePlayCritical :: SampleHandle -> Int -> IO (Maybe Voice)

Same behavior as samplePlay except that the voice the sound is played on (if any) is given the "critical" status. Note that this will still not result in any critical samples being interrupted.

sampleFree :: SampleHandle -> IO ()

Free a sample. Do not sampleFree samples aquired via getModuleSamples. Those are freed with playerFree. Discard the SampleHandle after using this operation.

getSampleInfo :: SampleHandle -> IO SampleInfo

Get a report of the current state of a sample.

data Pan

Pan settings.

Constructors

Pan Int

PanSurround

Instances

Eq Pan

Show Pan

panLeft :: Pan

Far left pan. panLeft = Pan 0.

panRight :: Pan

Far right pan. panRight = Pan 255.

setSamplePanning :: SampleHandle -> Pan -> IO ()

Set the panning value of the sample. Valid values range from panLeft (0) to panRight (255), or PanSurround.

getSamplePanning :: SampleHandle -> IO Pan

setSampleSpeed :: SampleHandle -> Int -> IO ()

Set the sample playing frequency in Hertz.

getSampleSpeed :: SampleHandle -> IO Int

setSampleVolume :: SampleHandle -> Int -> IO ()

Set sample volume to a range 0 to 64 (65 levels).

getSampleVolume :: SampleHandle -> IO Int

data SampleFlag

Constructors

SF16Bits

SFBigEndian

SFDelta

SFITPacked

SFSigned

SFStereo

SFBidi

SFLoop

SFReverse

Instances

Eq SampleFlag

Show SampleFlag

Flag SampleFlag

modifySampleFlags :: SampleHandle -> ([SampleFlag] -> [SampleFlag]) -> IO ()

Modify the sample flags. Useful for setting the loop, reverse, and bi-directional playback characteristics of the sample.

getSampleFlags :: SampleHandle -> IO [SampleFlag]

setSampleFlags :: SampleHandle -> [SampleFlag] -> IO ()

See modifySampleFlags to avoid clobbering flags you aren't trying to clear, such as the sample format flags.

getSampleInFlags :: SampleHandle -> IO [SampleFlag]

Query the "on disk" flags of the sample if you're curious about the original format.

getSampleLength :: SampleHandle -> IO Int

Query the length of the sample... in samples.

setSampleLoopStart :: SampleHandle -> Int -> IO ()

Set the loop starting position in samples.

getSampleLoopStart :: SampleHandle -> IO Int

setSampleLoopEnd :: SampleHandle -> Int -> IO ()

Set the loop end position in samples.

getSampleLoopEnd :: SampleHandle -> IO Int

Voice Operations

newtype Voice

MikMod distinguishes module channels from voices. Sound effects and music both work by playing samples on voices. At most one sample can play on a voice at a time. Operations on the voice level take a voice number which you can get using playerGetChannelVoice and samplePlay.

Constructors

Voice

Fields

marshalVoice :: SBYTE

Instances

Eq Voice

Ord Voice

Show Voice

voicePlay :: Voice -> SampleHandle -> Int -> IO ()

Play a sample on the specified voice starting from the specified position in samples. The playing sample will have the same "critical status" as the previous sample played on this voice.

voiceStop :: Voice -> IO ()

Stop a voice from playing.

voiceStopped :: Voice -> IO Bool

Returns True if and only if the specified voice is not playing.

voiceSetVolume :: Voice -> Int -> IO ()

Set a voice's volume to a value in the range 0 to 256. There are 257 volume levels.

voiceGetVolume :: Voice -> IO Int

voiceSetFrequency :: Voice -> Int -> IO ()

Set a voice's frequency in Hertz.

voiceGetFrequency :: Voice -> IO Int

voiceSetPanning :: Voice -> Int -> IO ()

Set a voice's pan position. 0 is far left. 127 is center. 255 is far right.

voiceGetPanning :: Voice -> IO Int

voiceGetPosition :: Voice -> IO Int

Query the position (in samples) of the sample playing on this voice. If no sample is playing it will return zero. On some drivers this operation does not work and will return -1.

voiceRealVolume :: Voice -> IO Int

Compute the "actual playing volume" of the voice. The result will be in the range 0 - 65535. On some drivers this operation does not work and will return zero.

MReaders

data MReader

Collection of IO operations that MikMod can use to load data from an arbitrary source, such as a memory buffer or zip file.

Constructors

MReader

Fields

readerSeek :: Int -> SeekMode -> IO Int

Move the read position. Return 0 for success and -1 for failure.

readerTell :: IO Int

Report the current read position.

readerRead :: Ptr Word8 -> Int -> IO Bool

Write a number of bytes to the destination and advance the read position. Return True if an error occurred or False otherwise. EOF is not an error.

readerGet :: IO Int

Return one byte and advance the read position. If an error occurs or we are at the end-of-stream, then return eof.

readerEof :: IO Bool

Return True if we are at the end of the stream. Otherwise return False.

newByteStringReader :: ByteString -> IO MReader

Create an MReader from a ByteString.

newHandleReader :: Handle -> MReader

Wrap a Handle so it works like an MReader.

eof :: Int

To be returned by a readerGet if called at end-of-stream.

Errors

data MikModError

MikMod reports errors as either critical or not. A critical error means the system state was reset because it could not continue in the face of the error.

Constructors

NonCritical MikModErrno

Critical MikModErrno

Instances

Eq MikModError

Show MikModError

newtype MikModException

Constructors

MikModException MikModError

Instances

Eq MikModException

Show MikModException

Exception MikModException

Typeable * MikModException

describeMikModError :: MikModError -> String

isNotAnError :: MikModError -> Bool

Esoterica

mikmodInitThreads :: IO Bool

If your libmikmod has pthread support, returns True. Otherwise this may initialize internal mutexes to support multi-threaded access anyway. A result of True indicates this was successful. False indicates no support for multi-threaded access is available. It is safe to call this multiple times. Only the first call has any effect.

Short story: Before attempting to use MikMod from multiple threads execute this and check that the result is True.

This only has an effect on Win32, OS/2, and EMX.

withMikMod :: IO a -> IO a

Execute the action after calling MikMod_Lock. Calls MikMod_Unlock afterwards even if an error occurred. If mikmodInitThreads returns True then it means all calls to libmikmod will be protected by internal mutexes. Therefore using MikMod functions inside a withMikMod will deadlock. Allowing clients to manually lock MikMod is probably only useful when manipulating shared data across the API boundary.