stb_filter.h File Reference

Interface to Platform Section Filtering. More...

#include "dmxtypes.h"

Go to the source code of this file.

Typedefs
typedef void(*	F_FILTER_CALLBACK )(DMXREF dmx, U16BIT bytes, PIDFILT pfid)

Functions
PIDFILT	STB_DMXGrabPIDFilter (DMXREF dmx, U16BIT pid, F_FILTER_CALLBACK func)
	Get a New PID Filter & Setup Associated Buffer and Callback Function Address. More...
BOOLEAN	STB_DMXCopyPIDFilterSect (DMXREF dmx, U8BIT *buffer, U16BIT size, PIDFILT pfid)
	Copies a filtered section to caller's buffer. More...
void	STB_DMXSkipPIDFilterSect (DMXREF dmx, PIDFILT pfid)
	Skips (discards) a section in the PID filter buffer. More...
SECFILT	STB_DMXGrabSectFilter (DMXREF dmx, PIDFILT pfid)
	Allocated a new section filter on the specified PID filter. More...
void	STB_DMXSetupSectFilter (DMXREF dmx, SECFILT sfid, U8BIT *match_ptr, U8BIT *mask_ptr, U8BIT not_equal_byte_index, BOOLEAN crc)
	Configures a match and mask for a specified section filter. More...
void	STB_DMXStartPIDFilter (DMXREF dmx, PIDFILT pfid)
	Start Specified PID Filter Collecting Data. More...
void	STB_DMXStopPIDFilter (DMXREF dmx, PIDFILT pfid)
	Stop Specified PID Filter Collecting Data. More...
void	STB_DMXReleasePIDFilter (DMXREF dmx, PIDFILT pfid)
	Releases a previously allocated PID filter. More...
void	STB_DMXReleaseSectFilter (DMXREF dmx, SECFILT sfid)
	Releases a previously allocated section filter. More...

Detailed Description

Interface to Platform Section Filtering.

Date

23/01/2013

Author

Adam Sturtridge

Definition in file stb_filter.h.

Function Documentation

BOOLEAN STB_DMXCopyPIDFilterSect	(	DMXREF	dmx,
		U8BIT *	buffer,
		U16BIT	size,
		PIDFILT	pfid
	)

Copies a filtered section to caller's buffer.

Parameters

dmx	the demux to use
buffer	the caller's buffer
size	the size of the caller's buffer
pfid	the handle of the PID filter to read from

Returns

TRUE copied ok

FALSE no data to copy

PIDFILT STB_DMXGrabPIDFilter	(	DMXREF	dmx,
		U16BIT	pid,
		F_FILTER_CALLBACK	func
	)

Get a New PID Filter & Setup Associated Buffer and Callback Function Address.

Parameters

dmx	Required Decode Refernce.
pid	Required PID to Demux.
func_ptr	User's Interrupt Procedure Function Address.

Returns

New PID filter identifier or invalid id.

SECFILT STB_DMXGrabSectFilter	(	DMXREF	dmx,
		PIDFILT	pfid
	)

Allocated a new section filter on the specified PID filter.

Parameters

dmx	the demux ref to use
pfid	the PID filter to assign the section filter to

Returns

The section filter handle

void STB_DMXReleasePIDFilter	(	DMXREF	dmx,
		PIDFILT	pfid
	)

Releases a previously allocated PID filter.

Parameters

dmx	the demux ref of the filter
pfid	the handle of the filter

void STB_DMXReleaseSectFilter	(	DMXREF	dmx,
		SECFILT	sfid
	)

Releases a previously allocated section filter.

Parameters

dmx	the demux ref of the filter
sfilt_id	the handle of the section filter

void STB_DMXSetupSectFilter	(	DMXREF	dmx,
		SECFILT	sfid,
		U8BIT *	match_ptr,
		U8BIT *	mask_ptr,
		U8BIT	not_equal_byte_index,
		BOOLEAN	crc
	)

Configures a match and mask for a specified section filter.

Parameters

dmx	the demux ref of the section filter
sfilt_id	the handle of the section filter
match_ptr	pointer to the match bytes
mask_ptr	pointer to the mask bytes
not_equal_byte_index	the byte position for a not equal compare
crc	TRUE to use CRC checking FALSE to ignore

void STB_DMXSkipPIDFilterSect	(	DMXREF	dmx,
		PIDFILT	pfid
	)

Skips (discards) a section in the PID filter buffer.

Parameters

dmx	the demux ref for the filter
pfid	the PID filter handle

void STB_DMXStartPIDFilter	(	DMXREF	dmx,
		PIDFILT	pfid
	)

Start Specified PID Filter Collecting Data.

Parameters

dmx	Required Decode Reference.
pfilter_id	Required PID Filter Identifier.

void STB_DMXStopPIDFilter	(	DMXREF	dmx,
		PIDFILT	pfid
	)

Stop Specified PID Filter Collecting Data.

Parameters

dmx	Required Decode Reference.
pfilter_id	Required PID Filter Identifier.