NVIDIA DriveOS Linux NSR SDK API Reference

7.0.3.0 Release
nvmedia_2d.h File Reference

Detailed Description

NVIDIA Media Interface: 2D Processing Control

Description: This file contains the #image_2d_api "Image 2D Processing API."

Definition in file nvmedia_2d.h.

Go to the source code of this file.

Data Structures

struct  NvMedia2DAttributes
 Attributes structure for NvMedia2DCreate(). More...
 
struct  NvMedia2DLdcWarpMapAttributes
 Attributes structure for NvMedia2DCreateLdcWarpMap(). More...
 
struct  NvMedia2DLdcMaskMapAttributes
 Attributes structure for NvMedia2DCreateLdcMaskMap(). More...
 
struct  NvMedia2DTnrStateAttributes
 Attributes structure for NvMedia2DCreateTnrState(). More...
 
struct  NvMedia2DCapabilities
 Capabilities of the NvMedia2D context. More...
 
struct  NvMedia2DComposeResult
 Stores information returned from NvMedia2DCompose(). More...
 
struct  NvMedia2DFilterCoefficients5Tap
 Coefficients values structure for 5-tap custom filter. More...
 
struct  NvMedia2DFilterCoefficients10Tap
 Coefficients values structure for 10-tap custom filter. More...
 
struct  NvMedia2DLdcRegionParameters
 Holds the NvMedia LDC region configuration. More...
 
struct  NvMedia2DLdcTransformMatrix
 Holds configutation for LDC transform matrix. More...
 
struct  NvMedia2DLdcControlPoint
 Represents a LDC warp map control point. More...
 
struct  NvMedia2DLdcWarpMapParameters
 Holds the NvMedia definition of an LDC Warp Map. More...
 
struct  NvMedia2DLdcMaskMapParameters
 Holds the LDC Mask Map information. More...
 
struct  NvMedia2DTnrParameters
 Holds the TNR3 initialization parameters. More...
 
struct  NvMedia2DChecksum
 Represents a checksum. More...
 

Macros

#define NVMEDIA_2D_MAX_LDC_REGIONS_X   4U
 Maximum number of horizontal LDC regions. More...
 
#define NVMEDIA_2D_MAX_LDC_REGIONS_Y   4U
 Maximum number of vertical LDC regions. More...
 
#define NVMEDIA_2D_CHECKSUM_NUM_BYTES   24u
 Number of bytes in NvMedia 2D checksums. More...
 

Typedefs

typedef uint32_t NvMedia2DComposeParameters
 Stores configuration for the NvMedia2DCompose() operation. More...
 
typedef uint32_t NvMedia2DFilterBuffer
 Stores a filter buffer which coefficients can be configured. More...
 
typedef uint32_t NvMedia2DLdcWarpMap
 Stores resources for an LDC warp map. More...
 
typedef uint32_t NvMedia2DLdcMaskMap
 Stores resources for an LDC mask map. More...
 
typedef uint32_t NvMedia2DTnrState
 Stores state and resources for TNR operation. More...
 
typedef struct NvMedia2D NvMedia2D
 NvMedia2D Context. More...
 

Enumerations

enum  NvMedia2DFilter {
  NVMEDIA_2D_FILTER_OFF = 0x1,
  NVMEDIA_2D_FILTER_LOW,
  NVMEDIA_2D_FILTER_MEDIUM,
  NVMEDIA_2D_FILTER_HIGH
}
 2D filter mode. More...
 
enum  NvMedia2DTransform {
  NVMEDIA_2D_TRANSFORM_NONE = 0x0,
  NVMEDIA_2D_TRANSFORM_ROTATE_90,
  NVMEDIA_2D_TRANSFORM_ROTATE_180,
  NVMEDIA_2D_TRANSFORM_ROTATE_270,
  NVMEDIA_2D_TRANSFORM_FLIP_HORIZONTAL,
  NVMEDIA_2D_TRANSFORM_INV_TRANSPOSE,
  NVMEDIA_2D_TRANSFORM_FLIP_VERTICAL,
  NVMEDIA_2D_TRANSFORM_TRANSPOSE
}
 2D rotation/transform. More...
 
enum  NvMedia2DBlendMode {
  NVMEDIA_2D_BLEND_MODE_DISABLED,
  NVMEDIA_2D_BLEND_MODE_CONSTANT_ALPHA,
  NVMEDIA_2D_BLEND_MODE_STRAIGHT_ALPHA,
  NVMEDIA_2D_BLEND_MODE_PREMULTIPLIED_ALPHA
}
 Blending to use when compositing surfaces. More...
 
