eIQ MCU Media Processing Pipeline API#

MPP VERSION 3.7

1. MPP API#

Functions

int mpp_api_init (mpp_api_params_t ∗params)
mpp_t mpp_create (mpp_params_t ∗params, int ∗ret)
int mpp_camera_add (mpp_t mpp, const char ∗name, mpp_camera_params_t ∗params, mpp_elem_handle_t elem_h,)
int mpp_static_img_add (mpp_t mpp, mpp_img_params_t ∗params, void ∗addr)
int mpp_display_add (mpp_t mpp, const char ∗name, mpp_display_params_t ∗params)
int mpp_nullsink_add (mpp_t mpp)
int mpp_element_add (mpp_t mpp, mpp_element_id_t id, mpp_element_params_t ∗params, mpp_elem_handle_t ∗elem_h)
int mpp_split (mpp_t mpp, unsigned int num, mpp_params_t ∗params, mpp_t ∗out_list)
int mpp_background (mpp_t mpp, mpp_params_t ∗params, mpp_t ∗out_mpp)
int mpp_element_update (mpp_t mpp, mpp_elem_handle_t elem_h, mpp_element_params_t ∗params, , bool force_update)
int mpp_start (mpp_t mpp, int last)
int mpp_stop (mpp_t mpp)
void mpp_stats_enable (mpp_stats_grp_t grp)
void mpp_stats_disable (mpp_stats_grp_t grp)
char ∗mpp_get_version (void)
bool mpp_is_running (mpp_t mpp)
int mpp_force_update(mpp_t mpp)

1.1 Detailed Description#

This section provides the detailed documentation for the MCU Media Processing Pipeline API.

1.1.1 Function Documentation#

mpp_api_init#

int mpp_api_init ( mpp_api_params_t ∗ params )

Pipeline initialization. This function initializes the library and its data structures. It must be called before any other function of the API is called.

Parameters

in/out	name	description
in	params	API global parameters
out	ret	return code (0 - success, non-zero - error)

Returns

Return_codes

2. mpp_create()

mpp_create#

mpp_t mpp_create ( mpp_params_t ∗ params, int ∗ ret )

Basic pipeline creation. This function returns a handle to the pipeline.

Parameters

in/out	name	description
in	params	pipeline parameters
out	ret	return code (0 - success, non-zero - error)

Returns

handle to the pipeline if success, NULL if there is an error.

mpp_camera_add#

int mpp_camera_add ( mpp_t mpp, const char ∗ name, mpp_camera_params_t ∗ params, mpp_elem_handle_t elem_h, )

Camera addition.

This function adds a camera to the pipeline.

Parameters

in/out	name	description
in	mpp	input pipeline
in	name	camera driver name
in	params	parameters to be configured on the camera
out	elem_h	element handle in pipeline

Returns

Return_codes

mpp_static_img_add#

mpp_static_img_add()

int mpp_static_img_add ( mpp_t mpp, mpp_img_params_t ∗ params, void ∗ addr, mpp_elem_handle_t ∗ elem_h )

Static image addition.

Parameters

in/out	name	description
in	mpp	input pipeline
in	params	static image parameters
in	addr	image buffer
out	elem_h	element handle in pipeline

Returns

Return_codes

Precondition

Image buffer allocation/free is the responsibility of the user.

mpp_display_add#

int mpp_display_add ( mpp_t mpp, const char ∗ name, mpp_display_params_t ∗ params )

Display addition.

This function adds a display to the pipeline.

Parameters

in/out	name	description
in	mpp	input pipeline
in	name	display driver name
in	params	parameters that are configured on the display

Returns

Return_codes

mpp_nullsink_add#

mpp_nullsink_add()

int mpp_nullsink_add ( mpp_t mpp )

Null sink addition.

This function adds a null-type sink to the pipeline.

After this call pipeline is closed and no further elements can be added. Input frames are discarded.

Parameters

in/out	name	description
in	mpp	input pipeline

Returns

Return_codes

mpp_element_add#

int mpp_element_add ( mpp_t mpp, mpp_element_id_t id, mpp_element_params_t ∗ params, mpp_elem_handle_t ∗ elem_h )

Add processing element (single input, single output) This function adds an element to the pipeline. Available elements are:

2D image processing
ML inference engine
Labeled rectangle
Compositor

Parameters

in/out	name	description
in	mpp	input pipeline
in	id	element id
in	params	element parameters
out	elem_h	element handle in pipeline

Returns

Return_codes

mpp_split#

int mpp_split ( mpp_t mpp, unsigned int num, mpp_params_t ∗ params, mpp_t ∗ out_list )

Pipeline multiplication.

Parameters

