bfwav.h File Reference

Wave file init. More...

#include <pulsar/archive/archive.h>
#include <pulsar/bfwav/bfwav_internal.h>

Go to the source code of this file.

Data Structures
struct	PLSR_BFWAV
	Wave file. More...

Enumerations
enum	PLSR_BFWAVCategoryType {   PLSR_BFWAVCategoryType_Init = 0,   PLSR_BFWAVCategoryType_Info,   PLSR_BFWAVCategoryType_Data }
	Wave file method categories.
enum	PLSR_BFWAVFormat {   PLSR_BFWAVFormat_PCM_8 = 0,   PLSR_BFWAVFormat_PCM_16 = 1,   PLSR_BFWAVFormat_DSP_ADPCM = 2 }
	Wave file sample formats. More...

Functions
PLSR_RC	plsrBFWAVOpen (const char *path, PLSR_BFWAV *out)
	Open from a file at specified path. More...
PLSR_RC	plsrBFWAVOpenInside (const PLSR_Archive *ar, u32 offset, PLSR_BFWAV *out)
	Open from inside another archive at specified offset. More...
void	plsrBFWAVClose (PLSR_BFWAV *bfwav)
	Close archive, releasing resources if applicable. More...

Detailed Description

Wave file init.

Enumeration Type Documentation

PLSR_BFWAVFormat

enum PLSR_BFWAVFormat

Wave file sample formats.

Enumerator
PLSR_BFWAVFormat_PCM_8	8-bit PCM encoded samples
PLSR_BFWAVFormat_PCM_16	16-bit PCM encoded samples
PLSR_BFWAVFormat_DSP_ADPCM	DSP ADPCM encoded samples (Wave channel info should contain the needed ADPCM context to decode samples, see plsrBFWAVReadChannelInfo())

Function Documentation

plsrBFWAVClose()

void plsrBFWAVClose

(

PLSR_BFWAV *

bfwav

)

Close archive, releasing resources if applicable.

plsrBFWAVOpen()

PLSR_RC plsrBFWAVOpen	(	const char *	path,
		PLSR_BFWAV *	out
	)

Open from a file at specified path.

Note

Path is not stored by default unless specified using plsrArchiveOpenEx()

plsrBFWAVOpenInside()

PLSR_RC plsrBFWAVOpenInside	(	const PLSR_Archive *	ar,
		u32	offset,
		PLSR_BFWAV *	out
	)

Open from inside another archive at specified offset.