NVIDIA DRIVE 5.0 Linux SDK API Reference

5.0.5.0 Release

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages

Detailed Description

Defines IPP pipeline-related structures and functions.

Data Structures

struct  NvMediaIPPEventData
 Holds additional event information. More...
 

Typedefs

typedef void NvMediaIPPEventCallback (void *clientContext, NvMediaIPPComponentType componentType, NvMediaIPPComponent *ippComponent, NvMediaIPPEventType eventType, NvMediaIPPEventData *eventData)
 Event callback function prototype. More...
 

Enumerations

enum  NvMediaIPPEventType {
  NVMEDIA_IPP_EVENT_INFO_EOF,
  NVMEDIA_IPP_EVENT_INFO_PROCESSING_DONE,
  NVMEDIA_IPP_EVENT_INFO_FRAME_CAPTURE,
  NVMEDIA_IPP_EVENT_WARNING_CAPTURE_FRAME_DROP,
  NVMEDIA_IPP_EVENT_ERROR_INTERNAL_FAILURE,
  NVMEDIA_IPP_EVENT_ERROR_I2C_TRANSMISSION_FAILURE,
  NVMEDIA_IPP_EVENT_WARNING_CSI_FRAME_DISCONTINUITY,
  NVMEDIA_IPP_EVENT_ERROR_CSI_INPUT_STREAM_FAILURE
}
 Defines event types. More...
 

Functions

NvMediaIPPPipelineNvMediaIPPPipelineCreate (NvMediaIPPManager *ippManager)
 Allocates an IPP pipeline object. More...
 
void NvMediaIPPPipelineDestroy (NvMediaIPPPipeline *ippPipeline)
 Destroys an IPP pipeline object. More...
 
NvMediaStatus NvMediaIPPPipelineSingleCapture (NvMediaIPPPipeline *ippPipeline)
 Triggers the pipeline to do the single capture. More...
 
NvMediaStatus NvMediaIPPManagerSetEventCallback (NvMediaIPPManager *ippManager, void *clientContext, NvMediaIPPEventCallback eventCallback)
 Sets a callback function for IPP events. More...
 
NvMediaStatus NvMediaIPPPipelineStart (NvMediaIPPPipeline *ippPipeline)
 Starts the IPP pipeline. More...
 
NvMediaStatus NvMediaIPPPipelineStop (NvMediaIPPPipeline *ippPipeline)
 Stops the IPP pipeline. More...
 
NvMediaStatus NvMediaIPPPipelineApplyControlProperties (NvMediaIPPPipeline *ippPipeline, NvMediaIPPPropertyControls *controlProperties)
 Applies control properties to the pipeline. More...
 
NvMediaStatus NvMediaIPPPipelineGetStaticProperties (NvMediaIPPPipeline *ippPipeline, NvMediaIPPPropertyStatic *staticProperties)
 Gets static properties for the pipeline. More...
 
NvMediaStatus NvMediaIPPPipelineGetDefaultControlsProperties (NvMediaIPPPipeline *ippPipeline, NvMediaIPPPropertyControls *defaultControlsProperties)
 Gets default controls properties for the pipeline. More...
 

Typedef Documentation

typedef void NvMediaIPPEventCallback(void *clientContext, NvMediaIPPComponentType componentType, NvMediaIPPComponent *ippComponent, NvMediaIPPEventType eventType, NvMediaIPPEventData *eventData)

Event callback function prototype.

The client must create a function with the same function signature.

Parameters
clientContextThe client context that was passed to NvMediaIPPManagerSetEventCallback.
componentTypeThe component that is reporting the event
ippComponentA pointer to the IPP component handle.
eventTypeThe event type
eventDataAdditional event information data

Definition at line 556 of file nvmedia_ipp.h.

Enumeration Type Documentation

Defines event types.

Enumerator
NVMEDIA_IPP_EVENT_INFO_EOF 

Event Info: End of file.

NVMEDIA_IPP_EVENT_INFO_PROCESSING_DONE 

Event Info: Component processed one frame.