in/out	name	description
in	mpp	input pipeline
in	num	number of output pipeline
in	params	split mpp parameters
out	out_list	list of output pipelines

Returns

Return_codes

Precondition

out_list array must contain at least num elements.

mpp_background#

int mpp_background ( mpp_t mpp, mpp_params_t ∗ params, mpp_t ∗ out_mpp )

Put next elements processing in background.

Parameters

in/out	name	description
in	mpp	input pipeline
in	params	new mpp parameters (exec_flag must be MPP_EXEC_PREEMPT)
out	out_mpp	output pipeline

Returns

Return_codes

mpp_element_update#

int mpp_element_update ( mpp_t mpp, mpp_elem_handle_t elem_h, mpp_element_params_t ∗ params, bool force_update )

Update element parameters.

Parameters

in/out	name	description
in	mpp	input pipeline
in	elem_h	element handle in the pipeline.
in	params	new element parameters
in	force_update	force the pipeline to run even though there is no input frame update for processing elements after update. If the force_update flag was already requested before, the current value is ignored

Returns

Return_codes

mpp_start#

int mpp_start ( mpp_t mpp, int last )

Start pipeline.

When called with last=0, this function prepares the branch of the pipeline specified with mpp. When called with last!=0, this function starts the data flow of the pipeline.

Data flow should start after all the branches of the pipeline have been prepared.

Parameters

in/out	name	description
in	mpp	pipeline branch handle to start/prepare
in	last	if non-zero start pipeline processing. No further start call is possible thereafter.

Returns

Return_codes

mpp_stop#

int mpp_stop ( mpp_t mpp )

Stop a branch of the pipeline.

This function stops the data processing and peripherals of a pipeline branch.

Parameters

in/out	name	description
in	mpp	pipeline branch to stop

Returns

Return_codes

mpp_stats_enable#

void mpp_stats_enable ( mpp_stats_grp_t grp )

Enable statistics collection.

This function enables statistics collection for a given group. Statistics collection is disabled by default after API initialization. Calling this function when stats are enabled has no effect.

Parameters

in/out	name	description
in	grp	statistics group

Returns

mpp_stats_disable#

void mpp_stats_disable ( mpp_stats_grp_t grp )

Disable statistics collection.

This function disables statistics collection for a given group. Calling this function when stats are disabled has no effect. This function is used to ensure stats are not updated while application tasks use the stats structures.

Parameters

in/out	name	description
in	grp	statistics group

mpp_get_version#

char ∗ mpp_get_version ( void )

Get MPP version.

Returns

pointer to the MPP version string

mpp_is_running#

bool mpp_is_running (mpp_t mpp)

Check if the pipeline is currently running

Parameters

in/out	name	description
in	mpp	input pipeline

Returns

true if pipeline is in running state, else false

mpp_force_update#

int mpp_force_update(mpp_t mpp)

Force the update of a branch of the pipeline

This function forces an update of the branch of the pipeline even if there is no new input frame

Parameters

in/out	name	description
in	mpp	input pipeline branch to set the flag force_update to true

Returns

Return_codes

2. MPP Types#

Data Structures

union mpp_stats_t
struct mpp_api_params_t
struct mpp_params_t
struct mpp_camera_stream_cfg
struct mpp_camera_params_t
struct mpp_img_params_t
struct mpp_display_params_t
struct mpp_tensor_dims_t
struct mpp_inference_tensor_params_t
struct mpp_inference_cb_param_t
union mpp_color_t
struct mpp_labeled_rect_t
struct mpp_landmark_t
struct mpp_area_t
struct mpp_dims_t
struct mpp_position_t
struct mpp_inference_params_t
struct mpp_element_params_t
struct mpp_stats_t.api
struct mpp_stats_t.mpp
struct mpp_stats_t.elem
struct mpp_color_t.rgb
union mpp_element_params_t.unnamed5
struct mpp_element_params_t.unnamed5.static_image
struct mpp_element_params_t.unnamed5.compose
struct mpp_element_params_t.unnamed5.labels
struct mpp_element_params_t.unnamed5.convert
struct mpp_element_params_t.unnamed5.resize
struct mpp_element_params_t.unnamed5.color_conv
struct mpp_element_params_t.unnamed5.rotate
struct mpp_element_params_t.unnamed5.test
struct mpp_element_params_t.unnamed5.decode
struct mpp_element_params_t.unnamed5.ml_inference

Macros

#define MPP_INFERENCE_MAX_OUTPUTS
#define MPP_INFERENCE_MAX_INPUTS
#define MPP_INVALID
#define MPP_EVENT_ALL
#define MAX_TENSOR_DIMS

Typedefs

