Defines IPP pipeline-related structures and functions.
Defines a function prototype for event callbacks.
The client must create a function with the same function signature.
- Parameters
-
clientContext | The client context that was passed to NvMediaIPPManagerSetEventCallback. |
componentType | Component reporting the event. |
ippComponent | A pointer to the IPP component handle. |
eventType | Event type. |
eventData | A pointer to additional event information data. |
Definition at line 589 of file nvmedia_ipp.h.
Specifies event types.
Enumerator |
---|
NVMEDIA_IPP_EVENT_INFO_EOF |
Specifies event Info: End of file.
|
NVMEDIA_IPP_EVENT_INFO_PROCESSING_DONE |
Specifies event info: Component processed one frame.
|
NVMEDIA_IPP_EVENT_INFO_FRAME_CAPTURE |
Specifies event info: One frame captured.
|
NVMEDIA_IPP_EVENT_WARNING_CAPTURE_FRAME_DROP |
Specifies event warning: Capture frame drop.
|
NVMEDIA_IPP_EVENT_ERROR_INTERNAL_FAILURE |
Specifies event error: Internal failure.
|
NVMEDIA_IPP_EVENT_ERROR_I2C_TRANSMISSION_FAILURE |
Specifies event error: I2C transmission failure.
|
NVMEDIA_IPP_EVENT_WARNING_CSI_FRAME_DISCONTINUITY |
Specifies event warning: CSI frame discontinuity.
|
NVMEDIA_IPP_EVENT_ERROR_CSI_INPUT_STREAM_FAILURE |
Specifies event error: CSI input stream error.
|
Definition at line 544 of file nvmedia_ipp.h.
Sets a callback function for IPP events.
May be called after the NvMedia IPP manager is created.
- Note
- The event callback function is called from the thread context of an NvMedia IPP component. Therefore the called function must not perform blocking calls, and overall processing must be kept to a minimum.
- Parameters
-
[in] | ippManager | A pointer to the NvMediaIPPManager. |
[in] | clientContext | Context of the client. If not needed, set to NULL. |
[in] | eventCallback | A pointer to an event callback function. This function is called when an event occurs in the IPP pipeline. |
- Returns
- NvMediaStatus, the completion status of the operation: NVMEDIA_STATUS_OK if successful, or NVMEDIA_STATUS_ERROR otherwise.
Applies control properties to the pipeline.
- Parameters
-
[in] | ippPipeline | A pointer to the IPP pipeline. |
[in] | controlProperties | A pointer to a client-allocated and filled structure of control properties. |
- Returns
- NvMediaStatus, the completion status of the operation: NVMEDIA_STATUS_OK if successful, or NVMEDIA_STATUS_ERROR otherwise.
Allocates an IPP pipeline object.
- Parameters
-
- Returns
- NvMediaIPPPipeline, the new IPP pipeline's handle if successful, or NULL otherwise.
Destroys an IPP pipeline object and all components created with the handle.
May be called after the pipeline has been stopped with NvMediaIPPPipelineStop().
- Parameters
-
[in] | ippPipeline | A pointer to the IPP pipeline object to destroy. |
- Returns
- void
Gets default control properties for the pipeline.
- Parameters
-
[in] | ippPipeline | A pointer to the IPP pipeline. |
[out] | defaultControlsProperties | A pointer to a client allocated structure to be filled with the default control properties of the pipeline. |
- Returns
- NvMediaStatus, the completion status of the operation: NVMEDIA_STATUS_OK if successful, or NVMEDIA_STATUS_ERROR otherwise.
Gets static properties of the pipeline, that is, properties that do not change during the pipeline's lifetime.
- Parameters
-
[in] | ippPipeline | A pointer to the IPP pipeline. |
[out] | staticProperties | A pointer to a client allocated structure to be filled with the static properties of the pipeline. |
- Returns
- NvMediaStatus, the completion status of the operation: NVMEDIA_STATUS_OK if successful, or NVMEDIA_STATUS_ERROR otherwise.
Triggers the pipeline to do a single capture.
If called multiple times, triggers are queued. Pipeline must be configured for trigger-based capture.
- Parameters
-
[in] | ippPipeline | A pointer to the IPP pipeline. |
- Returns
- NvMediaStatus, the completion status of the operation: NVMEDIA_STATUS_OK if successful, or NVMEDIA_STATUS_ERROR otherwise.
Starts the IPP pipeline.
This function assumes that all the IPP components have been created and attached together to form a pipeline.
When invoked, all the component threads are activated. After a pipeline has started, no more components can be added to the pipeline or attached together.
- Parameters
-
[in] | ippPipeline | A pointer to the IPP pipeline to start. |
- Returns
- NvMediaStatus, the completion status of the operation: NVMEDIA_STATUS_OK if successful, or NVMEDIA_STATUS_ERROR otherwise.
Stops the IPP pipeline.
This function signals all components in the pipeline. Every component then stops its processing thread and goes into stopped mode.
Subsequently, the NvMediaIPPPipelineStart() function can restart the pipeline.
- Parameters
-
[in] | ippPipeline | A pointer to the IPP pipeline to stop. |
- Returns
- NvMediaStatus, the completion status of the operation: NVMEDIA_STATUS_OK if successful, or NVMEDIA_STATUS_ERROR otherwise.