NVMEDIA_IPP_EVENT_INFO_FRAME_CAPTURE 

Event Info: One frame captured.

NVMEDIA_IPP_EVENT_WARNING_CAPTURE_FRAME_DROP 

Event Warning: Capture frame drop.

NVMEDIA_IPP_EVENT_ERROR_INTERNAL_FAILURE 

Event Error: Internal failure.

NVMEDIA_IPP_EVENT_ERROR_I2C_TRANSMISSION_FAILURE 

Event Error: I2C transmission failure.

NVMEDIA_IPP_EVENT_WARNING_CSI_FRAME_DISCONTINUITY 

Event Warning: CSI frame discontinuity.

NVMEDIA_IPP_EVENT_ERROR_CSI_INPUT_STREAM_FAILURE 

Event Error: CSI input stream error.

Definition at line 514 of file nvmedia_ipp.h.

Function Documentation

NvMediaStatus NvMediaIPPManagerSetEventCallback ( NvMediaIPPManager ippManager,
void *  clientContext,
NvMediaIPPEventCallback  eventCallback 
)

Sets a callback function for IPP events.

Parameters
[in]ippManagerThe NvMediaIPPManager.
[in]clientContextThe context of the client. If not needed set it to NULL.
[in]eventCallbackAn event callback function pointer. This function is going to be called when an event happens in the IPP pipeline.
Returns
NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_ERROR
NvMediaStatus NvMediaIPPPipelineApplyControlProperties ( NvMediaIPPPipeline ippPipeline,
NvMediaIPPPropertyControls controlProperties 
)

Applies control properties to the pipeline.

Parameters
[in]ippPipelineThe IPP pipeline
[in]controlPropertiesA client allocated and filled structure of control properties
Returns
NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_ERROR
NvMediaIPPPipeline* NvMediaIPPPipelineCreate ( NvMediaIPPManager ippManager)

Allocates an IPP pipeline object.

Parameters
[in]ippManagerThe NvMediaIPPManager.
Returns
NvMediaIPPPipeline The new IPP pipeline's handle or NULL if unsuccessful.
void NvMediaIPPPipelineDestroy ( NvMediaIPPPipeline ippPipeline)

Destroys an IPP pipeline object.

Parameters
[in]ippPipelineThe IPP pipeline object to destroy.
Returns
void
NvMediaStatus NvMediaIPPPipelineGetDefaultControlsProperties ( NvMediaIPPPipeline ippPipeline,
NvMediaIPPPropertyControls defaultControlsProperties 
)

Gets default controls properties for the pipeline.

Parameters
[in]ippPipelineThe IPP pipeline
[out]defaultControlsPropertiesA client allocated structure to be filled with the default controls properties of the pipeline.
Returns
NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_ERROR
NvMediaStatus NvMediaIPPPipelineGetStaticProperties ( NvMediaIPPPipeline ippPipeline,
NvMediaIPPPropertyStatic staticProperties 
)

Gets static properties for the pipeline.

Parameters
[in]ippPipelineThe IPP pipeline
[out]staticPropertiesA client allocated structure to be filled with the static properties of the pipeline.
Returns
NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_ERROR
NvMediaStatus NvMediaIPPPipelineSingleCapture ( NvMediaIPPPipeline ippPipeline)

Triggers the pipeline to do the single capture.

Triggers are queued if called multiple times. Pipeline must be configured for trigger based capture.

Parameters
[in]ippPipelineThe IPP pipeline.
Returns
NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_ERROR
NvMediaStatus NvMediaIPPPipelineStart ( NvMediaIPPPipeline ippPipeline)

Starts the IPP pipeline.

This creates all the threads and starts all attached components in a pipeline.

Parameters
[in]ippPipelineThe IPP pipeline to start.
Returns
NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_ERROR
NvMediaStatus NvMediaIPPPipelineStop ( NvMediaIPPPipeline ippPipeline)

Stops the IPP pipeline.

This destroys all the threads in all components in a pipeline.

Parameters
[in]ippPipelineThe IPP pipeline to stop.
Returns
NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_ERROR