Miles Sound System SDK 7.2a

AIL_DLS_load_memory

The function AIL_DLS_load_memory loads an uncompressed DLS file memory image into the specified DLS device.

HDLSFILEID AIL_DLS_load_memory(
  HDLSDEVICE dls,
  void const * memory,
  U32 flags
);

In Parameters

dls: indicates the DLS device to load the DLS data into.
memory: is the address of the in-memory DLS file image.
flags: should currently be zero.

Returns

A handle to a DLS file ID that can be used to unload the DLS data with the AIL_DLS_unload function, or NULL if the load was unsuccessful.

Discussion

Early releases of the Sonic Vibes DLS provider DLL did not support this function, so with older versions of the DLL, MSS will copy the entire supplied image out to a disk file and then call the AIL_DLS_load_file function. The latest S3 loader DLL can be found in the WINTOOLS subdirectory.

The Aureal Vortex DLS support has problems with from-memory loading, so MSS emulates this function by copying your memory image to a temporary file and then instructs the Aureal driver load from this temporary file. This means DLS from memory loading is a little slow with the Vortex driver.

You must not free the memory passed to AIL_DLS_load_memory unless the DLS device has been closed or the file ID has been unloaded first.

This function only accepts uncompressed DLS files. If you have a compressed MLS file to load, use the AIL_extract_DLS function to get a DLS memory image and then load it with this function. You can use the AIL_file_type function to see what type of DLS file you have.

To load a DLS file that has been embedded in an XMI file, you can use the AIL_find_DLS function for uncompressed embedded DLS data, or the AIL_extract_DLS function for compressed embedded DLS data. You can use the AIL_file_type function to see what type of XMI file you have.

The software synthesizer will continue to use sample memory from the DLS file until the DLS device is closed, or the file ID is unloaded with the AIL_DLS_unload function.

The AIL_DLS_load_memory function will always replace the existing DLS data when two DLS files specify duplicate instrument and note parameters.

Group: DLS Services
Related Functions: AIL_DLS_compact, AIL_DLS_load_file, AIL_DLS_load_memory, AIL_DLS_unload, AIL_extract_DLS, AIL_file_type, AIL_find_DLS
Related Basic Types: HDLSDEVICE, HDLSFILEID, U32, void const *
Related FAQs: How do I play an XMIDI file with a DLS instrument set?