Data and streaming

Functions
DLL_EXPORT ahp_xc_packet *	ahp_xc_alloc_packet (void)
	Allocate and return a packet structure.
DLL_EXPORT ahp_xc_packet *	ahp_xc_copy_packet (ahp_xc_packet *packet)
	Allocate and return a copy of a packet structure.
DLL_EXPORT void	ahp_xc_free_packet (ahp_xc_packet *packet)
	Free a previously allocated packet structure.
DLL_EXPORT ahp_xc_sample *	ahp_xc_alloc_samples (uint64_t nlines, size_t size)
	Allocate and return a samples array.
DLL_EXPORT ahp_xc_sample *	ahp_xc_copy_samples (ahp_xc_sample *src, uint64_t nlines, size_t size)
	Allocate and return a copy of the passed samples array.
DLL_EXPORT void	ahp_xc_free_samples (uint64_t nlines, ahp_xc_sample *samples)
	Free a previously allocated samples array.
DLL_EXPORT int32_t	ahp_xc_get_packet (ahp_xc_packet *packet)
	Grab a data packet.
DLL_EXPORT void	ahp_xc_start_autocorrelation_scan (uint32_t index, off_t start, size_t size, size_t step)
	Initiate an autocorrelation scan.
DLL_EXPORT void	ahp_xc_end_autocorrelation_scan (uint32_t index)
	End an autocorrelation scan.
DLL_EXPORT int32_t	ahp_xc_scan_autocorrelations (uint32_t nlines, uint32_t *indexes, ahp_xc_sample **autocorrelations, off_t *starts, size_t *sizes, size_t *steps, int32_t *interrupt, double *percent)
	Scan all available delay channels and get autocorrelations of each input.
DLL_EXPORT void	ahp_xc_start_crosscorrelation_scan (uint32_t index, off_t start, size_t size, size_t step)
	Initiate a crosscorrelation scan.
DLL_EXPORT void	ahp_xc_end_crosscorrelation_scan (uint32_t index)
	End a crosscorrelation scan.
DLL_EXPORT int32_t	ahp_xc_scan_crosscorrelations (uint32_t index1, uint32_t index2, ahp_xc_sample **crosscorrelations, off_t start1, size_t size1, off_t start2, size_t size2, size_t step, int32_t *interrupt, double *percent)
	Scan all available delay channels and get crosscorrelations of each input with others.

Detailed Description

Function Documentation

ahp_xc_alloc_packet()

DLL_EXPORT ahp_xc_packet * ahp_xc_alloc_packet

(

void

)

Returns

Returns a new ahp_xc_packet structure pointer

ahp_xc_alloc_samples()

DLL_EXPORT ahp_xc_sample * ahp_xc_alloc_samples	(	uint64_t	nlines,
		size_t	size
	)

Parameters

nlines	The Number of samples to be allocated.
len	The lag_size and correlations field size of each sample.

Returns

Returns the new allocated ahp_xc_sample array

See also

ahp_xc_free_samples

ahp_xc_copy_samples

ahp_xc_sample

ahp_xc_packet

ahp_xc_copy_packet()

DLL_EXPORT ahp_xc_packet * ahp_xc_copy_packet

(

ahp_xc_packet *

packet

)

Returns

Returns a new ahp_xc_packet structure pointer

ahp_xc_copy_samples()

DLL_EXPORT ahp_xc_sample * ahp_xc_copy_samples	(	ahp_xc_sample *	src,
		uint64_t	nlines,
		size_t	size
	)

Parameters

src	The source samples array.
nlines	The Number of samples to be allocated.
len	The lag_size and correlations field size of each sample.

Returns

Returns the ahp_xc_sample array copy of src

See also

ahp_xc_alloc_samples

ahp_xc_free_samples

ahp_xc_sample

ahp_xc_packet

ahp_xc_end_autocorrelation_scan()

DLL_EXPORT void ahp_xc_end_autocorrelation_scan

(

uint32_t

index

)

Parameters

index

