mpi_index.h File Reference

Data types and methods for indexing MPI objects. More...

#include "mpi_types.h"
#include "mpi_limits.h"

Data Structures
union	MPI_DEV
union	MPI_PATH
union	MPI_CHN
union	MPI_WIN
union	MPI_ECHN
union	MPI_BCHN

Macros
#define	MPI_VALUE_INVALID   0xFFFFFFFF
#define	MPI_BYTE_INVALID   0xFF
#define	MPI_BYTE_ALL   0xFE
#define	MPI_VIDEO_DEV(d)   ((MPI_DEV){ {.dev = (d), .dummy2 = MPI_BYTE_INVALID, .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })
#define	VALID_MPI_VIDEO_DEV(i)
#define	MPI_INPUT_PATH(d, p)   ((MPI_PATH){ {.dev = (d), .path = (p), .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })
#define	VALID_MPI_INPUT_PATH(i)
#define	MPI_VIDEO_CHN(d, c)   ((MPI_CHN){ {.dev = (d), .chn = (c), .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })
#define	VALID_MPI_VIDEO_CHN(i)
#define	MPI_VIDEO_WIN(d, c, w)   ((MPI_WIN){ {.dev = (d), .chn = (c), .win = (w), .dummy0 = MPI_BYTE_INVALID } })
#define	VALID_MPI_VIDEO_WIN(i)
#define	MPI_ENC_CHN(c)
#define	VALID_MPI_ENC_CHN(i)
#define	MPI_ENC_BCHN(c, b)
#define	VALID_MPI_ENC_BCHN(i)
#define	MPI_GET_VIDEO_DEV(idx)   ((idx).dev)
#define	MPI_GET_INPUT_PATH(idx)   ((idx).path)
#define	MPI_GET_VIDEO_CHN(idx)   ((idx).chn)
#define	MPI_GET_VIDEO_WIN(idx)   ((idx).win)
#define	MPI_GET_ENC_CHN(idx)   ((idx).chn)
#define	MPI_INVALID_VIDEO_DEV   MPI_VIDEO_DEV(MPI_BYTE_INVALID)
#define	MPI_INVALID_INPUT_PATH   MPI_INPUT_PATH(MPI_BYTE_INVALID, MPI_BYTE_INVALID)
#define	MPI_INVALID_VIDEO_CHN   MPI_VIDEO_CHN(MPI_BYTE_INVALID, MPI_BYTE_INVALID)
#define	MPI_INVALID_VIDEO_WIN   MPI_VIDEO_WIN(MPI_BYTE_INVALID, MPI_BYTE_INVALID, MPI_BYTE_INVALID)
#define	MPI_INVALID_ENC_CHN   MPI_ENC_CHN(MPI_BYTE_INVALID)
#define	MPI_INVALID_ENC_BCHN   MPI_ENC_BCHN(MPI_BYTE_INVALID, MPI_BYTE_INVALID)

Detailed Description

Data types and methods for indexing MPI objects.

Macro Definition Documentation

#define MPI_BYTE_ALL   0xFE

A short-hand notation for byte "ALL"

#define MPI_BYTE_INVALID   0xFF

A short-hand notation for byte "INVALID"

#define MPI_ENC_BCHN	(		c,
			b
	)

Value:

