DSP API Stream type management functions

Functions
DLL_EXPORT void	dsp_stream_alloc_buffer (dsp_stream_p stream, int len)
	Allocate a buffer with length len on the stream passed as argument.
DLL_EXPORT void	dsp_stream_set_buffer (dsp_stream_p stream, void *buffer, int len)
	Set the buffer of the stream passed as argument to a specific memory location.
DLL_EXPORT dsp_t *	dsp_stream_get_buffer (dsp_stream_p stream)
	Return the buffer of the stream passed as argument.
DLL_EXPORT void	dsp_stream_free_buffer (dsp_stream_p stream)
	Free the buffer of the DSP Stream passed as argument.
DLL_EXPORT dsp_stream_p	dsp_stream_new (void)
	Allocate a new DSP stream type.
DLL_EXPORT void	dsp_stream_free (dsp_stream_p stream)
	Free the DSP stream passed as argument.
DLL_EXPORT dsp_stream_p	dsp_stream_copy (dsp_stream_p stream)
	Create a copy of the DSP stream passed as argument.
DLL_EXPORT void	dsp_stream_add_child (dsp_stream_p stream, dsp_stream_p child)
	Add a child to the DSP Stream passed as argument.
DLL_EXPORT void	dsp_stream_add_star (dsp_stream_p stream, dsp_star star)
	Add a star to the DSP Stream passed as argument.
DLL_EXPORT void	dsp_stream_del_star (dsp_stream_p stream, int n)
	Remove the star with index n to a DSP stream.
DLL_EXPORT void	dsp_stream_add_triangle (dsp_stream_p stream, dsp_triangle triangle)
	Add a triangle to the DSP Stream passed as argument.
DLL_EXPORT void	dsp_stream_del_triangle (dsp_stream_p stream, int index)
	Remove the triangle with index n to a DSP stream.
DLL_EXPORT void	dsp_stream_calc_triangles (dsp_stream_p stream)
	Calculate the triangles in the stream struct.
DLL_EXPORT void	dsp_stream_del_child (dsp_stream_p stream, int n)
	Remove the child with index n to a DSP stream.
DLL_EXPORT void	dsp_stream_add_dim (dsp_stream_p stream, int len)
	Add a dimension with length len to a DSP stream.
DLL_EXPORT void	dsp_stream_set_dim (dsp_stream_p stream, int dim, int size)
	Set a dimension size to a DSP stream.
DLL_EXPORT void	dsp_stream_del_dim (dsp_stream_p stream, int n)
	Remove the dimension with index n to a DSP stream.
DLL_EXPORT int	dsp_stream_set_position (dsp_stream_p stream, int *pos)
	Obtain the position the DSP stream by parsing multidimensional indexes.
DLL_EXPORT int *	dsp_stream_get_position (dsp_stream_p stream, int index)
	Return the multidimensional positional indexes of a DSP stream by specify a linear index.
DLL_EXPORT void *	dsp_stream_exec (dsp_stream_p stream, void *args,...)
	Execute the function callback pointed by the func field of the passed stream.
DLL_EXPORT void	dsp_stream_crop (dsp_stream_p stream)
	Crop the buffers of the stream passed as argument by reading the ROI field.
DLL_EXPORT void	dsp_stream_rotate (dsp_stream_p stream)
	Rotate a stream around an axis and offset.
DLL_EXPORT void	dsp_stream_sum (dsp_stream_p stream, dsp_stream_p in)
	Sum a stream with another.
DLL_EXPORT void	dsp_stream_multiply (dsp_stream_p stream, dsp_stream_p in)
	Multiply a stream with another.
DLL_EXPORT void	dsp_stream_subtract (dsp_stream_p stream, dsp_stream_p in)
	Subtract a stream to another.
DLL_EXPORT void	dsp_stream_translate (dsp_stream_p stream)
	Translate a stream.
DLL_EXPORT void	dsp_stream_scale (dsp_stream_p stream)
	Scale a stream.
DLL_EXPORT void	dsp_stream_align (dsp_stream_p stream)
	Perform scale, translate and rotate transformations in-place.

Detailed Description

Function Documentation

dsp_stream_add_child()

DLL_EXPORT void dsp_stream_add_child	(	dsp_stream_p	stream,
		dsp_stream_p	child
	)

Add a child to the DSP Stream passed as argument.

Parameters

stream	the target DSP stream.
child	the child to add to DSP stream.

See also

dsp_stream_new

dsp_stream_del_child

Add a child to the DSP Stream passed as argument.

Parameters

stream
child

Definition at line 304 of file stream.c.

dsp_stream_add_dim()

DLL_EXPORT void dsp_stream_add_dim	(	dsp_stream_p	stream,
		int	size
	)

Add a dimension with length len to a DSP stream.

Parameters

stream	the target DSP stream.
len	the size of the dimension to add

See also

