WildMidi_SetOption man page

WildMidi_SetOption — Set a library option for a specific midi

Library

libWildMidi

Synopsis

#include <wildmidi_lib.h>

int WildMidi_SetOption (midi *handle, uint16_t options, uint16_t setting)

Description

Set a library option for a specific midi.

handle
The identifier obtained from opening a midi file with WildMidi_Open(3) or WildMidi_OpenBuffer(3)

options The option or options you wish to change.

WM_MO_LOG_VOLUME
By default the library uses linear volume levels typically used in computer MIDI players. These can differ somewhat to volume levels found on some midi hardware which may use a volume curve based on decibels. This option sets the volume levels to what you'd expect on such devices.
WM_MO_ENHANCED_RESAMPLING
By default libWildMidi uses linear interpolation for the resampling of the sound samples. Setting this option enables the library to use a resampling method that attempts to fill in the gaps giving richer sound.
WM_MO_REVERB
libWildMidi has an 8 reflection reverb engine. Use this option to give more depth to the output.
WM_MO_LOOP
Makes libWildMidi to automatically rewind when it reaches the end, so the file would play in continuous loop.
WM_MO_STRIPSILENCE
Strips silence at song start.
WM_MO_SAVEASTYPE0
This option tells WildMidi_GetMidiOutput(3) to output type-0 format data for type-2 files.
WM_MO_TEXTASLYRIC
Some files have the lyrics in the text meta event. This option reads lyrics from there instead.
setting
To turn on an option, repeat that option here. To turn off an option, do not put the option here.
Example: To turn on Reverb
WildMidi_SetOption(handle, WM_MO_REVERB, WM_MO_REVERB);
Example: To turn off Reverb
WildMidi_SetOption(handle, WM_MO_REVERB, 0);
Example: To turn on Reverb and Enhanced Resampling
WildMidi_SetOption(handle, (WM_MO_REVERB | WM_MO_ENHANCED_RESAMPLING), (WM_MO_REVERB | WM_MO_ENHANCED_RESAMPLING));

Return Value

Returns -1 on error, otherwise returns 0.

See Also

WildMidi_GetVersion(3), WildMidi_Init(3), WildMidi_MasterVolume(3), WildMidi_Open(3), WildMidi_OpenBuffer(3), WildMidi_SetOption(3), WildMidi_GetOutput(3), WildMidi_GetMidiOutput(3), WildMidi_GetInfo(3), WildMidi_FastSeek(3), WildMidi_Close(3), WildMidi_Shutdown(3), wildmidi.cfg(5)

Author

Chris Ison <chrisisonwildcode@gmail.com> Bret Curtis <psi29a@gmail.com>

Referenced By

WildMidi_ClearError(3), WildMidi_Close(3), WildMidi_ConvertBufferToMidi(3), WildMidi_ConvertToMidi(3), WildMidi_FastSeek(3), WildMidi_GetError(3), WildMidi_GetInfo(3), WildMidi_GetLyric(3), WildMidi_GetMidiOutput(3), WildMidi_GetOutput(3), WildMidi_GetString(3), WildMidi_GetVersion(3), WildMidi_Init(3), WildMidi_MasterVolume(3), WildMidi_Open(3), WildMidi_OpenBuffer(3), WildMidi_Shutdown(3), WildMidi_SongSeek(3).

10 March 2016 WildMidi Programmer's Manual