((MPI_BCHN){                                                                                                   \
                {.chn = (c), .bchn = (b), .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })

A function to set MPI index of encoder channel

#define MPI_ENC_CHN

(

c

)

Value:

((MPI_ECHN){                                                                                                   \
                {.chn = (c), .dummy2 = MPI_BYTE_INVALID, .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })

A function to set MPI index of encoder channel

#define MPI_GET_ENC_CHN

(

idx

)

((idx).chn)

A legacy function to get encoder channel index from MPI index

#define MPI_GET_INPUT_PATH

(

idx

)

((idx).path)

A legacy function to get input path index from MPI index

#define MPI_GET_VIDEO_CHN

(

idx

)

((idx).chn)

A legacy function to get video channel index from MPI index

#define MPI_GET_VIDEO_DEV

(

idx

)

((idx).dev)

A legacy function to get video device index from MPI index

#define MPI_GET_VIDEO_WIN

(

idx

)

((idx).win)

A legacy function to get video window index from MPI index

#define MPI_INPUT_PATH	(		d,
			p
	)		((MPI_PATH){ {.dev = (d), .path = (p), .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })

A macro to set MPI index of input path

#define MPI_INVALID_ENC_BCHN   MPI_ENC_BCHN(MPI_BYTE_INVALID, MPI_BYTE_INVALID)

A short-hand notation for invalid MPI_ECHN

#define MPI_INVALID_ENC_CHN   MPI_ENC_CHN(MPI_BYTE_INVALID)

A short-hand notation for invalid MPI_ECHN

#define MPI_INVALID_INPUT_PATH   MPI_INPUT_PATH(MPI_BYTE_INVALID, MPI_BYTE_INVALID)

A short-hand notation for invalid MPI_PATH

#define MPI_INVALID_VIDEO_CHN   MPI_VIDEO_CHN(MPI_BYTE_INVALID, MPI_BYTE_INVALID)

A short-hand notation for invalid MPI_CHN

#define MPI_INVALID_VIDEO_DEV   MPI_VIDEO_DEV(MPI_BYTE_INVALID)

A short-hand notation for invalid MPI_DEV

#define MPI_INVALID_VIDEO_WIN   MPI_VIDEO_WIN(MPI_BYTE_INVALID, MPI_BYTE_INVALID, MPI_BYTE_INVALID)

A short-hand notation for invalid MPI_WIN

#define MPI_VALUE_INVALID   0xFFFFFFFF

A short-hand notation for value "INVALID"

#define MPI_VIDEO_CHN	(		d,
			c
	)		((MPI_CHN){ {.dev = (d), .chn = (c), .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })

A macro to set MPI index of video channel

#define MPI_VIDEO_DEV

(

d

)

((MPI_DEV){ {.dev = (d), .dummy2 = MPI_BYTE_INVALID, .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })

A macro to set MPI index of video device

#define MPI_VIDEO_WIN	(		d,
			c,
			w
	)		((MPI_WIN){ {.dev = (d), .chn = (c), .win = (w), .dummy0 = MPI_BYTE_INVALID } })

A macro to set MPI index of video widow

#define VALID_MPI_ENC_BCHN

(

i

)

Value:

(((i).chn != MPI_BYTE_INVALID) && ((i).bchn != MPI_BYTE_INVALID) && ((i).dummy0 == MPI_BYTE_INVALID) &&      \
         ((i).dummy1 == MPI_BYTE_INVALID))

A macro to check MPI index of video widow

#define VALID_MPI_ENC_CHN

(

i

)

Value:

(((i).chn != MPI_BYTE_INVALID) && ((i).dummy0 == MPI_BYTE_INVALID) && ((i).dummy1 == MPI_BYTE_INVALID) &&      \
         ((i).dummy2 == MPI_BYTE_INVALID))

A macro to check MPI index of video widow

#define VALID_MPI_INPUT_PATH

(

i

)

Value:

(((i).dev != MPI_BYTE_INVALID) && ((i).path != MPI_BYTE_INVALID) && ((i).dummy0 == MPI_BYTE_INVALID) &&        \
         ((i).dummy1 == MPI_BYTE_INVALID))

A macro to check MPI index of input path

#define VALID_MPI_VIDEO_CHN

(

i

)

Value:

(((i).dev != MPI_BYTE_INVALID) && ((i).chn != MPI_BYTE_INVALID) && ((i).dummy0 == MPI_BYTE_INVALID) &&         \
         ((i).dummy1 == MPI_BYTE_INVALID))

A macro to check MPI index of video channel

#define VALID_MPI_VIDEO_DEV

(

i

)

Value:

(((i).dev != MPI_BYTE_INVALID) && ((i).dummy0 == MPI_BYTE_INVALID) && ((i).dummy1 == MPI_BYTE_INVALID) &&      \
         ((i).dummy2 == MPI_BYTE_INVALID))

A macro to check MPI index of video device

#define VALID_MPI_VIDEO_WIN

(

i

)

Value:

(((i).dev != MPI_BYTE_INVALID) && ((i).chn != MPI_BYTE_INVALID) && ((i).win != MPI_BYTE_INVALID) &&            \
         ((i).dummy0 == MPI_BYTE_INVALID))

A macro to check MPI index of video widow