NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
IPP Control Algorithm Plugin

Detailed Description

Defines IPP Control Algorithm Plugin related structures and functions.

Data Structures

struct  NvMediaIPPPluginInputStreamData
 Holds stream data for Control Algorithm plugin input. More...
 
struct  NvMediaIPPPluginInput
 Holds Control Algorithm plugin input parameters. More...
 
struct  NvMediaIPPPluginOutputStreamSettings
 Holds stream-specific settings of Control Algorithm plugin output. More...
 
struct  NvMediaIPPPluginOutputEx
 Holds Control Algorithm plugin output parameters for bracketed exposure. More...
 
struct  NvMediaIPPPluginSupportFuncs
 Holds the Control Algorithm plugin support functions descriptor. More...
 
struct  NvMediaIPPPluginFuncs
 Holds the Control Algorithm plugin function descriptor. More...
 

Macros

#define NVMEDIA_IPP_MAX_EXPOSURE_SETS   8
 Maximum numbers of exposure sets for bracketed exposure. More...
 

Typedefs

typedef void NvMediaIPPPlugin
 Holds an opaque handle representing a Control Algorithm plugin. More...
 
typedef NvMediaStatus NvMediaIPPGetSensorAttr (NvMediaIPPComponent *parentControlAlgorithmHandle, NvMediaISCSensorAttrType type, uint32_t size, void *attribute)
 Defines a function prototype that gets a sensor attribute. More...
 
typedef NvMediaStatus NvMediaIPPluginCreateFunc (NvMediaIPPComponent *parentControlAlgorithmHandle, NvMediaIPPPluginSupportFuncs *supportFunctions, NvMediaIPPPropertyStatic *staticProperties, void *clientContext, NvMediaIPPPlugin **pluginHandle, NvMediaIPPISPVersion ispVersion)
 Creates a Plugin Control Algorithm callback. More...
 
typedef void NvMediaIPPPluginDestroyFunc (NvMediaIPPPlugin *pluginHandle)
 Creates a Plugin Control Algorithm Destroy callback function. More...
 
typedef NvMediaStatus NvMediaIPPPluginProcessExFunc (NvMediaIPPPlugin *pluginHandle, NvMediaIPPPluginInput *pluginInput, NvMediaIPPPluginOutputEx *pluginOutput)
 Creates the Plugin Control Algorithm Process callback function for bracketed exposure. More...
 

Macro Definition Documentation

#define NVMEDIA_IPP_MAX_EXPOSURE_SETS   8

Maximum numbers of exposure sets for bracketed exposure.

Definition at line 835 of file nvmedia_ipp.h.

Typedef Documentation

typedef NvMediaStatus NvMediaIPPGetSensorAttr(NvMediaIPPComponent *parentControlAlgorithmHandle, NvMediaISCSensorAttrType type, uint32_t size, void *attribute)

Defines a function prototype that gets a sensor attribute.

Parameters
[in]parentControlAlgorithmHandleHandle passed during the create plugin call.
[in]typeSensor attribute type.
[in]sizeSize of the attribute.
[out]attributeA pointer to a sensor attribute value.
Returns
NvMediaStatus, the completion status of the operation:

Definition at line 887 of file nvmedia_ipp.h.

typedef NvMediaStatus NvMediaIPPluginCreateFunc(NvMediaIPPComponent *parentControlAlgorithmHandle, NvMediaIPPPluginSupportFuncs *supportFunctions, NvMediaIPPPropertyStatic *staticProperties, void *clientContext, NvMediaIPPPlugin **pluginHandle, NvMediaIPPISPVersion ispVersion)

Creates a Plugin Control Algorithm callback.

The client must create a callback function with the same function signature. That function is called when the IPP Control Algorithm component is created.

Parameters
[in]parentControlAlgorithmHandleA handle representing the parent Control Algorithm component. The plugin Control Algorithm must store this handle internally. This handle must be passed to any support function.
[in]supportFunctionsA pointer to a list of function pointers which the Plugin Control Algorithm can call. The parent Control Algorithm fills this structure. The plugin driver must copy this structure and use the function pointers to call the support functions.
[in]staticPropertiesA pointer to static properties associated with the camera.
[in]clientContextA pointer to a client context passed in the Control Algorithm configuration structure.
[out]pluginHandleThe Plugin Control Algorithm's handle.
Returns
NvMediaStatus, the completion status of the operation: NVMEDIA_STATUS_OK if successful, or NVMEDIA_STATUS_ERROR otherwise.

Definition at line 930 of file nvmedia_ipp.h.

typedef void NvMediaIPPPlugin

Holds an opaque handle representing a Control Algorithm plugin.

Definition at line 719 of file nvmedia_ipp.h.

typedef void NvMediaIPPPluginDestroyFunc(NvMediaIPPPlugin *pluginHandle)

Creates a Plugin Control Algorithm Destroy callback function.

The client must create a function with the same function signature. That function is called when the IPP Control Algorithm component is destroyed.

Parameters
[in]pluginHandleThe Plugin Control Algorithm's handle.
Returns
void

Definition at line 946 of file nvmedia_ipp.h.

typedef NvMediaStatus NvMediaIPPPluginProcessExFunc(NvMediaIPPPlugin *pluginHandle, NvMediaIPPPluginInput *pluginInput, NvMediaIPPPluginOutputEx *pluginOutput)

Creates the Plugin Control Algorithm Process callback function for bracketed exposure.

The client must create a function with the same function signature. That function is called when the IPP Control Algorithm component is processing the statistics information for an image.

Parameters
[in]pluginHandlePlugin Control Algorithm handle.
[in]pluginInputA pointer to the input parameters for the plugin Control Algorithm.
[out]pluginOutputOutput parameters that the plugin Control Algorithm generates.
Returns
NvMediaStatus, the completion status of the operation: NVMEDIA_STATUS_OK if successful, or NVMEDIA_STATUS_ERROR otherwise.

Definition at line 965 of file nvmedia_ipp.h.