The line index.

ahp_xc_end_crosscorrelation_scan()

DLL_EXPORT void ahp_xc_end_crosscorrelation_scan

(

uint32_t

index

)

Parameters

index

The line index.

ahp_xc_free_packet()

DLL_EXPORT void ahp_xc_free_packet

(

ahp_xc_packet *

packet

)

Parameters

packet

pointer to the ahp_xc_packet structure to be freed

ahp_xc_free_samples()

DLL_EXPORT void ahp_xc_free_samples	(	uint64_t	nlines,
		ahp_xc_sample *	samples
	)

Parameters

nlines	The Number of samples to be allocated.
samples	the ahp_xc_sample array to be freed

See also

ahp_xc_alloc_samples

ahp_xc_copy_samples

ahp_xc_sample

ahp_xc_packet

ahp_xc_get_packet()

DLL_EXPORT int32_t ahp_xc_get_packet

(

ahp_xc_packet *

packet

)

Parameters

packet

The ahp_xc_packet structure to be filled.

Returns

Returns non-zero on error

See also

ahp_xc_set_channel_auto

ahp_xc_set_channel_cross

ahp_xc_alloc_packet

ahp_xc_free_packet

ahp_xc_packet

ahp_xc_scan_autocorrelations()

DLL_EXPORT int32_t ahp_xc_scan_autocorrelations	(	uint32_t	nlines,
		uint32_t *	indexes,
		ahp_xc_sample **	autocorrelations,
		off_t *	starts,
		size_t *	sizes,
		size_t *	steps,
		int32_t *	interrupt,
		double *	percent
	)

Parameters

nlines	the number of inputs for this scan.
indexes	the input indexes list.
autocorrelations	An ahp_xc_sample array pointer, can be NULL. Will be allocated by reference and filled by this function.
starts	First channel to be scanned list.
sizes	Number of channels to be scanned list.
steps	The scan steps in channels.
interrupt	This should point32_t to an int32_t variable, when setting to 1, on a separate thread, scanning will be interrupted.
percent	Like interrupt a variable, passed by reference that will be updated with the percent of completion.

Returns

Returns the number of channels scanned

See also

ahp_xc_get_delaysize

ahp_xc_sample

ahp_xc_scan_crosscorrelations()

DLL_EXPORT int32_t ahp_xc_scan_crosscorrelations	(	uint32_t	index1,
		uint32_t	index2,
		ahp_xc_sample **	crosscorrelations,
		off_t	start1,
		size_t	size1,
		off_t	start2,
		size_t	size2,
		size_t	step,
		int32_t *	interrupt,
		double *	percent
	)

Parameters

index1	the first input index.
index2	the second input index.
crosscorrelations	An ahp_xc_sample array pointer, can be NULL. Will be allocated by reference and filled by this function.
start1	Initial channel on index1 input.
size1	Number of channels to scan on index1 input.
start2	Initial channel on index2 input.
size2	Number of channels to scan on index2 input.
step	The scan step in channels.
interrupt	This should point32_t to an int32_t variable, when setting to 1, on a separate thread, scanning will be interrupted.
percent	Like interrupt a variable, passed by reference that will be updated with the percent of completion.

Returns

Returns the number of channels scanned

See also

ahp_xc_get_delaysize

ahp_xc_sample

ahp_xc_start_autocorrelation_scan()

DLL_EXPORT void ahp_xc_start_autocorrelation_scan	(	uint32_t	index,
		off_t	start,
		size_t	size,
		size_t	step
	)

Parameters

index	The line index.
start	The starting channel for this scan.
size	The number of channels to scan afterwards.
step	The scan step in channels.

ahp_xc_start_crosscorrelation_scan()

DLL_EXPORT void ahp_xc_start_crosscorrelation_scan	(	uint32_t	index,
		off_t	start,
		size_t	size,
		size_t	step
	)

Parameters

index	The line index.
start	the starting channel for this scan.
size	The number of channels to scan afterwards.
step	The scan step in channels.