enum  NvMedia2DChecksumMode {
  NVMEDIA_2D_CHECKSUM_MODE_DISABLED,
  NVMEDIA_2D_CHECKSUM_MODE_SRC_SURFACE
}
 NvMedia 2D checksum mode. More...
 

Functions

NvMedia2DAttributes NvMedia2DGetDefaultAttributes (void)
 Return the default values for NvMedia2DAttributes. More...
 
NvMedia2DLdcWarpMapAttributes NvMedia2DGetDefaultLdcWarpMapAttributes (void)
 Return the default values for NvMedia2DLdcWarpMapAttributes. More...
 
NvMedia2DLdcMaskMapAttributes NvMedia2DGetDefaultLdcMaskMapAttributes (void)
 Return the default values for NvMedia2DLdcMaskMapAttributes. More...
 
NvMedia2DTnrStateAttributes NvMedia2DGetDefaultTnrStateAttributes (void)
 Return the default values for NvMedia2DTnrStateAttributes. More...
 
NvMediaStatus NvMedia2DCreate (NvMedia2D **const handle, NvMedia2DAttributes const *const attr)
 Creates a new NvMedia2D context. More...
 
NvMediaStatus NvMedia2DDestroy (NvMedia2D const *const handle)
 Destroys the NvMedia2D context. More...
 
const NvMedia2DCapabilitiesNvMedia2DGetCapabilities (NvMedia2D const *const handle)
 Returns the NvMedia2D context capabilities. More...
 
NvMediaStatus NvMedia2DGetComposeParameters (NvMedia2D const *const handle, NvMedia2DComposeParameters *const params)
 Returns an NvMedia2DComposeParameters instance. More...
 
NvMediaStatus NvMedia2DReleaseComposeParameters (NvMedia2D const *const handle, NvMedia2DComposeParameters const params)
 Releases an NvMedia2DComposeParameters instance. More...
 
NvMediaStatus NvMedia2DCompose (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, NvMedia2DComposeResult *const result)
 Performs a 2D compose operation. More...
 
NvMediaStatus NvMedia2DSetSrcGeometry (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, uint32_t const index, NvMediaRect const *const srcRect, NvMediaRect const *const dstRect, NvMedia2DTransform const transform)
 Sets the geometry for a source layer. More...
 
NvMediaStatus NvMedia2DSetSrcFilter (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, uint32_t const index, NvMedia2DFilter const filter)
 Sets the filter mode for a source layer. More...
 
NvMediaStatus NvMedia2DSetSrcBlendMode (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, uint32_t const index, NvMedia2DBlendMode const blendMode, float const constantAlpha)
 Sets the blend mode for a source layer. More...
 
NvMediaStatus NvMedia2DSetSrcLdcTransformMatrix (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, uint32_t const index, NvMedia2DLdcTransformMatrix const *const ldcIptParams)
 Sets the LDC transform matrix for a source layer. More...
 
NvMediaStatus NvMedia2DSetSrcLdcWarpMap (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, uint32_t const index, NvMedia2DLdcWarpMap const ldcWarpMap)
 Sets the LDC warp map for a source layer. More...
 
NvMediaStatus NvMedia2DSetSrcLdcMaskMap (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, uint32_t const index, NvMedia2DLdcMaskMap const ldcMaskMap)
 Sets the LDC mask map for a source layer. More...
 
NvMediaStatus NvMedia2DSetClipRect (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, NvMediaRect const *const clipRect)
 Sets the clip rectangle for the compose operation. More...
 
NvMediaStatus NvMedia2DSetTnrState (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, NvMedia2DTnrState const tnrState)
 Sets the TNR state to use for the compose operation. More...
 
NvMediaStatus NvMedia2DCreateFilterBuffer (NvMedia2D const *const handle, NvMedia2DFilterBuffer *const filterBuffer)
 Creates and returns an NvMedia2DFilterBuffer instance. More...
 
NvMediaStatus NvMedia2DDestroyFilterBuffer (NvMedia2D const *const handle, NvMedia2DFilterBuffer const filterBuffer)
 Destroys an NvMedia2DFilterBuffer instance. More...
 