dsp_stream_new

dsp_stream_del_dim

Add a dimension with length len to a DSP stream.

Parameters

stream
size

Definition at line 235 of file stream.c.

dsp_stream_add_star()

DLL_EXPORT void dsp_stream_add_star	(	dsp_stream_p	stream,
		dsp_star	star
	)

Add a star to the DSP Stream passed as argument.

Parameters

stream	the target DSP stream.
star	the star to add to DSP stream.

See also

dsp_stream_new

dsp_stream_del_star

Add a star to the DSP Stream passed as argument.

Parameters

stream
star

Definition at line 337 of file stream.c.

dsp_stream_add_triangle()

DLL_EXPORT void dsp_stream_add_triangle	(	dsp_stream_p	stream,
		dsp_triangle	triangle
	)

Add a triangle to the DSP Stream passed as argument.

Parameters

stream	the target DSP stream.
triangle	the triangle to add to DSP stream.

See also

dsp_stream_new

dsp_stream_del_triangle

Add a triangle to the DSP Stream passed as argument.

Parameters

stream
triangle

Definition at line 378 of file stream.c.

dsp_stream_align()

DLL_EXPORT void dsp_stream_align

(

dsp_stream_p

stream

)

Perform scale, translate and rotate transformations in-place.

Parameters

stream

The stream that will be transformed

Definition at line 526 of file stream.c.

dsp_stream_alloc_buffer()

DLL_EXPORT void dsp_stream_alloc_buffer	(	dsp_stream_p	stream,
		int	len
	)

Allocate a buffer with length len on the stream passed as argument.

Parameters

stream	the target DSP stream.
len	the new length of the buffer.

Definition at line 78 of file stream.c.

dsp_stream_calc_triangles()

DLL_EXPORT void dsp_stream_calc_triangles

(

dsp_stream_p

stream

)

Calculate the triangles in the stream struct.

Parameters

stream

the target DSP stream.

See also

dsp_stream_new

dsp_stream_add_triangle

dsp_stream_copy()

DLL_EXPORT dsp_stream_p dsp_stream_copy

(

dsp_stream_p

stream

)

Create a copy of the DSP stream passed as argument.

Parameters

stream

the DSP stream to copy.

Returns

the copy of the DSP stream

See also

dsp_stream_new

Create a copy of the DSP stream passed as argument.

Parameters

stream

Returns

Definition at line 200 of file stream.c.

dsp_stream_crop()

DLL_EXPORT void dsp_stream_crop

(

dsp_stream_p

stream

)

Crop the buffers of the stream passed as argument by reading the ROI field.

Parameters

stream

The stream that will be cropped in-place

Definition at line 589 of file stream.c.

dsp_stream_del_child()

DLL_EXPORT void dsp_stream_del_child	(	dsp_stream_p	stream,
		int	index
	)

Remove the child with index n to a DSP stream.

Parameters

stream	the target DSP stream.
n	the index of the child to remove

See also

dsp_stream_new

dsp_stream_add_child

Remove the child with index n to a DSP stream.

Parameters

stream
index

Definition at line 317 of file stream.c.

dsp_stream_del_dim()

DLL_EXPORT void dsp_stream_del_dim	(	dsp_stream_p	stream,
		int	index
	)

Remove the dimension with index n to a DSP stream.

Parameters

stream	the target DSP stream.
n	the index of the dimension to remove

See also

dsp_stream_new

dsp_stream_add_dim

Remove the dimension with index n to a DSP stream.

Parameters

stream
index

Definition at line 280 of file stream.c.

dsp_stream_del_star()

DLL_EXPORT void dsp_stream_del_star	(	dsp_stream_p	stream,
		int	index
	)

Remove the star with index n to a DSP stream.

Parameters

stream	the target DSP stream.
n	the index of the star to remove

See also

dsp_stream_new

dsp_stream_add_star

Remove the star with index n to a DSP stream.

Parameters

stream
index

Definition at line 358 of file stream.c.

dsp_stream_del_triangle()

DLL_EXPORT void dsp_stream_del_triangle	(	dsp_stream_p	stream,
		int	index
	)

Remove the triangle with index n to a DSP stream.

Parameters

stream	the target DSP stream.
index	the index of the triangle to remove

See also

dsp_stream_new

dsp_stream_add_triangle

Remove the triangle with index n to a DSP stream.

Parameters

stream
index

Definition at line 419 of file stream.c.

dsp_stream_exec()

DLL_EXPORT void * dsp_stream_exec	(	dsp_stream_p	stream,
		void *	args,
			...
	)

Execute the function callback pointed by the func field of the passed stream.

Parameters

stream	the target DSP stream.
args	The arguments list to be passed to the callback

Returns

callback return value

See also

dsp_stream_new

dsp_stream_get_position

dsp_stream_set_position

dsp_stream_free()

