QDF_gem.h File Reference

Interface to the GEM decoding routines. More...

#include <LDT/BFU.h>

Typedefs
typedef struct _QDF_gemEvt	QDF_gemEvt
typedef struct _QDF_gemCtx	QDF_gemCtx
typedef struct _QDF_esbEvt	QDF_esbEvt
typedef struct _QSE_ctx	QSE_ctx
typedef struct _QDF_exc	QDF_exc
typedef struct _QFR_fileCtx	QFR_fileCtx
typedef struct _CDF_gemBdy	CDF_gemBdy
typedef struct _EBF_gem	EBF_gem
Functions
int	QDF_gemCtxSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of the GEM decoding context needed to support the specified compression level.
QDF_gemCtx *	QDF_gemCtxConstruct (QDF_gemCtx *ctx, unsigned int level, void *prm, const QSE_ctx *qse)
	Constructs (initializes) the specified GEM decoding context structure.
void	QDF_gemCtxUpdate (QDF_gemCtx *ctx, const QFR_fileCtx *qfr, const CDF_gemBdy *bdy)
	Updates the GEM context. This generally called during the root update phase.
int	QDF_gemEvtSizeof (unsigned int level, void *prm)
	Returns the size, in bytes of QDF GEM event needed to support the specified compression level.
QDF_gemEvt *	QDF_gemEvtConstruct (QDF_gemEvt *evt, unsigned int level, void *prm, QDF_exc *exc, const QDF_esbEvt *esb)
	Constructs (initializes) the specified GEM event structure.
const EBF_gem *	QDF_gemEvtGemGet (const QDF_gemEvt *evt)
	Returns a pointer to the EBF gem structure.
BFU	QDF_gemDecode (QDF_gemCtx *qdf, QDF_gemEvt *gem, const unsigned int *src, unsigned int max, BFU bfu)
	Decodes the GEM.

---

Detailed Description

Interface to the GEM decoding routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: QDF_gem.h,v 1.3 2011/03/27 01:45:43 russell Exp $

---

Function Documentation

QDF_gemCtx* QDF_gemCtxConstruct	(	QDF_gemCtx *	ctx,
		unsigned int	level,
		void *	prm,
		const QSE_ctx *	qse
	)

Constructs (initializes) the specified GEM decoding context structure.

Returns:

Pointer to the context structure to construct

Parameters:

	ctx	The context structure to construct.
	level	The maximum level of compression that will be supported.
	prm	Additional configuation parameter, unused as of now
	qse	Pointer to the public/generic QSE context parameter

References _QDF_gemCtx::min_deadtime, and _QDF_gemCtx::qse.

int QDF_gemCtxSizeof	(	unsigned int	level,
		void *	prm
	)

Returns the size, in bytes of the GEM decoding context needed to support the specified compression level.

Returns:

The size, in bytes, of the GEM decoding context

Parameters:

	level	The maximum level of compression that needs to be supported
	prm	Additional configuation parameter, unused as of now

void QDF_gemCtxUpdate	(	QDF_gemCtx *	ctx,
		const QFR_fileCtx *	qfr,
		const CDF_gemBdy *	bdy
	)

Updates the GEM context. This generally called during the root update phase.

Returns:

Pointer to the context structure to update

Parameters:

	ctx	The context structure to update
	qfr	The file resolution context, unused by the GEM
	bdy	The update information

References _QDF_gemCtx::min_deadtime.

BFU QDF_gemDecode	(	QDF_gemCtx *	qdf,
		QDF_gemEvt *	gem,
		const unsigned int *	src,
		unsigned int	max,
		BFU	bfu
	)

Decodes the GEM.

Returns:

The updated bit position and current deblocked 32-bit buffer

Parameters:

	qdf	The compressed data decoding context
	gem	The GEM block to fill in
	src	The data source, i.e. the bit stream
	max	The maximum bit position
	bfu	The current bit position and temporary buffer

References _QSE_ctxTime::cur, _QDF_gemEvt::ebf, gem_ped_decode(), gem_std_decode(), _QDF_gemCtx::qse, and _QSE_ctx::tim.

QDF_gemEvt* QDF_gemEvtConstruct	(	QDF_gemEvt *	evt,
		unsigned int	level,
		void *	prm,
		QDF_exc *	exc,
		const QDF_esbEvt *	esb
	)

Constructs (initializes) the specified GEM event structure.

Returns:

Pointer to the context structure to construct

Parameters:

	evt	The GEM event structure to construct.
	level	The maximum level of compression that will be supported.
	prm	Additional configuation parameter, unused as of now
	exc	Pointer to the global exception handling context
	esb	Reference pointer to the Event Summary Block

References _QDF_gemEvt::esb, and _QDF_gemEvt::exc.

const EBF_gem* QDF_gemEvtGemGet

(

const QDF_gemEvt *

evt

)

Returns a pointer to the EBF gem structure.

Returns:

Pointer the EBF gem structure

Parameters:

evt

References _QDF_gemEvt::ebf.

Referenced by QDF_acdEvtConstruct(), QDF_calEvtConstruct(), and QDF_dgnEvtConstruct().

int QDF_gemEvtSizeof	(	unsigned int	level,
		void *	prm
	)

Returns the size, in bytes of QDF GEM event needed to support the specified compression level.

Returns:

The size, in bytes, of the GEM event

Parameters:

	level	The maximum level of compression that needs to be supported
	prm	Additional configuation parameter, unused as of now