BASS_MIDI_FontFlags

Modifies and retrieves a soundfont's flags.

DWORD BASS_MIDI_FontFlags(
    HSOUNDFONT handle,
    DWORD flags,
    DWORD mask
);

Parameters

handle

The soundfont handle... 0 = default.

flags

A combination of these flags.

BASS_MIDI_FONT_LINATTMOD	Use a linear attack phase in SF2 modulation (pitch/filter) envelopes. Otherwise a convex curve is used. The attack phase is always linear in SFZ envelopes.
BASS_MIDI_FONT_LINDECVOL	Use linear decay and release phases in volume envelopes. Otherwise a concave curve is used. The attack phase is always linear.
BASS_MIDI_FONT_MINFX	Treat the reverb/chorus levels in the soundfont as minimums. The higher of them and the MIDI levels (CC91/93) will be used instead of the sum of both.
BASS_MIDI_FONT_MMAP	The file is mapped into memory. This cannot be modified.
BASS_MIDI_FONT_NOFX	Ignore the reverb/chorus levels in the soundfont and only use the MIDI levels (CC91/93).
BASS_MIDI_FONT_NORAMPIN	Never ramp-in the start of a sample in the soundfont. Otherwise a sample will be ramped-in if its data does not begin with a 0 (further away results in a longer ramp). This is only relevant when the volume envelope has no attack phase.
BASS_MIDI_FONT_NOSBLIMITS	Do not emulate Creative/SoundBlaster hardware filter and SF2 generator limits. This cannot be modified.
BASS_MIDI_FONT_SBLIMITS	Emulate Creative/SoundBlaster hardware filter and SF2 generator limits. This cannot be modified.
BASS_MIDI_FONT_XGDRUMS	Use bank 127 in the soundfont for XG drum kits. When an XG drum kit is needed, bank 127 in soundfonts that have this flag set will be checked first, before falling back to bank 128 (the standard SF2 drum kit bank) if it is not available there.

mask

The flags (as above) to modify. Flags that are not included in this are left as they are, so it can be set to 0 in order to just retrieve the current flags.

Return value

If successful, the soundfont's updated flags are returned, else -1 is returned. Use BASS_ErrorGetCode to get the error code.

Error codes

BASS_ERROR_HANDLE

handle is not valid.

Remarks

A soundfont will need to be freed (including any duplicates) and reloaded to modify the BASS_MIDI_FONT_SBLIMITS flag because most of the Creative/SoundBlaster hardware limits are applied when loading a soundfont.

A 0 handle can be used to set and retrieve default flags applied to all subsequently loaded soundfonts. This is mostly useful for soundfonts loaded by the BASS_CONFIG_MIDI_DEFFONT and BASS_CONFIG_MIDI_AUTOFONT options. The BASS_MIDI_FONT_MMAP flag is ignored in this case.

Example

Ignore a soundfont's reverb/chorus levels.