typedef void ∗mpp_t
typedef uintptr_t mpp_elem_handle_t
typedef unsigned int mpp_evt_mask_t
typedef int(∗inference_entry_point_t) (uint8_t ∗, uint8_t ∗, uint8_t ∗)

Enumerations

enum mpp_evt_t {

MPP_EVENT_INVALID,

MPP_EVENT_INFERENCE_OUTPUT_READY,

MPP_EVENT_INTERNAL_TEST_RESERVED,

MPP_EVENT_NUM }
enum mpp_exec_flag_t {

MPP_EXEC_INHERIT,

MPP_EXEC_RC,

MPP_EXEC_PREEMPT }
enum mpp_stats_grp_t {

MPP_STATS_GRP_API,

MPP_STATS_GRP_MPP,

MPP_STATS_GRP_ELEMENT,

MPP_STATS_GRP_NUM }
enum mpp_rotate_degree_t {

ROTATE_0,

ROTATE_90,

ROTATE_180,

ROTATE_270 }
enum mpp_flip_mode_t {

FLIP_NONE,

FLIP_HORIZONTAL,

FLIP_VERTICAL,

FLIP_BOTH }
enum mpp_convert_ops_t {

MPP_CONVERT_NONE,

MPP_CONVERT_ROTATE,

MPP_CONVERT_SCALE,

MPP_CONVERT_COLOR,

MPP_CONVERT_CROP,

MPP_CONVERT_OUT_WINDOW }
enum mpp_pixel_format_t {

MPP_PIXEL_ARGB,

MPP_PIXEL_BGRA,

MPP_PIXEL_RGBA,

MPP_PIXEL_BGRX,

MPP_PIXEL_RGBX,

MPP_PIXEL_RGB,

MPP_PIXEL_RGB565,

MPP_PIXEL_BGR,

MPP_PIXEL_GRAY888,

MPP_PIXEL_GRAY888X,

MPP_PIXEL_GRAY,

MPP_PIXEL_GRAY16,

MPP_PIXEL_YUV1P444,

MPP_PIXEL_VYUY1P422,

MPP_PIXEL_UYVY1P422,

MPP_PIXEL_YUYV,

MPP_PIXEL_DEPTH16,

MPP_PIXEL_DEPTH8,

MPP_PIXEL_YUV420P,

MPP_PIXEL_JPEG,

MPP_PIXEL_INVALID }
enum mpp_element_id_t {

MPP_ELEMENT_INVALID,

MPP_ELEMENT_IMG_COMPOSE,

MPP_ELEMENT_LABELED_RECTANGLE,

MPP_ELEMENT_TEST,

MPP_ELEMENT_INFERENCE,

MPP_ELEMENT_CONVERT,

MPP_ELEMENT_NUM }
enum mpp_tensor_type_t {

MPP_TENSOR_TYPE_FLOAT32,

MPP_TENSOR_TYPE_UINT8,

MPP_TENSOR_TYPE_INT8 }
enum mpp_tensor_order_t {

MPP_TENSOR_ORDER_UNKNOWN,

MPP_TENSOR_ORDER_NHWC,

MPP_TENSOR_ORDER_NCHW }
enum mpp_inference_type_t {

MPP_INFERENCE_TYPE_TFLITE }
enum mpp_camera_stream_type {

RGB_STREAM,

IR_STREAM,

NUM_STREAMS }

2.1 Detailed Description#

This section provides the detailed documentation for the MCU Media Processing Pipeline types.

2.1.1 Data Structure Documentation#

mpp_stats_t#

union mpp_stats_t

Data Fields

type	name	description
struct mpp_stats_t.api	api	Global execution performance counters.
struct mpp_stats_t.mpp	mpp	Pipeline execution performance counters.
struct mpp_stats_t.elem	elem	Element execution performance counters.

mpp_api_params_t#

struct mpp_api_params_t

Data Fields

type	name	description
mpp_stats_t ∗	stats	API stats.
unsigned int	rc_cycle_min	minimum cycle duration for RC tasks (ms), 0: sets default value
unsigned int	rc_cycle_inc	time increment for RC tasks (ms), 0: sets default value
int	pipeline_task_max_prio	pipeline tasks maximum priority.
int	pipeline_rc_task_prio	pipeline run-to-completion tasks priority. 0: sets default value
int	pipeline_pr_task_prio	pipeline preemptable tasks priority. 0: sets default value

mpp_params_t#

struct mpp_params_t

Pipeline creation parameters.

Data Fields

int(∗evt_callback_f )(mpp_t mpp, mpp_evt_t evt, void ∗evt_data, void ∗user_data)
mpp_evt_mask_t mask
mpp_exec_flag_t exec_flag
void ∗cb_userdata

