Image Encoder Synchronization

Detailed Description

The NvMedia IEP NvSciSync API encompasses all NvMediaIEP NvSciSync handling functions.

Macros
#define	NVMEDIA_IEP_NVSCISYNC_VERSION_MAJOR   1
	Major version number. More...
#define	NVMEDIA_IEP_NVSCISYNC_VERSION_MINOR   1
	Minor version number. More...
#define	NVMEDIA_IEP_MAX_PRENVSCISYNCFENCES   (3U)
	Specifies the maximum number of times NvMediaIEPInsertPreNvSciSyncFence() can be called before each call to NvMediaIEPFeedFrame(). More...

Functions
NvMediaStatus	NvMediaIEPNvSciSyncGetVersion (NvMediaVersion *version)
	Returns the version information for the NvMedia IEP NvSciSync library. More...
NvMediaStatus	NvMediaIEPFillNvSciSyncAttrList (const NvMediaIEP *encoder, NvSciSyncAttrList attrlist, NvMediaNvSciSyncClientType clienttype)
	Fills the NvMediaIEP specific NvSciSync attributes. More...
NvMediaStatus	NvMediaIEPRegisterNvSciSyncObj (const NvMediaIEP *encoder, NvMediaNvSciSyncObjType syncobjtype, NvSciSyncObj nvscisync)
	Registers an NvSciSyncObj with NvMediaIEP. More...
NvMediaStatus	NvMediaIEPUnregisterNvSciSyncObj (const NvMediaIEP *encoder, NvSciSyncObj nvscisync)
	Unregisters an NvSciSyncObj with NvMediaIEP. More...
NvMediaStatus	NvMediaIEPSetNvSciSyncObjforEOF (const NvMediaIEP *encoder, NvSciSyncObj nvscisyncEOF)
	Specifies the NvSciSyncObj to be used for an EOF NvSciSyncFence. More...
NvMediaStatus	NvMediaIEPInsertPreNvSciSyncFence (const NvMediaIEP *encoder, const NvSciSyncFence *prenvscisyncfence)
	Sets an NvSciSyncFence as a prefence for an NvMediaIEPFeedFrame() NvSciSyncFence operation. More...
NvMediaStatus	NvMediaIEPGetEOFNvSciSyncFence (const NvMediaIEP *encoder, NvSciSyncObj eofnvscisyncobj, NvSciSyncFence *eofnvscisyncfence)
	Gets EOF NvSciSyncFence for an NvMediaIEPFeedFrame() operation. More...
NvMediaStatus	NvMediaIEPSetNvSciSyncObjforSOF (const NvMediaIEP *encoder, NvSciSyncObj nvscisyncSOF)
	Specifies the NvSciSyncObj to be used for an SOF NvSciSyncFence. More...
NvMediaStatus	NvMediaIEPGetSOFNvSciSyncFence (const NvMediaIEP *encoder, NvSciSyncObj sofnvscisyncobj, NvSciSyncFence *sofnvscisyncfence)
	Gets SOF NvSciSyncFence for an NvMediaIEPFeedFrame() operation. More...

Macro Definition Documentation

NVMEDIA_IEP_MAX_PRENVSCISYNCFENCES

#define NVMEDIA_IEP_MAX_PRENVSCISYNCFENCES   (3U)

Specifies the maximum number of times NvMediaIEPInsertPreNvSciSyncFence() can be called before each call to NvMediaIEPFeedFrame().

Definition at line 46 of file nvmedia_iep_nvscisync.h.

NVMEDIA_IEP_NVSCISYNC_VERSION_MAJOR

#define NVMEDIA_IEP_NVSCISYNC_VERSION_MAJOR   1

Major version number.

Definition at line 38 of file nvmedia_iep_nvscisync.h.

NVMEDIA_IEP_NVSCISYNC_VERSION_MINOR

#define NVMEDIA_IEP_NVSCISYNC_VERSION_MINOR   1

Minor version number.

Definition at line 40 of file nvmedia_iep_nvscisync.h.

Function Documentation

NvMediaIEPFillNvSciSyncAttrList()

NvMediaStatus NvMediaIEPFillNvSciSyncAttrList	(	const NvMediaIEP *	encoder,
		NvSciSyncAttrList	attrlist,
		NvMediaNvSciSyncClientType	clienttype
	)

Fills the NvMediaIEP specific NvSciSync attributes.

This function assumes that attrlist is a valid NvSciSyncAttrList.

This function sets the public attribute:

• NvSciSyncAttrKey_RequiredPerm

The application must not set this attribute.

Precondition

NvMediaIEPCreate()

Postcondition

NvSciSyncAttrList populated with NvMediaIEP specific NvSciSync attributes

Considerations for Safety:

• Operation Mode: Init

Parameters

[in]	encoder	An NvMediaIEP device handle.
[out]	attrlist	A pointer to an NvSciSyncAttrList structure where NvMedia places NvSciSync attributes.
[in]	clienttype	Indicates whether the NvSciSyncAttrList requested for an NvMediaIEP signaler or an NvMediaIEP waiter.

Returns

NvMediaStatus The status of the operation. Possible values are:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if attrlist is NULL, or any of the public attributes listed above are already set.
• NVMEDIA_STATUS_OUT_OF_MEMORY if there is not enough memory for the requested operation.

NvMediaIEPGetEOFNvSciSyncFence()

NvMediaStatus NvMediaIEPGetEOFNvSciSyncFence	(	const NvMediaIEP *	encoder,
		NvSciSyncObj	eofnvscisyncobj,
		NvSciSyncFence *	eofnvscisyncfence
	)

Gets EOF NvSciSyncFence for an NvMediaIEPFeedFrame() operation.

The EOF NvSciSyncFence associated with an NvMediaIEPFeedFrame() operation is an NvSciSyncFence. Its expiry indicates that the corresponding NvMediaIEPFeedFrame() operation has finished.

This function returns the EOF NvSciSyncFence associated with the last NvMediaIEPFeedFrame() call. NvMediaIEPGetEOFNvSciSyncFence() must be called after an NvMediaIEPFeedFrame() call.

For example, in this sequence of code:

nvmstatus = NvMediaIEPFeedFrame(handle, srcsurf, srcrect, picparams, instanceid);
nvmstatus = NvMediaIEPGetEOFNvSciSyncFence(handle, nvscisyncEOF, eofnvscisyncfence);

expiry of eofnvscisyncfence indicates that the preceding NvMediaIEPFeedFrame() operation has finished.

Precondition

NvMediaIEPSetNvSciSyncObjforEOF()

NvMediaIEPFeedFrame()

Postcondition

EOF NvSciSync fence for a submitted task is obtained

Considerations for Safety:

• Operation Mode: Runtime

Parameters

[in]	encoder	An NvMediaIEP device handle.
[in]	eofnvscisyncobj	An EOF NvSciSyncObj associated with the NvSciSyncFence which is being requested.
[out]	eofnvscisyncfence	A pointer to the EOF NvSciSyncFence.

Returns

NvMediaStatus The status of the operation. Possible values are:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if encoder is not a valid NvMediaIEP handle, eofnvscisyncfence is NULL, or eofnvscisyncobj is not registered with encoder as type NVMEDIA_EOFSYNCOBJ or NVMEDIA_EOF_PRESYNCOBJ.
• NVMEDIA_STATUS_ERROR if the function was called before NvMediaIEPFeedFrame() was called.

NvMediaIEPGetSOFNvSciSyncFence()

NvMediaStatus NvMediaIEPGetSOFNvSciSyncFence	(	const NvMediaIEP *	encoder,
		NvSciSyncObj	sofnvscisyncobj,
		NvSciSyncFence *	sofnvscisyncfence
	)

Gets SOF NvSciSyncFence for an NvMediaIEPFeedFrame() operation.

This function is not supported.

The SOF NvSciSyncFence associated with an NvMediaIEPFeedFrame() operation is an NvSciSyncFence. Its expiry indicates that the corresponding NvMediaIEPFeedFrame() operation has started.

This function returns the SOF NvSciSyncFence associated with the last NvMediaIEPFeedFrame() call. NvMediaIEPGetSOFNvSciSyncFence() must be called after an NvMediaIEPFeedFrame() call.

Precondition

N/A

Postcondition

N/A

Considerations for Safety:

• Operation Mode: N/A

Parameters

[in]	encoder	An NvMediaIEP device handle.
[in]	sofnvscisyncobj	An SOF NvSciSyncObj associated with the NvSciSyncFence which is being requested.
[out]	sofnvscisyncfence	A pointer to the SOF NvSciSyncFence.

Returns

NvMediaStatus The status of the operation. Possible values are:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if encoder is not a valid NvMediaIEP handle, sofnvscisyncfence is NULL, or sofnvscisyncobj is not registered with encoder as type NVMEDIA_SOFSYNCOBJ or NVMEDIA_SOF_PRESYNCOBJ.
• NVMEDIA_STATUS_ERROR if the function was called before NvMediaIEPFeedFrame() was called.