NvMediaStatus NvMedia2DSetFilterBuffer (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, NvMedia2DFilterBuffer const filterBuffer)
 Sets the filter buffer for an NvMedia2DComposeParameters instance. More...
 
NvMediaStatus NvMedia2DComputeFilterCoefficients5Tap (NvMedia2D const *const handle, NvMedia2DFilterBuffer const filterBuffer, uint32_t const index, NvMedia2DFilterCoefficients5Tap const *const lumaX, NvMedia2DFilterCoefficients5Tap const *const lumaY, NvMedia2DFilterCoefficients5Tap const *const chromaX, NvMedia2DFilterCoefficients5Tap const *const chromaY)
 Computes the 5-tap filter coefficients for an NvMedia2DFilterBuffer. More...
 
NvMediaStatus NvMedia2DComputeFilterCoefficients10Tap (NvMedia2D const *const handle, NvMedia2DFilterBuffer const filterBuffer, uint32_t const index, NvMedia2DFilterCoefficients10Tap const *const lumaX, NvMedia2DFilterCoefficients10Tap const *const lumaY, NvMedia2DFilterCoefficients10Tap const *const chromaX, NvMedia2DFilterCoefficients10Tap const *const chromaY)
 Computes the 10-tap filter coefficients for an NvMedia2DFilterBuffer. More...
 
NvMediaStatus NvMedia2DCreateLdcWarpMap (NvMedia2D const *const handle, NvMedia2DLdcWarpMapAttributes const *const ldcWarpMapAttr, NvMedia2DLdcWarpMap *const ldcWarpMap)
 Creates and returns an NvMedia2DLdcWarpMap instance. More...
 
NvMediaStatus NvMedia2DDestroyLdcWarpMap (NvMedia2D const *const handle, NvMedia2DLdcWarpMap const ldcWarpMap)
 Destroys an NvMedia2DLdcWarpMap instance. More...
 
NvMediaStatus NvMedia2DCreateLdcMaskMap (NvMedia2D const *const handle, NvMedia2DLdcMaskMapAttributes const *const ldcMaskMapAttr, NvMedia2DLdcMaskMap *const ldcMaskMap)
 Creates and returns an NvMedia2DLdcMaskMap instance. More...
 
NvMediaStatus NvMedia2DDestroyLdcMaskMap (NvMedia2D const *const handle, NvMedia2DLdcMaskMap const ldcMaskMap)
 Destroys an NvMedia2DLdcMaskMap instance. More...
 
NvMediaStatus NvMedia2DFillLdcWarpMap (NvMedia2D const *const handle, NvMedia2DLdcWarpMap const ldcWarpMap, NvMedia2DLdcWarpMapParameters const *const lcdWarpMapParams)
 Populates an LDC warp map with content. More...
 
NvMediaStatus NvMedia2DFillLdcMaskMap (NvMedia2D const *const handle, NvMedia2DLdcMaskMap const ldcMaskMap, NvMedia2DLdcMaskMapParameters const *const ldcMaskMapParams)
 Populates an LDC mask map with content. More...
 
NvMediaStatus NvMedia2DCreateTnrState (NvMedia2D const *const handle, NvMedia2DTnrStateAttributes const *const tnrStateAttr, NvMedia2DTnrState *const tnrState)
 Creates and returns an NvMedia2DTnrState instance. More...
 
NvMediaStatus NvMedia2DDestroyTnrState (NvMedia2D const *const handle, NvMedia2DTnrState const tnrState)
 Destroys an NvMedia2DTnrState instance. More...
 
NvMediaStatus NvMedia2DSetTnrParameters (NvMedia2D const *const handle, NvMedia2DTnrState const tnrState, NvMedia2DTnrParameters const *const tnrParams)
 Sets Temporal Noise Reduction (TNR) parameters. More...
 
NvMediaStatus NvMedia2DResetTnr (NvMedia2D const *const handle, NvMedia2DTnrState const tnrState)
 Resets TNR algorithm state. More...
 
NvMediaStatus NvMedia2DSetChecksumMode (NvMedia2D const *const handle, NvMedia2DComposeParameters const params, NvMedia2DChecksumMode const checksumMode)
 Sets checksum calculation mode. More...
 
NvMediaStatus NvMedia2DGetChecksum (NvMedia2D const *const handle, NvMedia2DComposeResult const *const result, NvMedia2DChecksum *const checksum)
 Gets a checksum calculated for an NvMedia2DCompose() operation. More...