bfstm.h File Reference

Stream file init. More...

#include <pulsar/archive/archive.h>
#include <pulsar/bfstm/bfstm_internal.h>

Go to the source code of this file.

Data Structures
struct	PLSR_BFSTM
	Stream file. More...

Enumerations
enum	PLSR_BFSTMCategoryType {   PLSR_BFSTMCategoryType_Init = 0,   PLSR_BFSTMCategoryType_Info,   PLSR_BFSTMCategoryType_Channel }
	Stream file method categories.
enum	PLSR_BFSTMFormat {   PLSR_BFSTMFormat_PCM_8 = 0,   PLSR_BFSTMFormat_PCM_16 = 1,   PLSR_BFSTMFormat_DSP_ADPCM = 2 }
	Stream file sample formats. More...

Functions
PLSR_RC	plsrBFSTMOpen (const char *path, PLSR_BFSTM *out)
	Open from a file at specified path. More...
PLSR_RC	plsrBFSTMOpenInside (const PLSR_Archive *ar, u32 offset, PLSR_BFSTM *out)
	Open from inside another archive at specified offset. More...
void	plsrBFSTMClose (PLSR_BFSTM *bfstm)
	Close archive, releasing resources if applicable. More...

Detailed Description

Stream file init.

Enumeration Type Documentation

PLSR_BFSTMFormat

enum PLSR_BFSTMFormat

Stream file sample formats.

Enumerator
PLSR_BFSTMFormat_PCM_8	8-bit PCM encoded samples
PLSR_BFSTMFormat_PCM_16	16-bit PCM encoded samples
PLSR_BFSTMFormat_DSP_ADPCM	DSP ADPCM encoded samples (Wave channel info should contain the needed adpcm context to decode samples, see plsrBFWAVReadChannelInfo())

Function Documentation

plsrBFSTMClose()

void plsrBFSTMClose

(

PLSR_BFSTM *

bfstm

)

Close archive, releasing resources if applicable.

plsrBFSTMOpen()

PLSR_RC plsrBFSTMOpen	(	const char *	path,
		PLSR_BFSTM *	out
	)

Open from a file at specified path.

Note

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

plsrBFSTMOpenInside()

PLSR_RC plsrBFSTMOpenInside	(	const PLSR_Archive *	ar,
		u32	offset,
		PLSR_BFSTM *	out
	)

Open from inside another archive at specified offset.