lss::CVorbisCodeBook Class Reference

Basic shared codebook operations. More...

#include <LSSVorbisCodeBook.h>

List of all members.

Classes
struct	codebook
struct	static_codebook
Public Types
typedef struct lss::CVorbisCodeBook::static_codebook *	LPstatic_codebook
typedef struct lss::CVorbisCodeBook::static_codebook	LPCstatic_codebook
typedef struct lss::CVorbisCodeBook::codebook *	LPcodebook
typedef struct lss::CVorbisCodeBook::codebook	LPCcodebook
Static Public Member Functions
static LSVOID	vorbis_staticbook_destroy (static_codebook *_pscbB)
static LSINT32	vorbis_book_init_encode (codebook *_pcbDest, const static_codebook *_pscbSource)
static LSINT32	vorbis_book_init_decode (codebook *_pcbDest, const static_codebook *_pscbSource)
static LSVOID	vorbis_book_clear (codebook *_pcbB)
static LSFLOAT *	_book_unquantize (const static_codebook *_pscbSource, LSINT32 _i32N, LSINT32 *_pi32Map)
static LSFLOAT	_float32_unpack (LSINT32 _i32Val)
static LSINT32	_float32_pack (LSFLOAT _i32Val)
static LSINT32	_ilog (LSUINT32 _i32V)
static LSINT32	_book_maptype1_quantvals (const static_codebook *_pscbB)
static LSINT32	vorbis_book_codeword (codebook *_pcbBook, LSINT32 _i32Entry)
static LSINT32	vorbis_book_codelen (codebook *_pcbBook, LSINT32 _i32Entry)
static LSINT32	vorbis_staticbook_pack (const static_codebook *_pscbC, COgg::oggpack_buffer *_ppbB)
static static_codebook *	vorbis_staticbook_unpack (COgg::oggpack_buffer *_ppbB)
static LSINT32	vorbis_book_encode (codebook *_pcbBook, LSINT32 _fA, COgg::oggpack_buffer *_ppbB)
static LSINT32	vorbis_book_decode (codebook *_pcbBook, COgg::oggpack_buffer *_ppbB)
static LSINT32	vorbis_book_decodevs_add (codebook *_pcbBook, LSFLOAT *_pfA, COgg::oggpack_buffer *_ppbB, LSINT32 _i32N)
static LSINT32	vorbis_book_decodev_set (codebook *_pcbBook, LSFLOAT *_pfA, COgg::oggpack_buffer *_ppbB, LSINT32 _i32N)
static LSINT32	vorbis_book_decodev_add (codebook *_pcbBook, LSFLOAT *_pfA, COgg::oggpack_buffer *_ppbB, LSINT32 _i32N)
static LSINT32	vorbis_book_decodevv_add (codebook *_pcbBook, LSFLOAT **_ppfA, LSINT32 _i32Off, LSINT32 _i32Ch, COgg::oggpack_buffer *_ppbB, LSINT32 _i32N)
Static Protected Member Functions
static LSUINT32 *	_make_words (LSINT32 *_pi32L, LSINT32 _i32N, LSINT32 _i32SparseCount)
static LSUINT32	bitreverse (LSUINT32 _ui32X)
static LSINT32 LSE_CCALL	sort32a (LSVOID *_pvContext, const LSVOID *_pvA, const LSVOID *_pvB)
static LSINT32	decode_packed_entry_number (codebook *_pcbBook, COgg::oggpack_buffer *_ppbB)

---

Detailed Description

Basic shared codebook operations.

Class CVorbisCodeBook Description: Basic shared codebook operations.

---

Member Typedef Documentation

typedef struct lss::CVorbisCodeBook::static_codebook * lss::CVorbisCodeBook::LPstatic_codebook

This structure encapsulates huffman and VQ style encoding books; it doesn't do anything specific to either.

Valuelist/quantlist are nonNULL (and q_* significant) only if there's entry->value mapping to be done.

If encode-side mapping must be done (and thus the entry needs to be hunted), the auxiliary encode pointer will point to a decision tree. This is true of both VQ and huffman, but is mostly useful with VQ.

---

Member Function Documentation

static LSINT32 lss::CVorbisCodeBook::_book_maptype1_quantvals

(

const static_codebook *

_pscbB

)

[static]

Undocumented function from the Vorbis library.

Parameters:

