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
Image Handling API

Detailed Description

The Image Processing API encompasses all NvMedia image related functionality.

Data Structures

struct  NvMediaImageSurface
 Image surface descriptor used by NvMediaImageLock. More...
 
struct  NvMediaImageSurfaceMap
 Image surface map descriptor used by NvMediaImageLock. More...
 

Modules

 Image 2D Processing
 The Image 2D Processing API encompasses all NvMedia 2D image processing related functionality.
 
 Image Capture
 Captures uncompressed image data, writing the results to an NvMediaImage.
 
 Image Creation
 Defines and manages image objects.
 
 Image Decoder
 Defines and manages objects that decode video.
 
 Image Display Processing (IDP)
 Displays NvMediaImage type surfaces.
 
 Image Encoder
 The NvMediaIEP object takes uncompressed image data and turns it into a codec specific bitstream.
 
 Image JPEG Decoder
 The NvMediaIJPD object takes a JPEG bitstream and decompress it to image data.
 
 Image JPEG Encoder
 The NvMediaIJPE object takes uncompressed image data and turns it into a jpeg bitstream.
 
 Image Locking and Unlocking
 Locking and unlocking provides acces to the image surfaces.
 
 Image Processing Pipeline (IPP)
 The NvMedia Image Processing Pipeline (IPP) is a framework that controls all NvMedia processing components.
 
 Image Read and Write by Client
 Provides image surface read and write by the client application for diagnostic purposes.
 
 Image Sensor Control (ISC)
 The Image Sensor Control API encompasses all NvMedia I2C control related functions.
 
 Image Signal Processing
 The Image Signal Processing API encompasses all NvMedia image processing functions that are necessary to produce a processed image from image data captured from an image sensor.
 

Macros

#define NVMEDIA_IMAGE_VERSION_MAJOR   1
 Major Version number. More...
 
#define NVMEDIA_IMAGE_VERSION_MINOR   11
 Minor Version number. More...
 

Functions

NvMediaStatus NvMediaImageGetEmbeddedData (NvMediaImage *image, uint32_t imageIndex, void *embeddedBufTop, uint32_t *embeddedBufTopSize, void *embeddedBufBottom, uint32_t *embeddedBufBottomSize)
 Return embedded data stored in a captured image. More...
 
NvMediaStatus NvMediaImageGetTimeStamp (NvMediaImage *image, NvMediaTime *timeStamp)
 Gets the capture timestamp of the image. More...
 
NvMediaStatus NvMediaImageGetGlobalTimeStamp (NvMediaImage *image, NvMediaGlobalTime *globalTimeStamp)
 Gets the global capture time-stamp of the image. More...
 
NvMediaStatus NvMediaImageGetStatus (NvMediaImage *image, uint32_t millisecondWait, NvMediaTaskStatus *status)
 Gets status of the current/last operation for the image, and optionally waits for operation to complete/timeout. More...
 

Macro Definition Documentation

#define NVMEDIA_IMAGE_VERSION_MAJOR   1

Major Version number.

Definition at line 36 of file nvmedia_image.h.

#define NVMEDIA_IMAGE_VERSION_MINOR   11

Minor Version number.

Definition at line 38 of file nvmedia_image.h.

Function Documentation

NvMediaStatus NvMediaImageGetEmbeddedData ( NvMediaImage image,
uint32_t  imageIndex,
void *  embeddedBufTop,
uint32_t *  embeddedBufTopSize,
void *  embeddedBufBottom,
uint32_t *  embeddedBufBottomSize 
)

Return embedded data stored in a captured image.

Embedded data can be added to the following image types. This type must obtained by /ref NvMediaSurfaceFormatGetType with: NVM_SURF_FMT_SET_ATTR_YUV(attr, YUYV, 422, PACKED, UINT, 8, PL) NVM_SURF_FMT_SET_ATTR_RGBA (attr, RGBA, UINT, 8, [PL|BL]) NVM_SURF_FMT_SET_ATTR_RAW (attr, [RGGB/BGGR/GRBG/GBRG], INT, [8/10/12/16/20], PL) NVM_SURF_FMT_SET_ATTR_RAW (attr, [RCCB/BCCR/CRBC/CBRC], INT, 12, PL) NVM_SURF_FMT_SET_ATTR_RAW (attr, [RCCC/CCCR/CRCC/CCRC], INT, 12, PL)

Parameters
[in]imageImage to get the embedded data from.
[in]imageIndexIndex of the sub-image in case of multi-image handle. For single image this parameter is ignored. Index count starts from 0.
[in]embeddedBufTopThe buffer where the top embedded data is stored.
[in]embeddedBufTopSizePointer to top buffer size. The actual size of copied data will be returned in this parameter.
[in]embeddedBufBottomThe buffer where the bottom embedded data is stored.
[in]embeddedBufBottomSizePointer to bottom buffer size. The actual size of copied data will be returned in this parameter.
Returns
NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_BAD_PARAMETER If any of the input parameter is NULL
NVMEDIA_STATUS_ERROR If the surface type is not supported
NvMediaStatus NvMediaImageGetGlobalTimeStamp ( NvMediaImage image,
NvMediaGlobalTime globalTimeStamp 
)

Gets the global capture time-stamp of the image.

The global time-stamp is set by the NvMedia IPP Capture component.

Parameters
[in]imageA pointer to the image for which to get the time-stamp.
[in]globalTimeStampA pointer to the global capture timestamp of the image. Possible values are:
NVMEDIA_STATUS_OK Success
NVMEDIA_STATUS_BAD_PARAMETER If image or timeStamp is NULL
NVMEDIA_STATUS_ERROR If any error occurred
NvMediaStatus NvMediaImageGetStatus ( NvMediaImage image,
uint32_t  millisecondWait,
NvMediaTaskStatus status 
)

Gets status of the current/last operation for the image, and optionally waits for operation to complete/timeout.

Parameters
[in]imageA pointer to the image.
[in]millisecondWaitTime in milliseconds to wait for operation to complete before getting status. NVMEDIA_IMAGE_TIMEOUT_INFINITE means wait till operation is completed and then get status.
[out]statusStatus of the operation.
Returns
NvMediaStatus The status of the function call. Possible values are:
NVMEDIA_STATUS_OK
NVMEDIA_STATUS_ERROR
NVMEDIA_STATUS_BAD_PARAMETER
NvMediaStatus NvMediaImageGetTimeStamp ( NvMediaImage image,
NvMediaTime timeStamp 
)

Gets the capture timestamp of the image.

Parameters
[in]imageA pointer to the image for which to get the timestamp.
[in]timeStampA pointer the capture timestamp of the image.
Returns
NvMediaStatus The completion status of the operation. Possible values are:
NVMEDIA_STATUS_OK Success
NVMEDIA_STATUS_BAD_PARAMETER If image or timeStamp is NULL
NVMEDIA_STATUS_ERROR If any error occurred