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

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.

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.

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

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

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.

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

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

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.

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].

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

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

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

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

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.

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

Register all loaders. Use this before loading any modules.

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.

Same as mikmodInit but doesn't throw exceptions.

Returns True if and only if sound output is enabled.

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

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

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.

This is executed by playerLoad as a side effect of loading a module to set the number of music voices.

If this operation fails it will throw a MikModError.

Same as mikmodSetNumVoices but doesn't throw exceptions.

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

Same as mikmodReset but doesn't throw exceptions.

Disable output.

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.

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 an audio callback.

Known:

• On OSX there is an audio callback and polling mikmodUpdate is unnecessary.
• On Linux mikmodUpdate triggers ALSA's non-blocking IO API and is necessary.

Shutdown the MikMod system.

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

Load a module from a file.

The second argument is the maximum number of channels to allow. Basic 4 channel mods only need 4 music voices. But some impulse tracker modules use a large number of extra channels for new note actions (NNAs). Only the amount needed will be allocated so using a large value here like 64 doesn't hurt.

This operation has side effects. When the module is loaded the number of music voices will be adjusted (see mikmodSetNumVoices) to accommodate the song. If a song is already playing that needs more voices than the song being loaded, you will hear a reduction in music quality! If want to load many ModuleHandles then use mikmodSetNumVoices afterward to set the number of music voices to some upper bound for the group.

If something goes wrong while loading the module it will throw a MikModError.

Same as playerLoad but doesn't throw exceptions.

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

Same as playerLoadGeneric but doesn't throw exceptions.

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

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

Stop the player.

Returns True if and only if the player is paused.

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

Returns True if and only if a song is playing.

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

Returns the voice corresponding to a module channel.

Get the currently playing module, if any.

Inclusive or exclusive selection of channels for muting.

Mute a channel.

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

Unmute the given channel.

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

Toggle the muting of the specified channel.

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

Return True if and only if a channel is muted.

Skip to the next position in the current module.

Go back to the previous position in the current module.

Set the position of the current module.

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

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

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

Static info about a module.

Get a report of the static aspects of a module.

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

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

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

Current song position.

Current position in the pattern being played.

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

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

Set the pan position of a channel in a module.

Query the pan position of a particular channel.

Set the volume of a channel in a module.

Query the volume of a particular channel.

Set the tempo of the module. See playerSetTempo.

Set the speed of the module. See playerSetSpeed.

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

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

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

Set the restart position.

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

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

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

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

Static info about a sample.

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

Same as sampleLoad but doesn't throw exceptions.

Same as sampleLoad but read sample data from an MReader.

Same as sampleLoadGeneric but doesn't throw exceptions.

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.

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.

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

Get a report of the current state of a sample.

Pan settings.

Far left pan. panLeft = Pan 0.

Far right pan. panRight = Pan 255.

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

Set the sample playing frequency in Hertz.

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

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

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

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

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

Set the loop starting position in samples.

Set the loop end position in samples.

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.

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.

Stop a voice from playing.

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

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

Set a voice's frequency in Hertz.

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

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.

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.

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

Used for the very undescriptive possible outcomes of a readerSeek.

The result of a readerEof call.

Make an MReader from a ByteString and a mutable variable for the read position.

Wrap a Handle so it works like an MReader.

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.

The possible things to be found in MikMod_errno

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.

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.