A CTF2 decoder and its methods. More...

#include "metadata.h"
#include "event_generator.h"
#include "event.h"

Typedefs
typedef struct actf_decoder	actf_decoder
	A CTF2 decoder, implements an actf_event_generator.

Functions
actf_decoder *	actf_decoder_init (void data, size_t data_len, size_t evs_cap, const actf_metadata metadata)
	Initialize a decoder.
int	actf_decoder_decode (actf_decoder dec, actf_event *evs, size_t evs_len)
int	actf_decoder_seek_ns_from_origin (actf_decoder *dec, int64_t tstamp)
const char *	actf_decoder_last_error (actf_decoder *dec)
void	actf_decoder_free (actf_decoder *dec)
	Free a decoder.
struct actf_event_generator	actf_decoder_to_generator (actf_decoder *dec)
	Create an event generator based on a decoder.

Detailed Description

A CTF2 decoder and its methods.

Decodes data based on the CTF2-SPEC-2.0rA specification: https://diamon.org/ctf/files/CTF2-SPEC-2.0rA.html

Function Documentation

actf_decoder * actf_decoder_init	(	void *	data,
		size_t	data_len,
		size_t	evs_cap,
		const actf_metadata *	metadata )

Initialize a decoder.

Parameters

data	the ctf2 data to process
data_len	the length of the data
evs_cap	the max event array capacity. If zero, ACTF_DEFAULT_EVS_CAP will be used.
metadata	the metadata describing the data

Returns: a decoder or NULL with errno set. A returned decoder should be freed with actf_decoder_free().

int actf_decoder_seek_ns_from_origin	(	actf_decoder *	dec,
		int64_t	tstamp )

const char * actf_decoder_last_error ( actf_decoder * dec )

void actf_decoder_free ( actf_decoder * dec )

Free a decoder.

Parameters

dec	the decoder

struct actf_event_generator actf_decoder_to_generator ( actf_decoder * dec )

Create an event generator based on a decoder.

The decoder is owned by the caller and must be kept alive as long as the event generator is in use.

Parameters

dec	the decoder