NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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  NvMediaImage
 A handle representing image objects. More...
 
struct  NvMediaImageGroup
 A handle representing an image group. More...
 
struct  NvMediaImageSurface
 Image surface descriptor used by NvMediaImageLock. More...
 
struct  NvMediaImageSurfaceMap
 Image surface map descriptor used by NvMediaImageLock. More...
 

Macros

#define NVMEDIA_IMAGE_VERSION_MAJOR   (1u)
 Major Version number. More...
 
#define NVMEDIA_IMAGE_VERSION_MINOR   (13u)
 Minor Version number. More...
 
#define NVMEDIA_MAX_AGGREGATE_IMAGES
 Maximum number of images in an aggregate image. More...
 
#define NVMEDIA_MAX_IMAGE_GROUP_SIZE
 Maximum number of images in an image group. More...
 
#define NVMEDIA_IMAGE_TIMEOUT_INFINITE
 Infinite time-out for NvMediaImageGetStatus. More...
 

Enumerations

enum  NvMediaBitsPerPixel {
  NVMEDIA_BITS_PER_PIXEL_8 = 0,
  NVMEDIA_BITS_PER_PIXEL_10,
  NVMEDIA_BITS_PER_PIXEL_12,
  NVMEDIA_BITS_PER_PIXEL_14,
  NVMEDIA_BITS_PER_PIXEL_16,
  NVMEDIA_BITS_PER_PIXEL_20
}
 Bits per pixel. More...
 
enum  NvMediaRawPixelOrder {
  NVMEDIA_RAW_PIXEL_ORDER_RGGB = 0,
  NVMEDIA_RAW_PIXEL_ORDER_BGGR,
  NVMEDIA_RAW_PIXEL_ORDER_GRBG,
  NVMEDIA_RAW_PIXEL_ORDER_GBRG
}
 Pixel order in a raw image. More...
 
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)
}
 Image lock access types. More...
 

Functions

NvMediaStatus NvMediaImageGetVersion (NvMediaVersion *version)
 Gets the version for the NvMedia Image library. More...
 
NvMediaImageNvMediaImageCreateNew (NvMediaDevice *device, NvMediaSurfaceType type, NvMediaSurfAllocAttr *attrs, uint32_t numAttrs, uint32_t flags)
 Allocates an image object. More...
 
void NvMediaImageDestroy (NvMediaImage *image)
 Destroys an image object that was created by NvMediaImageCreateNew. More...
 
NvMediaStatus NvMediaImageLock (NvMediaImage *image, uint32_t lockAccessType, NvMediaImageSurfaceMap *surfaceMap)
 Locks an image and returns the associated mapped pointers pointing to the image surface data. More...
 
void NvMediaImageUnlock (NvMediaImage *image)
 Unlocks an image. More...
 
NvMediaStatus NvMediaImagePutBits (NvMediaImage *image, NvMediaRect *dstRect, void **srcPntrs, uint32_t *srcPitches)
 Reads a client memory buffer and writes the content into an NvMedia image surface. More...
 
NvMediaStatus NvMediaImageGetBits (NvMediaImage *image, NvMediaRect *srcRect, void **dstPntrs, uint32_t *dstPitches)
 NvMediaImageGetBits reads an NvMedia image and writes the content into a client memory buffer. More...
 
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...