---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > QSEC / V3-0-2

Constituent: qsec     Tag: sun-gcc

---

         

---

decompress.h File Reference

Lowest-level decompression routines. More...

#include "LDT/APD.h"
#include <stdlib.h>
#include <stdio.h>

Include dependency graph for decompress.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef QSEC_decompression_	QSEC_decompression
	Declaration of the opaque decompression structure.
Functions
void	QSEC_clearDecompression (QSEC_decompression *dcm)
	Clear the decompression structrure of any data from a previous cycle.
QSEC_decompression *	QSEC_constructDecompression (void *buffer, unsigned int nbits, const char *name)
	Initialise the buffer as a decompression structure.
unsigned	QSEC_decompress (QSEC_decompression *dcm, APD_dtx *dtx)
	Decode the next symbol.
void	QSEC_deleteDecompression (QSEC_decompression *dcm)
	Free the memory associated with the decompression structure.
unsigned int	QSEC_getCount (QSEC_decompression *dcm)
	Return the number of non-zero bins in the histogram.
QSEC_decompression *	QSEC_newDecompression (unsigned int nbits, const char *name)
	Allocate and initialise a new decompression structure.
void	QSEC_reportDecompression (QSEC_decompression *dcm, FILE *fp)
	Describe the contents of the decompression structure in formatted ASCII send to the file fp.
size_t	QSEC_sizeofDecompression (unsigned int nbits)
	Calculate the total size required to accomodate a decompression structure.
const unsigned int *	QSEC_unpack (QSEC_decompression *dcm, const unsigned int *buf)
	Build the lookup and freqency tables by retrieving and unpacking data from the consignment.

---

Detailed Description

Lowest-level decompression routines.

Author:

James Swain & Owen Saxton

Id

decompress.h,v 1.2 2007/04/05 22:59:55 saxton Exp

---

Function Documentation

void QSEC_clearDecompression (  QSEC_decompression *  dcm  )

Clear the decompression structrure of any data from a previous cycle. Parameters: dcm  Pointer to an allocated, initialised, decompression structure

QSEC_decompression* QSEC_constructDecompression (  void *  buffer, unsigned int  nbits, const char *  name )

Initialise the buffer as a decompression structure. Parameters: buffer  Pointer to the uninitialised memory to use for this decompression structure nbits  Number of bits in the symbols to be handled by this decompression strcuture name  String identifying this structure Returns: Pointer to an initialised decompression structure

unsigned QSEC_decompress (  QSEC_decompression *  dcm, APD_dtx *  dtx )

Decode the next symbol. Parameters: dcm  Pointer to an initialsed, populated and processed decompression structure dtx  Pointer to the arithmetic encoder context Returns: The next symbol

void QSEC_deleteDecompression (  QSEC_decompression *  dcm  )

Free the memory associated with the decompression structure. Parameters: dcm  Pointer to an allocated decompression structure

unsigned int QSEC_getCount (  QSEC_decompression *  dcm  )

Return the number of non-zero bins in the histogram. Parameters: dcm  Pointer to a decompression structure Returns: Number of non-zero bins in the histogram

QSEC_decompression* QSEC_newDecompression (  unsigned int  nbits, const char *  name )

Allocate and initialise a new decompression structure. Parameters: name  String used in the reporting of error to identify a decompression structure nbits  Number of symbols in the complete range of possible symbols (including excluded internal sub-ranges), hence the number of bins in the histogram and frequency tables Returns: Pointer to an allocated and initialised QSEC_decompression structure

void QSEC_reportDecompression (  QSEC_decompression *  dcm, FILE *  fp )

Describe the contents of the decompression structure in formatted ASCII send to the file fp. Parameters: dcm  Pointer to the decompression structure fp  Pointer to the file used as the destination

size_t QSEC_sizeofDecompression (  unsigned int  nbits  )

Calculate the total size required to accomodate a decompression structure. Parameters: nbits  Number of symbols in the complete range of possible symbols (including excluded internal sub-ranges), hence the number of bins in the histogram and frequency tables Returns: Size of memory block required to accomodate a decompression structure

const unsigned int* QSEC_unpack (  QSEC_decompression *  dcm, const unsigned int *  buffer )

Build the lookup and freqency tables by retrieving and unpacking data from the consignment. Parameters: dcm  Pointer to an initialsed decompression structure buffer  Pointer to the start of the buffer holding the packed structure Returns: Pointer to the next input location or NULL if there is an error in the unpacking

---