NvMediaIEPInsertPreNvSciSyncFence()

NvMediaStatus NvMediaIEPInsertPreNvSciSyncFence	(	const NvMediaIEP *	encoder,
		const NvSciSyncFence *	prenvscisyncfence
	)

Sets an NvSciSyncFence as a prefence for an NvMediaIEPFeedFrame() NvSciSyncFence operation.

You must call NvMediaIEPInsertPreNvSciSyncFence() before you call NvMediaIEPFeedFrame(). The NvMediaIEPFeedFrame() operation is started only after the expiry of the prenvscisyncfence.

For example, in this sequence of code:

nvmstatus = NvMediaIEPInsertPreNvSciSyncFence(handle, prenvscisyncfence);
nvmstatus = NvMediaIEPFeedFrame(handle, srcsurf, srcrect, picparams, instanceid);

the NvMediaIEPFeedFrame() operation is assured to start only after the expiry of prenvscisyncfence.

You can set a maximum of NVMEDIA_IEP_MAX_PRENVSCISYNCFENCES prefences by calling NvMediaIEPInsertPreNvSciSyncFence() before NvMediaIEPFeedFrame(). After the call to NvMediaIEPFeedFrame(), all NvSciSyncFences previously inserted by NvMediaIEPInsertPreNvSciSyncFence() are removed, and they are not reused for the subsequent NvMediaIEPFeedFrame() calls.

Precondition

Pre-NvSciSync fence obtained from previous engine in the pipeline

Postcondition

Pre-NvSciSync fence is set

Considerations for Safety:

• Operation Mode: Runtime

Parameters

[in]	encoder	An NvMediaIEP device handle.
[in]	prenvscisyncfence	A pointer to NvSciSyncFence.

Returns

NvMediaStatus The status of the operation. Possible values are:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if encoder is not a valid NvMediaIEP handle, or prenvscisyncfence is NULL, or if prenvscisyncfence was not generated with an NvSciSyncObj that was registered with encoder as either NVMEDIA_PRESYNCOBJ or NVMEDIA_EOF_PRESYNCOBJ type.
• NVMEDIA_STATUS_NOT_SUPPORTED if NvMediaIEPInsertPreNvSciSyncFence() has already been called at least NVMEDIA_IEP_MAX_PRENVSCISYNCFENCES times with the same encoder handle before an NvMediaIEPFeedFrame() call.

NvMediaIEPNvSciSyncGetVersion()

NvMediaStatus NvMediaIEPNvSciSyncGetVersion

(

NvMediaVersion *

version

)

Returns the version information for the NvMedia IEP NvSciSync library.

Precondition

None

Postcondition

None

Considerations for Safety:

• Operation Mode: Init

Parameters

[out]

version

A pointer to an NvMediaVersion structure filled by the IEP NvSciSync library.

Returns

NvMediaStatus The completion status of the operation. Possible values are:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if the pointer is invalid.

NvMediaIEPRegisterNvSciSyncObj()

NvMediaStatus NvMediaIEPRegisterNvSciSyncObj	(	const NvMediaIEP *	encoder,
		NvMediaNvSciSyncObjType	syncobjtype,
		NvSciSyncObj	nvscisync
	)

Registers an NvSciSyncObj with NvMediaIEP.

Every NvSciSyncObj(even duplicate objects) used by NvMediaIEP must be registered by a call to this function before it is used. Only the exact same registered NvSciSyncObj can be passed to NvMediaIEPSetNvSciSyncObjforEOF(), NvMediaIEPGetEOFNvSciSyncFence(), or NvMediaIEPUnregisterNvSciSyncObj().

For a given NvMediaIEP handle, one NvSciSyncObj can be registered as one NvMediaNvSciSyncObjType only. For each NvMediaNvSciSyncObjType, a maximum of 16 NvSciSyncObjs can be registered.

Precondition

NvMediaIEPFillNvSciSyncAttrList()

Postcondition

NvSciSyncObj registered with NvMediaIEP

Considerations for Safety:

• Operation Mode: Init

Parameters

[in]	encoder	An NvMediaIEP device handle.
[in]	syncobjtype	Determines how nvscisync is used by encoder.
[in]	nvscisync	The NvSciSyncObj to be registered with encoder.

Returns

