MPP Programming Interface Reference Manual  jpl-r3.1.0
mpi_base_types.h File Reference

MPI data types. More...

#include <stdbool.h>
#include <stdint.h>

Data Structures

union  MPI_PATH_BMP_U
 Union for the sensor path bitmap. More...
 
struct  MPI_RANGE_S
 Struct for a range. More...
 
struct  MPI_POINT_S
 Struct for a pixel position. More...
 
struct  MPI_SHIFT_S
 Struct for a pixel shift from a reference point. More...
 
struct  MPI_PORCH_S
 Struct for a porch. More...
 
struct  MPI_SIZE_S
 Struct for an image size. More...
 
struct  MPI_BUF_SIZE_S
 Struct for an buffer size. More...
 
struct  MPI_RECT_S
 Struct for an rectangle. More...
 
struct  MPI_RECT_POINT_S
 Struct for a rectangle start and end point. More...
 
struct  MPI_MOTION_VEC_S
 Struct for a motion vector. More...
 

Macros

#define MPI_BLOCKING_TIMEOUT_VALUE   (-1)
 
#define MPI_STATE_NONE   0x0000
 
#define MPI_STATE_STOP   0x0001
 
#define MPI_STATE_RUN   0x0002
 
#define MPI_STATE_SUSPEND   0x0003
 
#define MPI_STATE_IS_STOP(s)   ((s) == MPI_STATE_STOP)
 
#define MPI_STATE_IS_RUN(s)   ((s) == MPI_STATE_RUN)
 
#define MPI_STATE_IS_SUSPEND(s)   ((s) == MPI_STATE_SUSPEND)
 
#define MPI_STATE_IS_ADDED(s)   ((s) > MPI_STATE_NONE)
 
#define MPI_STATE_IS_ACTIVE(s)   ((s) == MPI_STATE_RUN || (s) == MPI_STATE_SUSPEND)
 
#define MPI_STATE_IS_INACTIVE(s)   ((s) == MPI_STATE_NONE || (s) == MPI_STATE_STOP)
 
#define MPI_SUCCESS   (0)
 
#define MPI_FAILURE   (-1)
 
#define MPI_UNUSED(x)   (void)(x)
 
#define MPI_VOID   void
 
#define VOID   void
 
#define REMOVE_AGTX_BOOL
 
#define TRUE   (true)
 
#define FALSE   (false)
 

Typedefs

typedef bool BOOL
 
typedef uint8_t UINT8
 a typedef for UINT8.
 
typedef uint16_t UINT16
 a typedef for UINT16.
 
typedef uint32_t UINT32
 a typedef for UINT32.
 
typedef uint64_t UINT64
 a typedef for UINT64.
 
typedef int8_t INT8
 a typedef for INT8.
 
typedef int16_t INT16
 a typedef for INT16.
 
typedef int32_t INT32
 a typedef for INT32.
 
typedef int64_t INT64
 a typedef for INT64.
 
typedef float FLOAT
 a typedef for FLOAT.
 

Enumerations

enum  MPI_IMG_TYPE_E {
  MPI_IMG_TYPE_BAYER, MPI_IMG_TYPE_YUV420, MPI_IMG_TYPE_YUV422, MPI_IMG_TYPE_NRW,
  MPI_IMG_TYPE_MV, MPI_IMG_TYPE_NUM
}
 Image type.
 
enum  MPI_BAYER_E {
  MPI_BAYER_PHASE_G0, MPI_BAYER_PHASE_R, MPI_BAYER_PHASE_B, MPI_BAYER_PHASE_G1,
  MPI_BAYER_PHASE_NUM
}
 Enumeration of Bayer phase. More...
 
enum  MPI_POS_E {
  MPI_POS_NONE, MPI_POS_UP, MPI_POS_DOWN, MPI_POS_LEFT,
  MPI_POS_RIGHT, MPI_POS_NUM
}
 Enumeration of position. More...
 
enum  MPI_ROTATE_TYPE_E {
  MPI_ROTATE_0 = 0, MPI_ROTATE_90, MPI_ROTATE_180, MPI_ROTATE_270,
  MPI_ROTATE_TYPE_NUM
}
 Enumeration of rotation type. More...
 
enum  MPI_MODE_E { MPI_MODE_ONLINE, MPI_MODE_OFFLINE, MPI_MODE_NUM }
 Enumeration of device/channel mode. More...
 

Detailed Description

MPI data types.

Macro Definition Documentation

#define MPI_BLOCKING_TIMEOUT_VALUE   (-1)

Definition of blocking timeout value.

#define MPI_FAILURE   (-1)

Definition of failure in MPI.

#define MPI_STATE_IS_ACTIVE (   s)    ((s) == MPI_STATE_RUN || (s) == MPI_STATE_SUSPEND)

To check whether state is active.

#define MPI_STATE_IS_ADDED (   s)    ((s) > MPI_STATE_NONE)

To check whether state is added.

#define MPI_STATE_IS_INACTIVE (   s)    ((s) == MPI_STATE_NONE || (s) == MPI_STATE_STOP)

To check whether state is inactive.

#define MPI_STATE_IS_RUN (   s)    ((s) == MPI_STATE_RUN)

To check whether state is run.

#define MPI_STATE_IS_STOP (   s)    ((s) == MPI_STATE_STOP)

To check whether state is stop.

#define MPI_STATE_IS_SUSPEND (   s)    ((s) == MPI_STATE_SUSPEND)

To check whether state is suspend.

#define MPI_STATE_NONE   0x0000

Definition of none state.

#define MPI_STATE_RUN   0x0002

Definition of run state.

#define MPI_STATE_STOP   0x0001

Definition of stop state.

#define MPI_STATE_SUSPEND   0x0003

Definition of suspend state.

#define MPI_SUCCESS   (0)

Definition of success in MPI.

#define MPI_UNUSED (   x)    (void)(x)

Definition of unused in MPI.

#define MPI_VOID   void

Definition of void in MPI.

#define VOID   void

Definition of void.

Enumeration Type Documentation

Enumeration of Bayer phase.

Enumerator
MPI_BAYER_PHASE_G0 

Bayer phase G0.

MPI_BAYER_PHASE_R 

Bayer phase R.

MPI_BAYER_PHASE_B 

Bayer phase B.

MPI_BAYER_PHASE_G1 

Bayer phase G1.

MPI_BAYER_PHASE_NUM 

The number of Bayer phase.

enum MPI_MODE_E

Enumeration of device/channel mode.

Enumerator
MPI_MODE_ONLINE 

Online mode.

MPI_MODE_OFFLINE 

Offline mode.

MPI_MODE_NUM 

The number of device/channel mode.

enum MPI_POS_E

Enumeration of position.

Enumerator
MPI_POS_NONE 

Un-defined.

MPI_POS_UP 

Up.

MPI_POS_DOWN 

Down.

MPI_POS_LEFT 

Left.

MPI_POS_RIGHT 

Right.

MPI_POS_NUM 

Position number.

Enumeration of rotation type.

Enumerator
MPI_ROTATE_0 

Rotate 0 degree.

MPI_ROTATE_90 

Rotate 90 degree.

MPI_ROTATE_180 

Rotate 180 degree.

MPI_ROTATE_270 

Rotate 270 degree.

MPI_ROTATE_TYPE_NUM 

The number of rotation type.