diff options
Diffstat (limited to 'sound/voc.h')
| -rw-r--r-- | sound/voc.h | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/sound/voc.h b/sound/voc.h index a62b785e3b..59ddc305ec 100644 --- a/sound/voc.h +++ b/sound/voc.h @@ -64,9 +64,21 @@ struct VocBlockHeader { */ extern int getSampleRateFromVOCRate(int vocSR); -//extern byte *loadVOCFromStream(Common::ReadStream &stream, int &size, int &rate, int &loops, int &begin_loop, int &end_loop); +/** + * Try to load a VOC from the given seekable stream. Returns a pointer to memory + * containing the PCM sample data (allocated with malloc). It is the callers + * responsibility to dellocate that data again later on! Currently this + * function only supports uncompressed raw PCM data. + */ extern byte *loadVOCFromStream(Common::ReadStream &stream, int &size, int &rate); +/** + * Try to load a VOC from the given seekable stream and create an AudioStream + * from that data. Currently this function only supports uncompressed raw PCM + * data. Looping is not supported. + * + * This function uses loadVOCFromStream() internally. + */ AudioStream *makeVOCStream(Common::ReadStream &stream); #endif |