mpi_index.h File Reference

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

#include "mpi_base_types.h"
#include "mpi_limits.h"

Data Structures
union	MPI_DEV
	MPI index of video device. More...
union	MPI_PATH
	MPI index of input path. More...
union	MPI_CHN
	MPI index of video channel. More...
union	MPI_WIN
	MPI index of video window. More...
union	MPI_ECHN
	MPI index of encoder channel. More...
union	MPI_BCHN
	MPI index of bit-stream channel. More...

Macros
#define	MPI_VALUE_INVALID   _Pragma("GCC warning \"'MPI_VALUE_INVALID' macro is deprecated\"") 0x80808080
#define	MPI_BYTE_INVALID   0x80
	A short-hand notation for byte "INVALID".
#define	MPI_BYTE_ALL   _Pragma("GCC warning \"'MPI_BYTE_ALL' macro is deprecated\"") 0xFE
#define	MPI_VIDEO_DEV(d)
	A macro to set MPI index of video device. More...
#define	VALID_MPI_VIDEO_DEV(i)
	A macro to check MPI index of video device. More...
#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. More...
#define	VALID_MPI_INPUT_PATH(i)
	A macro to check MPI index of input path. More...
#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. More...
#define	VALID_MPI_VIDEO_CHN(i)
	A macro to check MPI index of video channel. More...
#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. More...
#define	VALID_MPI_VIDEO_WIN(i)
	A macro to check MPI index of video widow. More...
#define	MPI_ENC_CHN(c)
	A function to set MPI index of encoder channel. More...
#define	VALID_MPI_ENC_CHN(i)
	A macro to check MPI index of video widow. More...
#define	MPI_ENC_BCHN(c, b)   ((MPI_BCHN){ { .chn = (c), .bchn = (b), .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })
	A function to set MPI index of encoder bit-stream channel. More...
#define	VALID_MPI_ENC_BCHN(i)
	A macro to check MPI index of encoder bit-stream channel. More...
#define	MPI_INVALID_VIDEO_DEV   MPI_VIDEO_DEV(MPI_BYTE_INVALID)
	A short-hand notation for invalid MPI_DEV.
#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_WIN   MPI_VIDEO_WIN(MPI_BYTE_INVALID, MPI_BYTE_INVALID, MPI_BYTE_INVALID)
	A short-hand notation for invalid MPI_WIN.
#define	MPI_INVALID_ENC_CHN   MPI_ENC_CHN(MPI_BYTE_INVALID)
	A short-hand notation for invalid MPI_ECHN.
#define	MPI_INVALID_ENC_BCHN   MPI_ENC_BCHN(MPI_BYTE_INVALID, MPI_BYTE_INVALID)
	A short-hand notation for invalid MPI_ECHN.

Detailed Description

Data types and methods for indexing MPI objects.

Macro Definition Documentation

#define MPI_BYTE_ALL   _Pragma("GCC warning \"'MPI_BYTE_ALL' macro is deprecated\"") 0xFE

Deprecated:

Macro MPI_BYTE_ALL is no longer used in MPI.

#define MPI_ENC_BCHN	(		c,
			b
	)		((MPI_BCHN){ { .chn = (c), .bchn = (b), .dummy1 = MPI_BYTE_INVALID, .dummy0 = MPI_BYTE_INVALID } })

A function to set MPI index of encoder bit-stream channel.

Parameters

[in]	c	encoder channel index
[in]	b	bit-stream channel index

#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.

Parameters

[in]

c

encoder channel 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.

Parameters

[in]	d	video device index
[in]	p	input path index

#define MPI_VALUE_INVALID   _Pragma("GCC warning \"'MPI_VALUE_INVALID' macro is deprecated\"") 0x80808080

Deprecated:

User should check whether a MPI index is valid with macros instead of checking whether idx.value and MPI_VALUE_INVALID are equal.

See also

VALID_MPI_ENC_BCHN()

#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.

Parameters

[in]	d	video device index
[in]	c	video channel index

#define MPI_VIDEO_DEV

(

d

)

Value:

((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.

Parameters

[in]

d

video device index

#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.

Parameters

[in]	d	video device index
[in]	c	video channel index
[in]	w	video window index

#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 encoder bit-stream channel.

Parameters

[in]

i

MPI_BCHN

Returns

Boolean. True if input argument is valid index for bit-stream channel.

#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.

Parameters

[in]

i

MPI_ECHN

Returns

Boolean. True if input argument is valid index for encoder channel.

#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.

Parameters

[in]

i

MPI_PATH

Returns

Boolean. True if input argument is valid index for 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.

Parameters

[in]

i

MPI_CHN

Returns

Boolean. True if input argument is valid index for 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.

Parameters

[in]

i

MPI_DEV

Returns

Boolean. True if input argument is valid index for 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.

Parameters

[in]

i

MPI_WIN

Returns

Boolean. True if input argument is valid index for video window.