BASS_MIDI_StreamCreateFileUser
Creates a sample stream from a MIDI file via user callback functions.
HSTREAM BASS_MIDI_StreamCreateFileUser(
DWORD system,
DWORD flags,
BASS_FILEPROCS *procs,
void *user,
DWORD freq
);
Parameters
system | File system to use, which must be STREAMFILE_NOBUFFER, as the entire MIDI file is preloaded.
|
flags | Any combination of these flags.
BASS_SAMPLE_8BITS | Use 8-bit resolution. If neither this or the BASS_SAMPLE_FLOAT flags are specified, then the sample data will be 16-bit.
| BASS_SAMPLE_FLOAT | Use 32-bit floating-point sample data. See Floating-point channels for more info.
| BASS_SAMPLE_MONO | Decode/play the MIDI in mono (uses less CPU than stereo). This flag is automatically applied if BASS_DEVICE_MONO was specified when calling BASS_Init.
| BASS_SAMPLE_SOFTWARE | Force the stream to not use hardware mixing.
| BASS_SAMPLE_3D | Enable 3D functionality. This requires that the BASS_DEVICE_3D flag was specified when calling BASS_Init. 3D channels must also be mono, so BASS_SAMPLE_MONO is automatically applied. The SPEAKER flags cannot be used together with this flag.
| BASS_SAMPLE_LOOP | Loop the file. This flag can be toggled at any time using BASS_ChannelFlags.
| BASS_SAMPLE_FX | Enable the old implementation of DirectX 8 effects. See the DX8 effect implementations section for details. Use BASS_ChannelSetFX to add effects to the stream.
| BASS_STREAM_AUTOFREE | Automatically free the stream when playback ends.
| BASS_STREAM_DECODE | Decode/render the sample data, without playing it. Use BASS_ChannelGetData to retrieve decoded sample data. The BASS_SAMPLE_3D, BASS_STREAM_AUTOFREE and SPEAKER flags cannot be used together with this flag. The BASS_SAMPLE_SOFTWARE and BASS_SAMPLE_FX flags are also ignored.
| BASS_SPEAKER_xxx | Speaker assignment flags. The BASS_SAMPLE_MONO flag is automatically applied when using a mono speaker assignment flag.
| BASS_MIDI_DECAYEND | Let the sound decay naturally (including reverb) instead of stopping abruptly at the end of the file, including when looping. This flag can be toggled at any time using BASS_ChannelFlags.
| BASS_MIDI_DECAYSEEK | Let the old sound decay naturally (including reverb) when changing the position, including looping. This flag can be toggled at any time using BASS_ChannelFlags, but it should generally only be used in BASS_ChannelSetPosition calls to have it applied to particular position changes, eg. custom loops.
| BASS_MIDI_NOCROP | Do not remove empty space (containing no events) from the end of the file.
| BASS_MIDI_NOFX | Disable reverb and chorus processing, saving some CPU time. This flag can be toggled at any time using BASS_ChannelFlags.
| BASS_MIDI_NOSYSRESET | Ignore system reset events (MIDI_EVENT_SYSTEM) when the system mode is unchanged. This flag can be toggled at any time using BASS_ChannelFlags.
| BASS_MIDI_NOTEOFF1 | Only release the oldest instance upon a note off event (MIDI_EVENT_NOTE with velocity=0) when there are overlapping instances of the note. Otherwise all instances are released. This flag can be toggled at any time using BASS_ChannelFlags.
| BASS_MIDI_SINCINTER | Use sinc interpolated sample mixing. This increases the sound quality, but also requires more CPU. Otherwise linear interpolation is used. The sinc interpolation uses 8 points by default, but 16 point sinc interpolation is also available via the BASS_ATTRIB_MIDI_SRC attribute.
|
|
procs | The user defined file functions.
|
user | User instance data to pass to the callback functions.
|
freq | Sample rate to render/play the MIDI stream at... 0 = the rate specified in the BASS_Init call, 1 = the device's current output rate (or the BASS_Init rate if that is not available).
|
Return value
If successful, the new stream's handle is returned, else 0 is returned. Use
BASS_ErrorGetCode to get the error code.
Error codes
BASS_ERROR_INIT | BASS_Init has not been successfully called.
|
BASS_ERROR_NOTAVAIL | Only decoding channels (BASS_STREAM_DECODE) are allowed when using the "no sound" device. The BASS_STREAM_AUTOFREE flag is also unavailable to decoding channels.
|
BASS_ERROR_ILLPARAM | system is not valid.
|
BASS_ERROR_FILEFORM | The file's format is not recognised/supported.
|
BASS_ERROR_FORMAT | The sample format is not supported by the device/drivers. If the stream is more than stereo or the BASS_SAMPLE_FLOAT flag is used, it could be that they are not supported.
|
BASS_ERROR_SPEAKER | The specified SPEAKER flags are invalid. The device/drivers do not support them or 3D functionality is enabled.
|
BASS_ERROR_MEM | There is insufficient memory.
|
BASS_ERROR_NO3D | Could not initialize 3D support.
|
BASS_ERROR_UNKNOWN | Some other mystery problem!
|
Remarks
As there is no file associated with a user file stream, it is not possible for BASSMIDI to look for a soundfont with the same name as the MIDI file. If there is a matching soundfont, it can be applied using
BASS_MIDI_StreamSetFonts.
Platform-specific
Away from Windows, all mixing is done in software (by BASS), so the BASS_SAMPLE_SOFTWARE flag is unnecessary. The BASS_SAMPLE_FX flag is also ignored. On Android and iOS, sinc interpolation requires a NEON-supporting CPU; the BASS_MIDI_SINCINTER flag will otherwise be ignored. Sinc interpolation is not available on Windows CE.
See also
BASS_MIDI_StreamCreate,
BASS_MIDI_StreamCreateEvents,
BASS_MIDI_StreamCreateFile,
BASS_MIDI_StreamCreateURL,
BASS_MIDI_StreamGetChannel,
BASS_MIDI_StreamGetMark,
BASS_MIDI_StreamLoadSamples,
BASS_MIDI_StreamSetFonts,
BASS_ATTRIB_MIDI_CPU,
BASS_ATTRIB_MIDI_SRC,
BASS_CONFIG_MIDI_DEFFONT,
BASS_CONFIG_MIDI_VOICES
BASS_ChannelGetInfo, BASS_ChannelGetLength, BASS_ChannelGetTags, BASS_ChannelPlay, BASS_ChannelSetAttribute, BASS_ChannelSetDSP, BASS_ChannelSetFX, BASS_ChannelSetLink, BASS_StreamFree, BASS_FILEPROCS structure