mpp_stats_t#

mpp_stats_t ∗stats

mpp_camera_params_t#

struct mpp_camera_params_t

Camera parameters.

Data Fields

type	name	description
int	height	buffer height
int	width	buffer width
mpp_pixel_format_t	format	pixel format
int	fps	frames per second
bool	stripe	stripe mode
void *	rpmsg_inst	pointer to rpmsg instance
volatile uint16_t *	mcmgr_event_data	pointer to mcmgr event data
uint32_t	n_streams	number of total output video streams
mpp_camera_stream_cfg	stream[NUM_STREAMS]	streams configuration
bool	in_advance_enqueue	enable in-advance enqueue mode

mpp_img_params_t#

struct mpp_img_params_t

Static image parameters.

Data Fields

type	name	description
int	height	buffer height
int	width	buffer width
mpp_pixel_format_t	format	pixel format
bool	stripe	stripe mode
int	compressed_size	size in bytes for compressed format

mpp_display_params_t#

struct mpp_display_params_t

Display parameters.

Data Fields

type	name	description
int	height	buffer resolution: setting to 0 will default to panel physical resolution
int	width	buffer resolution: setting to 0 will default to panel physical resolution
int	pitch	buffer resolution: setting to 0 will default to panel physical resolution
int	left	active rect: setting to 0 will default to fullscreen
int	top	active rect: setting to 0 will default to fullscreen
int	right	active rect: setting to 0 will default to fullscreen
int	bottom	active rect: setting to 0 will default to fullscreen
mpp_rotate_degree_t	rotate	rotate degree
mpp_pixel_format_t	format	pixel format
bool	stripe	stripe mode
void ∗	handle	pointer to an lvgl image widget

mpp_tensor_dims_t#

struct mpp_tensor_dims_t

Inference tensor dimensions.

Data Fields

type	name	description
uint32_t	size
uint32_t	data[[MAX_TENSOR_DIMS]]

mpp_inference_tensor_params_t#

struct mpp_inference_tensor_params_t

tensor parameters

Data Fields

type	name	description
const uint8_t ∗	data	data address
mpp_tensor_dims_t	dims	tensor data dimensions
mpp_tensor_type_t	type	tensor data type

mpp_inference_cb_param_t#

struct mpp_inference_cb_param_t

Inference callback parameters.

Data Fields

type	name	description
void ∗	user_data	callback will pass this pointer
mpp_inference_tensor_params_t ∗	out_tensors[[MPP_INFERENCE_MAX_OUTPUTS]]	output tensors parameters
int	inference_time_ms	inference run time measurement - output to user
mpp_inference_type_t	inference_type	type of the inference

mpp_color_t#

union mpp_color_t

mpp color encoding

Data Fields

type	name	description
uint32_t	raw	Raw color.
struct mpp_color_t.rgb	rgb	rgb color values RGB color

mpp_labeled_rect_t#

struct mpp_labeled_rect_t

mpp labeled rectangle element structure

Data Fields

type	name	description
uint8_t	label[64]	label to print
uint16_t	clear	clear rectangle
uint16_t	line_width	rectangle line thickness
mpp_color_t	line_color	rectangle line color
int16_t	top	rectangle top position
int16_t	left	rectangle left position
int16_t	bottom	rectangle bottom position
int16_t	right	rectangle right position
uint16_t	tag	labeled rectangle tag
uint16_t	reserved	pad for 32 bits alignment
bool	stripe	stripe mode

mpp_area_t#

struct mpp_area_t

Image area coordinates.

Data Fields

type	name	description
int	top
int	left
int	bottom
int	right

mpp_dims_t#

struct mpp_dims_t

Image dimensions.

Data Fields

type	name	description
unsigned int	width
unsigned int	height

mpp_position_t#

struct mpp_position_t

Image position.

Data Fields

type	name	description
int	top
int	left

struct mpp_inference_params_t

Model parameters.

Data Fields

type	name	description
uint64_t	constant_weight_MemSize	model constant weights memory size
uint64_t	mutable_weight_MemSize	Defines the amount of memory required both input & output data buffers.
uint64_t	activations_MemSize	Size of scratch memory used for intermediate computations needed by the model.
int	num_inputs	model’s number of inputs
int	num_outputs	model’s number of outputs
uint64_t	inputs_offsets[MPP_INFERENCE_MAX_INPUTS]	offset of each input
uint64_t	outputs_offsets[MPP_INFERENCE_MAX_OUTPUTS]	offset ofeach output
inference_entry_point_t	model_entry_point	function called to perform the inference
mpp_tensor_type_t	model_input_tensors_type	type of input buffer

mpp_element_params_t#

struct mpp_element_params_t

Static image and Processing elements parameters.

Data Fields

type	name	description
union mpp_element_params_t.unnamed5	__unnamed__
mpp_stats_t ∗	stats

mpp_stats_tapi#

struct mpp_stats_t.api

Data Fields

type	name	description
unsigned int	rc_cycle	run-to-completion (RC) cycle duration (ms)
unsigned int	rc_cycle_max	run-to-completion work deadline (ms)
unsigned int	pr_slot	available slot for preemptable (PR) work (ms)
unsigned int	pr_rounds	number of RC cycles required to complete one PR cycle (ms)
unsigned int	app_slot	remaining time for application (ms)
unsigned int	cpu_load	CPU load percentage (%)

mpp_stats_tmpp#

struct mpp_stats_t.mpp

Data Fields

type	name	description
mpp_t	mpp
unsigned int	mpp_exec_time	pipeline execution time (ms)

mpp_stats_telem#

struct mpp_stats_t.elem

Data Fields

type	name	description
mpp_elem_handle_t	hnd
unsigned int	elem_exec_time	element execution time (ms)

mpp_color_trgb#

struct mpp_color_t.rgb

rgb color values

Data Fields

type	name	description
uint8_t	R	Red byte.
uint8_t	G	Green byte.
uint8_t	B	Blue byte.
uint8_t	pad	padding byte

mpp_element_params_tunnamed5#

union mpp_element_params_t.__unnamed5__

Data Fields

type	name	description
mpp_camera_params_t	camera	Camera element’s parameters
struct mpp_element_params_t.unnamed5.static_image	static_image	Static Image element’s parameters.
struct mpp_element_params_t.unnamed5.compose	compose	Compose element’s parameters.
struct mpp_element_params_t.unnamed5.labels	labels	Labeled Rectangle element’s parameters.
struct mpp_element_params_t.unnamed5.convert	convert	Convert element’s parameters.
struct mpp_element_params_t.unnamed5.resize	resize	Resize element’s parameters.
struct mpp_element_params_t.unnamed5.color_conv	color_conv	Color convert element’s parameters.
struct mpp_element_params_t.unnamed5.rotate	rotate	Rotate element’s parameters.
struct mpp_element_params_t.unnamed5.test	test	Test element’s parameters.
struct mpp_element_params_t.unnamed5.decode	decode	Decoder element’s parameters.
struct mpp_element_params_t.unnamed5.ml_inference	ml_inference	ML inference element’s parameters.

mpp_element_params_tunnamed5static_image#

struct mpp_element_params_t.__unnamed5__.static_image

Static Image element’s parameters.

Data Fields

type	name	description
mpp_img_params_t	img_params	static image parameters
void ∗	img_buffer	static image buffer address

mpp_element_params_tunnamed5compose#

struct mpp_element_params_t.__unnamed5__.compose

Compose element’s parameters.

Data Fields

type	name	description
mpp_img_params_t	logo_img_params	logo image parameters
void *	logo_buffer	logo image buffer address
mpp_area_t	logo_area	logo image area
mpp_img_params_t	txt_img_params	text image parameters
void *	txt_buffer	text image buffer address
mpp_area_t	txt_area	text image area
mpp_area_t	input_area	input image area
mpp_rotate_degree_t	out_angle	output rotation angle
mpp_flip_mode_t	out_flip	output flip mode
mpp_pixel_format_t	out_format	output color format
int	out_width	output buffer width
int	out_height	output buffer height

struct mpp_element_params_t.__unnamed5__.labels

Labeled Rectangle element’s parameters.

Data Fields

type	name	description
uint32_t	max_rect	maximum number of rectangles
uint32_t	detected_rect	detected rectangles
mpp_labeled_rect_t ∗	rectangles	array of rectangle data
uint32_t	max_landmk	maximum number of landmarks
uint32_t	detected_landmk	detected landmarks
mpp_landmark_t *	landmarks	array of landmark data

mpp_element_params_tunnamed5convert#

struct mpp_element_params_t.__unnamed5__.convert

Convert element’s parameters.

Data Fields

type	name	description
mpp_dims_t	out_buf	output buffer dimensions
mpp_pixel_format_t	pixel_format	new pixel format
mpp_rotate_degree_t	angle	rotation angle
mpp_flip_mode_t	flip	flip mode
mpp_area_t	crop	input crop area
mpp_position_t	out_window	output window position
mpp_dims_t	scale	scaling dimensions
mpp_convert_ops_t	ops	operation selector mask
const char ∗	dev_name	device name used for graphics
bool	stripe_in	input stripe mode
bool	stripe_out	output stripe mode

mpp_element_params_tunnamed5resize#

struct mpp_element_params_t.__unnamed5__.resize

Resize element’s parameters.

Data Fields

type	name	description
unsigned int	width
unsigned int	height

mpp_element_params_tunnamed5color_conv#

struct mpp_element_params_t.__unnamed5__.color_conv

Color convert element’s parameters.

Data Fields

type	name	description
mpp_pixel_format_t	pixel_format

struct mpp_element_params_t.__unnamed5__.rotate

Rotate element’s parameters.

Data Fields

type	name	description
mpp_rotate_degree_t	angle

mpp_element_params_tunnamed5test#

struct mpp_element_params_t.__unnamed5__.test

Test element’s parameters.

Data Fields

type	name	description
_Bool	inp
unsigned int	width
unsigned int	height
mpp_pixel_format_t	format

mpp_element_params_tunnamed5decode#

struct mpp_element_params_t.__unnamed5__.decode

Decoder element’s parameters.

Data Fields

type	name	description
const char ∗	dev_name	device name used for decoder
unsigned int	width
unsigned int	height
mpp_pixel_format_t	out_format

mpp_element_params_tunnamed5ml_inference#

struct mpp_element_params_t.__unnamed5__.ml_inference

ML inference element’s parameters.

Data Fields

type	name	description
const void ∗	model_data	pointer to model binary
mpp_inference_type_t	type	inference type
int	model_size	model binary size
float	model_input_mean	model ‘mean’ of input values, used for normalization
float	model_input_std	model ‘standard deviation’ of input values, used for normalization
mpp_tensor_order_t	tensor_order	model input tensor component order
mpp_inference_params_t	inference_params	model specific parameters used by the inference

mpp_camera_stream_cfg#

struct mpp_camera_stream_cfg

Camera stream configuration for multi-stream cameras.

Data Fields

type	name	description
mpp_camera_stream_type	type	Stream type (member of enum mpp_camera_stream_type)
bool	active	Stream is active or not.

struct mpp_landmark_t

mpp landmark structure

Data Fields

type	name	description
uint16_t	clear	clear landmark
uint16_t	width	landmark thickness
mpp_color_t	color	landmark color
int16_t	x	landmark x position
int16_t	y	landmark y position
uint16_t	tag	landmark tag
bool	stripe	stripe mode

2.1.2 Macro Definition Documentation#

MPP_INFERENCE_MAX_OUTPUTS

mpp_inference_max_outputs#

#define MPP_INFERENCE_MAX_OUTPUTS

Maximum number of inference inputs and outputs. Maximum number of outputs supported by the pipeline

mpp_inference_max_inputs#

mpp_element_params_tunnamed5decode#

#define MPP_INFERENCE_MAX_INPUTS

Maximum number of inputs supported by the pipeline.

mpp_invalid#

#define MPP_INVALID Invalid pipeline handle.

mpp_event_all#

#define MPP_EVENT_ALL

max_tensor_dims#

Bit mask to receive all Events.

#define MAX_TENSOR_DIMS

Maximum number of dimensions for tensors.

2.1.3 Typedef Documentation#

mpp_t#

typedef void∗ mpp_t Pipeline handle type.

mpp_elem_handle_t#

typedef uintptr_t mpp_elem_handle_t Element handle type.

mpp_evt_mask_t#

typedef unsigned int mpp_evt_mask_t Event mask for pipeline creation.

inference_entry_point_t#

typedef int(∗ inference_entry_point_t) (uint8_t ∗, uint8_t ∗, uint8_t ∗) Bundle inference function type.

2.1.4 Enumeration Type Documentation#

mpp_evt_t#

enum mpp_evt_t

Pipeline generated events.

Enumerator

label	description
MPP_EVENT_INVALID	invalid event
MPP_EVENT_INFERENCE_OUTPUT_READY	inference out is ready
MPP_EVENT_INTERNAL_TEST_RESERVED	INTERNAL: DO NOT USE.
MPP_EVENT_NUM	DO NOT USE.

mpp_exec_flag_t#

enum mpp_exec_flag_t

Execution parameters.

These parameters control the execution of the elements of an mpp.

The “mpps” created using the flag MPP_EXEC_RC are guaranteed to run up to the completion of all processing elements, while not being preempted by other “mpps”.

The “mpps” created using the flag MPP_EXEC_PREEMPT are preempted after a given time interval by “mpps” that will run-to-completion again.

The “mpps” created with the MPP_EXEC_INHERIT flag inherit the same execution flag as the parent(s) in case of split operation.

Note: It is not possible to request run-to-completion execution when spliting preemptable-execution “mpps”.

Enumerator

label	description
MPP_EXEC_INHERIT	inherit from parent(s)
MPP_EXEC_RC	run-to-completion
MPP_EXEC_PREEMPT	preemptable

mpp_stats_grp_t#

enum mpp_stats_grp_t

Enumerator

label	description
MPP_STATS_GRP_API	API (global) stats.
MPP_STATS_GRP_MPP	mpp_t stats
MPP_STATS_GRP_ELEMENT	element stats
MPP_STATS_GRP_NUM	number of groups

mpp_rotate_degree_t#

enum mpp_rotate_degree_t

Rotation value.

Enumerator

label	description
ROTATE_0	0 degree
ROTATE_90	90 degrees
ROTATE_180	180 degrees
ROTATE_270	270 degrees

mpp_flip_mode_t#

enum mpp_flip_mode_t

Flip type.

Enumerator

label	description
FLIP_NONE	no flip
FLIP_HORIZONTAL	horizontal flip
FLIP_VERTICAL	vertical flip
FLIP_BOTH	vertical and horizontal flip

mpp_convert_ops_t#

enum mpp_convert_ops_t

The convert operations selector flags.

Enumerator

label	description
MPP_CONVERT_NONE	no frame conversion
MPP_CONVERT_ROTATE	frame rotation and flip
MPP_CONVERT_SCALE	scaling from input_frame toward output window
MPP_CONVERT_COLOR	frame color conversion
MPP_CONVERT_CROP	input frame crop
MPP_CONVERT_OUT_WINDOW	output window

mpp_pixel_format_t#

enum mpp_pixel_format_t

Pixel format.

Enumerator

label	description
MPP_PIXEL_ARGB	ARGB 32 bits.
MPP_PIXEL_BGRA	BGRA 32 bits.
MPP_PIXEL_RGBA	RGBA 32 bits.
MPP_PIXEL_BGRX	BGRX 32 bits.
MPP_PIXEL_RGBX	RGBX 32 bits.
MPP_PIXEL_RGB	RGB 24 bits.
MPP_PIXEL_RGB565	RGB 16 bits.
MPP_PIXEL_BGR	BGR 24 bits.
MPP_PIXEL_GRAY888	gray 3x8 bits
MPP_PIXEL_GRAY888X	gray 3x8 bits +8 unused bits
MPP_PIXEL_GRAY	gray 8 bits
MPP_PIXEL_GRAY16	gray 16 bits
MPP_PIXEL_YUV1P444	YUVX interleaved 4:4:4.
MPP_PIXEL_VYUY1P422	VYUY interleaved 4:2:2.
MPP_PIXEL_UYVY1P422	UYVY interleaved 4:2:2.
MPP_PIXEL_YUYV	YUYV interleaved 4:2:2.
MPP_PIXEL_DEPTH16	depth 16 bits
MPP_PIXEL_DEPTH8	depth 8 bits
MPP_PIXEL_YUV420P	YUV planar 4:2:0.
MPP_PIXEL_JPEG	JPEG.
MPP_PIXEL_INVALID	invalid pixel format

mpp_element_id_t#

enum mpp_element_id_t

Processing element ids.

Enumerator

label	description
MPP_ELEMENT_INVALID	Invalid element.
MPP_ELEMENT_IMG_COMPOSE	Image composition - compose a simple GUI: logo and text area with the input stream.
MPP_ELEMENT_LABELED_RECTANGLE	Labeled rectangle - bounding box.
MPP_ELEMENT_TEST	Test inplace element - NOT FOR USE.
MPP_ELEMENT_INFERENCE	Inference engine.
MPP_ELEMENT_CONVERT	Image conversion: resolution, orientation, color format.
MPP_ELEMENT_IMG_DECODE	Image decompression: JPEG, PNG.
MPP_ELEMENT_NUM	DO NOT USE.

mpp_tensor_type_t#

enum mpp_tensor_type_t

Inference tensor type.

Enumerator

label	description
MPP_TENSOR_TYPE_FLOAT32	floating point 32 bits
MPP_TENSOR_TYPE_UINT8	unsigned integer 8 bits
MPP_TENSOR_TYPE_INT8	signed integer 8 bits

mpp_tensor_order_t

enum mpp_tensor_order_t

Inference input tensor order.

Enumerator

label	description
MPP_TENSOR_ORDER_UNKNOWN	order not set
MPP_TENSOR_ORDER_NHWC	order: Batch, Height, Width, Channels
MPP_TENSOR_ORDER_NCHW	order: Batch, Channels, Height, Width

mpp_inference_type_t#

enum mpp_inference_type_t

Inference type.

Enumerator

label	description
MPP_INFERENCE_TYPE_TFLITE	TensorFlow-Lite.

mpp_camera_stream_type#

enum mpp_camera_stream_type

Enumerator

label	description
RGB_STREAM	Frames received by the virtual camera element ar in rgb format
IR_STREAM	Frames received by the virtual camera element ar in ir format
NUM_STREAMS	Total number of frame types suported by virtual camera element

3. Return_codes#

return_codes#

Macros

#define MPP_SUCCESS
#define MPP_ERROR
#define MPP_INVALID_ELEM
#define MPP_INVALID_PARAM
#define MPP_ERR_ALLOC_MUTEX
#define MPP_INVALID_MUTEX
#define MPP_MUTEX_TIMEOUT
#define MPP_MUTEX_ERROR
#define MPP_MALLOC_ERROR

3.1 Detailed Description#

MPP APIs return status definitions.

3.1.1 Macro Definition Documentation#

mpp_success#

#define MPP_SUCCESS

Success return code.

mpp_error#

#define MPP_ERROR

A generic error occured.

mpp_invalid_elem#

#define MPP_INVALID_ELEM

Invalid element provided.

mpp_invalid_param#

#define MPP_INVALID_PARAM

Invalid parameter provided.

mpp_err_alloc_mutex#

#define MPP_ERR_ALLOC_MUTEX

Error occured while allocating mutex.

mpp_invalid_mutex#

#define MPP_INVALID_MUTEX

Invalid mutex provided.

mpp_mutex_timeout#

#define MPP_MUTEX_TIMEOUT

Mutex timeout occured.

mpp_malloc_error#

#define MPP_MUTEX_ERROR

Mutex error occured.

#define MPP_MALLOC_ERROR

Memory allocation error occured.

eIQ MCU Media Processing Pipeline API

Contents

eIQ MCU Media Processing Pipeline API#

1. MPP API#

1.1 Detailed Description#

1.1.1 Function Documentation#

mpp_api_init#

mpp_create#

mpp_camera_add#

mpp_static_img_add#

mpp_display_add#

mpp_nullsink_add#

mpp_element_add#

mpp_split#

mpp_background#

mpp_element_update#

mpp_start#

mpp_stop#

mpp_stats_enable#

mpp_stats_disable#

mpp_get_version#

mpp_is_running#

mpp_force_update#

2. MPP Types#

2.1 Detailed Description#

2.1.1 Data Structure Documentation#

mpp_stats_t#

mpp_api_params_t#

mpp_params_t#

mpp_stats_t#

mpp_camera_params_t#

mpp_img_params_t#

mpp_display_params_t#

mpp_tensor_dims_t#

mpp_inference_tensor_params_t#

mpp_inference_cb_param_t#

mpp_color_t#

mpp_labeled_rect_t#

mpp_area_t#

mpp_dims_t#

mpp_position_t#

mpp_element_params_t#

mpp_stats_tapi#

mpp_stats_tmpp#

mpp_stats_telem#

mpp_color_trgb#

mpp_element_params_t__unnamed5__#

mpp_element_params_t__unnamed5__static_image#

mpp_element_params_t__unnamed5__compose#

mpp_element_params_t__unnamed5__convert#

mpp_element_params_t__unnamed5__resize#

mpp_element_params_t__unnamed5__color_conv#

mpp_element_params_t__unnamed5__test#

mpp_element_params_t__unnamed5__decode#

mpp_element_params_t__unnamed5__ml_inference#

mpp_camera_stream_cfg#

2.1.2 Macro Definition Documentation#

mpp_inference_max_outputs#

mpp_inference_max_inputs#

mpp_element_params_t__unnamed5__decode#

mpp_invalid#

mpp_event_all#

max_tensor_dims#

2.1.3 Typedef Documentation#

mpp_t#

mpp_elem_handle_t#

mpp_evt_mask_t#

inference_entry_point_t#

2.1.4 Enumeration Type Documentation#

mpp_evt_t#

mpp_exec_flag_t#

mpp_stats_grp_t#

mpp_rotate_degree_t#

mpp_flip_mode_t#

mpp_convert_ops_t#

mpp_pixel_format_t#

mpp_element_id_t#

mpp_tensor_type_t#

mpp_inference_type_t#

mpp_camera_stream_type#

mpp_element_params_tunnamed5#

mpp_element_params_tunnamed5static_image#

mpp_element_params_tunnamed5compose#

mpp_element_params_tunnamed5convert#

mpp_element_params_tunnamed5resize#

mpp_element_params_tunnamed5color_conv#

mpp_element_params_tunnamed5test#

mpp_element_params_tunnamed5decode#

mpp_element_params_tunnamed5ml_inference#

mpp_element_params_tunnamed5decode#