writer.h File Reference

FSEQ sequence file encoding functions. More...

#include <stdint.h>

Include dependency graph for writer.h:

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

Go to the source code of this file.

Data Structures
struct	fseq_var_s
	Represents a variable that can be encoded in the FSEQ format. More...

Functions
int	fseqWriteHeader (struct FC *fc, const struct tf_header_t *header)
	Encodes the given header and writes it at the beginning of the file.
int	fseqWriteCompressionBlocks (struct FC *fc, const struct tf_header_t *header, const struct tf_compression_block_t *blocks)
	Encodes the given compression blocks writes them to the file at the at the end of the format header.
int	fseqWriteVars (struct FC *fc, const struct tf_header_t *header, const struct fseq_var_s *vars, int count)
	Encodes the given variables and writes them to the file after the compression block and channel range tables.
int	fseqRealignHeaderOffsets (struct tf_header_t *header, const struct fseq_var_s *vars, int count)
	Re-aligns the offsets in the given header to account for the length of the variable data that will be written to the file.

Detailed Description

FSEQ sequence file encoding functions.

Function Documentation

fseqRealignHeaderOffsets()

int fseqRealignHeaderOffsets	(	struct tf_header_t *	header,
		const struct fseq_var_s *	vars,
		int	count )

Re-aligns the offsets in the given header to account for the length of the variable data that will be written to the file.

Parameters

header	header to update
vars	variables to account for
count	number of variables in the array

Returns

0 on success, a negative error code on failure

Here is the call graph for this function:

fseqWriteCompressionBlocks()

int fseqWriteCompressionBlocks	(	struct FC *	fc,
		const struct tf_header_t *	header,
		const struct tf_compression_block_t *	blocks )

Encodes the given compression blocks writes them to the file at the at the end of the format header.

Parameters

fc	target file controller
header	header to account for
blocks	compression blocks to encode and write

Returns

0 on success, a negative error code on failure

Here is the call graph for this function:

fseqWriteHeader()

int fseqWriteHeader	(	struct FC *	fc,
		const struct tf_header_t *	header )

Encodes the given header and writes it at the beginning of the file.

Parameters

fc	target file controller
header	header to encode and write

Returns

0 on success, a negative error code on failure

Here is the call graph for this function:

fseqWriteVars()

int fseqWriteVars	(	struct FC *	fc,
		const struct tf_header_t *	header,
		const struct fseq_var_s *	vars,
		int	count )

Encodes the given variables and writes them to the file after the compression block and channel range tables.

Parameters

fc	target file controller
header	header to account for
vars	variables to encode and write
count	number of variables in the array

Returns

0 on success, a negative error code on failure

Here is the call graph for this function: