mem_src.h File Reference

This is the header file for the memory source element. More...

#include "streamer_element.h"

Data Structures
struct	ElementMemSrc

Macros
#define	MEMSRC_DEFAULT_CHUNK_SIZE   1024

Functions
int32_t	memsrc_init (StreamElement *element)
	this function initializes the memory source element and source pad. all the pad's handlers are intialized. More...
int32_t	memsrc_set_buffer (ElementHandle element, int8_t *location, uint32_t size)
	This function sets a destiniaiton buffer to be read by memory source element. More...
int32_t	memsrc_set_push_chunk_size (ElementHandle element, uint32_t chunk_size)
	This function sets the chunk size in which the momery source sends the data in push mode. More...
int32_t	memsrc_get_push_chunk_size (ElementHandle element, uint32_t *chunk_size)
	This function gets the chunk size. More...

Macro Definition Documentation

MEMSRC_DEFAULT_CHUNK_SIZE

#define MEMSRC_DEFAULT_CHUNK_SIZE   1024

Default read size

Function Documentation

memsrc_init()

int32_t memsrc_init

(

StreamElement *

element

)

Parameters

element

pointer to element

Returns

StreamReturnType

Return values

STREAM_OK	if successful
STREAM_ERR_INVALID_ARGS	means invalid arguments

memsrc_set_buffer()

int32_t memsrc_set_buffer	(	ElementHandle	element,
		int8_t *	location,
		uint32_t	size
	)

Parameters

element	element handle
location	memory location
size	memory size

Returns

StreamReturnType

Return values

STREAM_OK	if successful
STREAM_ERR_INVALID_ARGS	means invalid arguments

memsrc_set_push_chunk_size()

int32_t memsrc_set_push_chunk_size	(	ElementHandle	element,
		uint32_t	chunk_size
	)

Parameters

element	element handle
chunk_size	chunk size

Returns

StreamReturnType

Return values

STREAM_OK	if successful
STREAM_ERR_INVALID_ARGS	means invalid arguments

memsrc_get_push_chunk_size()

int32_t memsrc_get_push_chunk_size	(	ElementHandle	element,
		uint32_t *	chunk_size
	)

Parameters

element	element handle
chunk_size	chunk size

Returns

StreamReturnType

Return values

STREAM_OK	if successful
STREAM_ERR_INVALID_ARGS	means invalid arguments