SB AWE32 Developer's Information Pack
PART II DOS Real/Protected Mode API
••
23
Copyright
Creative Technology Ltd., 1994-1996
Version 3.00
Points to the SOUND_PACKET data object in which the bank number, the SoundFont
file size, and the memory buffer are specified. awe32SFontLoadRequest assumes SP
is not
NULL
.
Member
Remarks
bank_no
The bank number into which a SoundFont file will be loaded.
data
Points to the buffer where the first PACKETSIZE bytes of
SoundFont file are read.
Return
If successful, awe32SFontLoadRequest returns zero; otherwise, it returns non-zero.
The following fields of SP will filled upon successful return from this API.
Member
Remarks
sample_seek
The offset in the SoundFont bank file where the instrument
samples are stored. The application must seek to this position
before it begins a read and awe32StreamSample loop.
no_sample_packets
The number of packets of PACKETSIZE bytes, each, that
must be read and passed to awe32StreamSample.
preset_seek
The offset in the SoundFont bank file where the preset data are
stored. The application must seek to this position before reading
the preset data.
preset_read_size
This number of bytes the client should read for the presets.
Remarks
The function requires that the entire SoundFont bank header be read into the buffer. In
Real mode libraries, the size of the buffer is 512 bytes. If the size of the header is
larger than 512 bytes, awe32SFontLoadRequest will fail. This could happen with
SoundFont banks created with Vienna SF Studio. It is because Vienna allows users to
insert a comment field in the header. If the field is long, the could be larger than 512
bytes. Please restrict the comment field to less than 128 characters long.
awe32StreamSample
WORD
PASCAL
awe32StreamSample(SOUND_PACKET FAR* SP)
Action
For each call, awe32StreamSample loads one packet of SoundFont bank instrument
samples into a bank. awe32SFontLoadRequest must be used before calling
awe32StreamSample.
Parameters
SP
Points to the SOUND_PACKET in which the bank number, the size of the SoundFont
file, and the memory buffer are specified. awe32StreamSample assumes SP is not
NULL.
Member
Remarks
bank_no
The bank number into which a SoundFont file will be loaded.
data
Points to the buffer that contains PACKETSIZE bytes of
SoundFont data.
Return
If successful, awe32StreamSample returns zero; otherwise, it returns non-zero.
