NVIDIA DRIVE OS Linux SDK API Reference

5.1.15.0 Release
For Test and Development only
nvmedia_image.h File Reference

Detailed Description

NVIDIA Media Interface: Image Processing

Description: This file contains the Image Processing API.

Definition in file nvmedia_image.h.

Go to the source code of this file.

Data Structures

struct  NvMediaImageRec
 Holds a handle representing image objects. More...
 
struct  NvMediaImageGroup
 Holds a handle representing an image group. More...
 
struct  NvMediaImageSurface
 Holds an image surface descriptor used by NvMediaImageLock(). More...
 
struct  NvMediaImageSurfaceMap
 Holds an image surface map descriptor used by NvMediaImageLock(). More...
 

Macros

#define NVMEDIA_IMAGE_VERSION_MAJOR   (1u)
 Major version number. More...
 
#define NVMEDIA_IMAGE_VERSION_MINOR   (24u)
 Minor version number. More...
 
#define NVMEDIA_MAX_IMAGE_GROUP_SIZE
 Maximum number of images in an image group. More...
 
#define NVMEDIA_IMAGE_TIMEOUT_INFINITE
 Infinite timeout for NvMediaImageGetStatus(). More...
 

Typedefs

typedef struct NvMediaImageRec NvMediaImage
 

Enumerations

enum  NvMediaImageLockAccess {
  NVMEDIA_IMAGE_ACCESS_READ = (1u << 0),
  NVMEDIA_IMAGE_ACCESS_WRITE = (1u << 1),
  NVMEDIA_IMAGE_ACCESS_READ_WRITE = (NVMEDIA_IMAGE_ACCESS_READ | NVMEDIA_IMAGE_ACCESS_WRITE)
}
 Specifies image lock access types. More...
 

Functions

NvMediaStatus NvMediaImageGetVersion (NvMediaVersion *version)
 Gets the version of the NvMedia Image library. More...
 
NvMediaImageNvMediaImageCreateNew (NvMediaDevice *device, NvMediaSurfaceType type, const NvMediaSurfAllocAttr *attrs, uint32_t numAttrs, uint32_t flags)
 Allocates an image object. More...
 
void NvMediaImageDestroy (const NvMediaImage *image)
 Destroys an image object created by NvMediaImageCreateNew() or NvMediaImageCreateFromNvSciBuf(). More...
 
NvMediaStatus NvMediaImageGetEmbeddedData (const NvMediaImage *image, uint32_t imageIndex, uint8_t *embeddedBufTop, uint32_t *embeddedBufTopSize, uint8_t *embeddedBufBottom, uint32_t *embeddedBufBottomSize)
 Returns embedded data stored in a captured image. More...
 
NvMediaStatus NvMediaImageGetStatus (const NvMediaImage *image, uint32_t millisecondWait, NvMediaTaskStatus *taskStatus)
 Gets status of the current or most recent operation for an image; optionally waits for the current operation to complete or time out. More...
 
NvMediaStatus NvMediaImageSetTag (NvMediaImage *image, void *tag)
 Sets a tag for an NvMediaImage. More...
 
NvMediaStatus NvMediaImageGetTag (const NvMediaImage *image, void **tag)
 Gets the tag from an NvMediaImage. More...
 
NvMediaStatus NvMediaImageGetTimeStamp (const NvMediaImage *image, NvMediaTime *timeStamp)
 Gets the capture timestamp of the image. More...
 
NvMediaStatus NvMediaImageGetGlobalTimeStamp (const NvMediaImage *image, NvMediaGlobalTime *globalTimeStamp)
 Gets the global capture timestamp of the image. More...
 
NvMediaStatus NvMediaImageLock (const NvMediaImage *image, NvMediaImageLockAccess lockAccessType, NvMediaImageSurfaceMap *surfaceMap)
 Locks an image and returns the associated mapped pointers to the image surface data. More...
 
void NvMediaImageUnlock (const NvMediaImage *image)
 Unlocks an image. More...
 
NvMediaStatus NvMediaImagePutBits (NvMediaImage *image, const NvMediaRect *dstRect, void **srcPntrs, const uint32_t *srcPitches)
 Reads a client memory buffer and writes the content into an NvMedia image surface. More...
 
NvMediaStatus NvMediaImageGetBits (const NvMediaImage *image, const NvMediaRect *srcRect, void **dstPntrs, const uint32_t *dstPitches)
 Reads an NvMedia image and writes the content into a client memory buffer. More...