DLL_EXPORT void dsp_stream_free

(

dsp_stream_p

stream

)

Free the DSP stream passed as argument.

Parameters

stream

the target DSP stream.

See also

dsp_stream_new

Free the DSP stream passed as argument.

Parameters

stream

Definition at line 167 of file stream.c.

dsp_stream_free_buffer()

DLL_EXPORT void dsp_stream_free_buffer

(

dsp_stream_p

stream

)

Free the buffer of the DSP Stream passed as argument.

Parameters

stream

the target DSP stream.

Definition at line 112 of file stream.c.

dsp_stream_get_buffer()

DLL_EXPORT dsp_t * dsp_stream_get_buffer

(

dsp_stream_p

stream

)

Return the buffer of the stream passed as argument.

Parameters

stream

the target DSP stream.

Returns

the buffer

Definition at line 107 of file stream.c.

dsp_stream_get_position()

DLL_EXPORT int * dsp_stream_get_position	(	dsp_stream_p	stream,
		int	index
	)

Return the multidimensional positional indexes of a DSP stream by specify a linear index.

Parameters

stream	the target DSP stream.
index	the position of the index on a single dimension.

Returns

the the position of the index on each dimension.

See also

dsp_stream_new

dsp_stream_set_position

dsp_stream_exec

dsp_stream_exec_multidim

Return the multidimensional positional indexes of a DSP stream by specify a linear index.

Parameters

stream
index

Returns

Definition at line 451 of file stream.c.

dsp_stream_multiply()

DLL_EXPORT void dsp_stream_multiply	(	dsp_stream_p	stream,
		dsp_stream_p	in
	)

Multiply a stream with another.

Parameters

stream	The stream that will be multiplied
in	The stream that will be multiplied to stream

Definition at line 821 of file stream.c.

dsp_stream_new()

DLL_EXPORT dsp_stream_p dsp_stream_new

(

void

)

Allocate a new DSP stream type.

Returns

the newly created DSP stream type

See also

dsp_stream_free

Allocate a new DSP stream type.

Returns

Definition at line 128 of file stream.c.

dsp_stream_rotate()

DLL_EXPORT void dsp_stream_rotate

(

dsp_stream_p

stream

)

Rotate a stream around an axis and offset.

Parameters

stream

The stream that will be rotated in-place

Definition at line 731 of file stream.c.

dsp_stream_scale()

DLL_EXPORT void dsp_stream_scale

(

dsp_stream_p

stream

)

Scale a stream.

Parameters

stream

The stream that will be scaled in-place

Definition at line 669 of file stream.c.

dsp_stream_set_buffer()

DLL_EXPORT void dsp_stream_set_buffer	(	dsp_stream_p	stream,
		void *	buffer,
		int	len
	)

Set the buffer of the stream passed as argument to a specific memory location.

Parameters

stream	the target DSP stream.
buffer	the new location of the buffer.
len	the new length of the buffer.

Definition at line 101 of file stream.c.

dsp_stream_set_dim()

DLL_EXPORT void dsp_stream_set_dim	(	dsp_stream_p	stream,
		int	dim,
		int	size
	)

Set a dimension size to a DSP stream.

Parameters

stream	the target DSP stream.
dim	the index of the dimension to modify
size	the size of the dimension to modify

See also

dsp_stream_new

dsp_stream_add_dim

Set a dimension size to a DSP stream.

Parameters

stream
dim
size

Definition at line 260 of file stream.c.

dsp_stream_set_position()

DLL_EXPORT int dsp_stream_set_position	(	dsp_stream_p	stream,
		int *	pos
	)

Obtain the position the DSP stream by parsing multidimensional indexes.

Parameters

stream	the target DSP stream.
pos	the position of the index on each dimension.

Returns

the position of the index on a single dimension.

See also

dsp_stream_new

dsp_stream_get_position

dsp_stream_exec

dsp_stream_exec_multidim

Obtain the position the DSP stream by parsing multidimensional indexes.

Parameters

stream
pos

Returns

Definition at line 471 of file stream.c.

dsp_stream_subtract()

DLL_EXPORT void dsp_stream_subtract	(	dsp_stream_p	stream,
		dsp_stream_p	in
	)

Subtract a stream to another.

Parameters

stream	The original stream
in	The stream that will be subtracted to the first argument

Definition at line 846 of file stream.c.

dsp_stream_sum()

DLL_EXPORT void dsp_stream_sum	(	dsp_stream_p	stream,
		dsp_stream_p	in
	)

Sum a stream with another.

Parameters

stream	The stream that will be summed
in	The stream that will be summed to stream

Definition at line 796 of file stream.c.

dsp_stream_translate()

DLL_EXPORT void dsp_stream_translate

(

dsp_stream_p

stream

)

Translate a stream.

Parameters

stream

The stream that will be translated in-place

Definition at line 613 of file stream.c.