NvMediaStatus The status of the operation. Possible values are:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if encoder is NULL or syncobjtype is not a valid NvMediaNvSciSyncObjType.
• NVMEDIA_STATUS_NOT_SUPPORTED if nvscisync is not a compatible NvSciSyncObj which NvMediaIEP can support.
• NVMEDIA_STATUS_ERROR if the maximum number of NvSciScynObjs are already registered for the given syncobjtype, or if nvscisync is already registered with the same encoder handle for a different syncobjtype.

NvMediaIEPSetNvSciSyncObjforEOF()

NvMediaStatus NvMediaIEPSetNvSciSyncObjforEOF	(	const NvMediaIEP *	encoder,
		NvSciSyncObj	nvscisyncEOF
	)

Specifies the NvSciSyncObj to be used for an EOF NvSciSyncFence.

To use NvMediaIEPGetEOFNvSciSyncFence(), the application must call NvMediaIEPSetNvSciSyncObjforEOF() before it calls NvMediaIEPFeedFrame().

NvMediaIEPSetNvSciSyncObjforEOF() currently may be called only once before each call to NvMediaIEPFeedFrame(). The application may choose to call this function only once before the first call to NvMediaIEPFeedFrame().

Precondition

NvMediaIEPRegisterNvSciSyncObj()

Postcondition

NvSciSyncObj to be used as EOF NvSciSyncFence is set

Considerations for Safety:

• Operation Mode: Runtime

Parameters

[in]	encoder	An NvMediaIEP device handle.
[in]	nvscisyncEOF	A registered NvSciSyncObj which is to be associated with EOF NvSciSyncFence.

Returns

NvMediaStatus The status of the operation. Possible values are:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if encoder is NULL, or if nvscisyncEOF is not registered with encoder as either type NVMEDIA_EOFSYNCOBJ or NVMEDIA_EOF_PRESYNCOBJ.

NvMediaIEPSetNvSciSyncObjforSOF()

NvMediaStatus NvMediaIEPSetNvSciSyncObjforSOF	(	const NvMediaIEP *	encoder,
		NvSciSyncObj	nvscisyncSOF
	)

Specifies the NvSciSyncObj to be used for an SOF NvSciSyncFence.

This function is not supported.

To use NvMediaIEPGetSOFNvSciSyncFence(), the application must call NvMediaIEPSetNvSciSyncObjforSOF() before it calls NvMediaIEPFeedFrame().

NvMediaIEPSetNvSciSyncObjforSOF() currently may be called only once before each call to NvMediaIEPFeedFrame(). The application may choose to call this function only once before the first call to NvMediaIEPFeedFrame().

Precondition

N/A

Postcondition

N/A

Considerations for Safety:

• Operation Mode: N/A

Parameters

[in]	encoder	An NvMediaIEP device handle.
[in]	nvscisyncSOF	A registered NvSciSyncObj which is to be associated with SOF NvSciSyncFence.

Returns

NvMediaStatus The status of the operation. Possible values are:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if encoder is NULL, or if nvscisyncSOF is not registered with encoder as either type NVMEDIA_SOFSYNCOBJ or NVMEDIA_SOF_PRESYNCOBJ.

NvMediaIEPUnregisterNvSciSyncObj()

NvMediaStatus NvMediaIEPUnregisterNvSciSyncObj	(	const NvMediaIEP *	encoder,
		NvSciSyncObj	nvscisync
	)

Unregisters an NvSciSyncObj with NvMediaIEP.

Every NvSciSyncObj registered with NvMediaIEP by NvMediaIEPRegisterNvSciSyncObj() must be unregistered before calling NvMediaIEPDestroy().

Before the application calls this function, it must ensure that any NvMediaIEPFeedFrame() operation that uses the NvSciSyncObj has completed. If this function is called while NvSciSyncObj is still in use by any NvMediaIEPFeedFrame() operation, the behavior is undefined.

Precondition

NvMediaIEPFeedFrame()

NvMediaIEPGetBitsEx() [verify that processing is complete]

Postcondition

NvSciSyncObj un-registered with NvMediaIEP

Considerations for Safety:

• Operation Mode: De-init

Parameters

[in]	encoder	An NvMediaIEP device handle.
[in]	nvscisync	An NvSciSyncObj to be unregistered with encoder.

Returns

NvMediaStatus The status of the operation. Possible values are:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if encoder is NULL, or nvscisync is not registered with encoder.
• NVMEDIA_STATUS_ERROR if encoder was destroyed before this function was called.