_pscbB

Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSFLOAT* lss::CVorbisCodeBook::_book_unquantize	(	const static_codebook *	_pscbSource,
		LSINT32	_i32N,
		LSINT32 *	_pi32Map
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pscbSource	Undocumented parameter from the Vorbis library.
_i32N	Undocumented parameter from the Vorbis library.
_pi32Map	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::_float32_pack

(

LSFLOAT

_i32Val

)

[static]

Undocumented function from the Vorbis library.

Parameters:

_i32Val

Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSFLOAT lss::CVorbisCodeBook::_float32_unpack

(

LSINT32

_i32Val

)

[static]

Undocumented function from the Vorbis library.

Parameters:

_pscbB	Undocumented parameter from the Vorbis library.
_pfVals	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library. Undocumented function from the Vorbis library.

Parameters:

_i32Val

Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::_ilog

(

LSUINT32

_i32V

)

[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_pfA	Undocumented parameter from the Vorbis library.
_i32Step	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library. Undocumented function from the Vorbis library.

Parameters:

_i32V

Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSUINT32* lss::CVorbisCodeBook::_make_words	(	LSINT32 *	_pi32L,
		LSINT32	_i32N,
		LSINT32	_i32SparseCount
	)		[static, protected]

Undocumented function from the Vorbis library.

Parameters:

_pi32L	Undocumented parameter from the Vorbis library.
_i32N	Undocumented parameter from the Vorbis library.
_i32SparseCount	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSUINT32 lss::CVorbisCodeBook::bitreverse

(

LSUINT32

_ui32X

)

[static, protected]

Undocumented function from the Vorbis library.

Parameters:

_ui32X

Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::decode_packed_entry_number	(	codebook *	_pcbBook,
		COgg::oggpack_buffer *	_ppbB
	)		[static, protected]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_ppbB	Undocumented parameter from the Vor_pvBis li_pvBrary.

Returns:

Undocumented return from the Vor_pvBis li_pvBrary.

static LSINT32 LSE_CCALL lss::CVorbisCodeBook::sort32a	(	LSVOID *	_pvContext,
		const LSVOID *	_pvA,
		const LSVOID *	_pvB
	)		[static, protected]

Undocumented function from the Vorbis library.

Parameters:

_pvContext	Unused.
_pvA	Undocumented parameter from the Vorbis library.
_pvB	Undocumented parameter from the Vor_pvBis li_pvBrary.

Returns:

Undocumented return from the Vor_pvBis li_pvBrary.

static LSVOID lss::CVorbisCodeBook::vorbis_book_clear

(

codebook *

_pcbB

)

[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbB

Undocumented parameter from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_codelen	(	codebook *	_pcbBook,
		LSINT32	_i32Entry
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_i32Entry	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_codeword	(	codebook *	_pcbBook,
		LSINT32	_i32Entry
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_pfA	Undocumented parameter from the Vorbis library.
step	Undocumented parameter from the Vorbis library.
_i32AddMul	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library. Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_i32Entry	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_decode	(	codebook *	_pcbBook,
		COgg::oggpack_buffer *	_ppbB
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_ppbB	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_decodev_add	(	codebook *	_pcbBook,
		LSFLOAT *	_pfA,
		COgg::oggpack_buffer *	_ppbB,
		LSINT32	_i32N
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_pfA	Undocumented parameter from the Vorbis library.
_ppbB	Undocumented parameter from the Vorbis library.
_i32N	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_decodev_set	(	codebook *	_pcbBook,
		LSFLOAT *	_pfA,
		COgg::oggpack_buffer *	_ppbB,
		LSINT32	_i32N
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_pfA	Undocumented parameter from the Vorbis library.
_ppbB	Undocumented parameter from the Vorbis library.
_i32N	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_decodevs_add	(	codebook *	_pcbBook,
		LSFLOAT *	_pfA,
		COgg::oggpack_buffer *	_ppbB,
		LSINT32	_i32N
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_pfA	Undocumented parameter from the Vorbis library.
_ppbB	Undocumented parameter from the Vorbis library.
_i32N	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_decodevv_add	(	codebook *	_pcbBook,
		LSFLOAT **	_ppfA,
		LSINT32	_i32Off,
		LSINT32	_i32Ch,
		COgg::oggpack_buffer *	_ppbB,
		LSINT32	_i32N
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_ppfA	Undocumented parameter from the Vorbis library.
_i32Off	Undocumented parameter from the Vorbis library.
_i32Ch	Undocumented parameter from the Vorbis library.
_ppbB	Undocumented parameter from the Vorbis library.
_i32N	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_encode	(	codebook *	_pcbBook,
		LSINT32	_fA,
		COgg::oggpack_buffer *	_ppbB
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbBook	Undocumented parameter from the Vorbis library.
_fA	Undocumented parameter from the Vorbis library.
_ppbB	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_init_decode	(	codebook *	_pcbDest,
		const static_codebook *	_pscbSource
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbDest	Undocumented parameter from the Vorbis library.
_pscbSource	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_book_init_encode	(	codebook *	_pcbDest,
		const static_codebook *	_pscbSource
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pcbDest	Undocumented parameter from the Vorbis library.
_pscbSource	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static LSVOID lss::CVorbisCodeBook::vorbis_staticbook_destroy

(

static_codebook *

_pscbB

)

[static]

Undocumented function from the Vorbis library.

Parameters:

_pscbB

Undocumented parameter from the Vorbis library.

static LSINT32 lss::CVorbisCodeBook::vorbis_staticbook_pack	(	const static_codebook *	_pscbC,
		COgg::oggpack_buffer *	_ppbB
	)		[static]

Undocumented function from the Vorbis library.

Parameters:

_pscbC	Undocumented parameter from the Vorbis library.
_ppbB	Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

static static_codebook* lss::CVorbisCodeBook::vorbis_staticbook_unpack

(

COgg::oggpack_buffer *

_ppbB

)

[static]

Undocumented function from the Vorbis library.

Parameters:

_ppbB

Undocumented parameter from the Vorbis library.

Returns:

Undocumented return from the Vorbis library.

---

The documentation for this class was generated from the following file:

• F:/My Projects/LSEngine/Modules/LSSoundLib/Src/Ogg/LSSVorbisCodeBook.h