NVIDIA DRIVE OS Linux SDK API Reference

5.2.3 Release
For Test and Development only
nvmedia_image_pyramid.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020, NVIDIA CORPORATION. All rights reserved. All
3  * information contained herein is proprietary and confidential to NVIDIA
4  * Corporation. Any use, reproduction, or disclosure without the written
5  * permission of NVIDIA Corporation is prohibited.
6  */
7 
16 #ifndef NVMEDIA_IMAGE_PYRAMID_H
17 #define NVMEDIA_IMAGE_PYRAMID_H
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 #include "nvmedia_core.h"
24 #include "nvmedia_image.h"
25 #include "nvmedia_surface.h"
26 
46 #define NVMEDIA_IMAGE_PYRAMID_VERSION_MAJOR (1u)
47 
48 #define NVMEDIA_IMAGE_PYRAMID_VERSION_MINOR (3u)
49 
51 #define MAX_PYRAMID_LEVELS (10u)
52 
57 
76  NvMediaDevice *device,
78  const NvMediaSurfAllocAttr *attrs,
79  uint32_t numLevels,
80  float_t scale,
81  uint32_t numAttrs,
82  uint32_t flags
83 );
84 
89 void
91  NvMediaImagePyramid *pyramid
92 );
93 
114  const NvMediaImagePyramid *pyramid,
115  uint32_t lockAccessType,
116  NvMediaImageSurfaceMap *surfaceMap
117 );
118 
126 void
128  const NvMediaImagePyramid *pyramid
129 );
130 
149  const NvMediaImagePyramid *pyramid,
150  uint32_t millisecondWait,
151  NvMediaTaskStatus *status
152 );
153 
160 NvMediaImage *
162  const NvMediaImagePyramid * pyramid,
163  uint32_t level
164 );
165 
171 uint32_t
173  const NvMediaImagePyramid * pyramid
174 );
175 
181 float_t
183  const NvMediaImagePyramid * pyramid
184 );
185 
186 /*
187  * \defgroup history_nvmedia_image_pyramid History
188  * Provides change history for the NvMedia ImagePyramid API.
189  *
190  * \section history_nvmedia_image_pyramid Version History
191  *
192  * <b> Version 1.0 </b> December 4, 2017
193  * - Initial Release.
194  *
195  * <b> Version 1.1 </b> February 6, 2019
196  * - Added required header includes nvmedia_core.h and nvmedia_surface.h
197  *
198  * <b> Version 1.2 </b> April 13, 2020
199  * - Fixed minor MISRA violations for VPI
200  *
201  * <b> Version 1.3 </b> April 22, 2020
202  * - Fixed minor MISRA violations for ImagePyramid
203  *
204  */
205 
209 #ifdef __cplusplus
210 }; /* extern "C" */
211 #endif
212 
213 #endif /* NVMEDIA_IMAGE_PYRAMID_H */
NvMediaImagePyramidCreate
NvMediaImagePyramid * NvMediaImagePyramidCreate(NvMediaDevice *device, NvMediaSurfaceType type, const NvMediaSurfAllocAttr *attrs, uint32_t numLevels, float_t scale, uint32_t numAttrs, uint32_t flags)
Allocates an image pyramid.
nvmedia_surface.h
NVIDIA Media Interface: Surface Handling
NvMediaImagePyramid
struct NvMediaImagePyramid NvMediaImagePyramid
A handle representing an image pyramid object.
Definition: nvmedia_image_pyramid.h:56
NvMediaImagePyramidUnlock
void NvMediaImagePyramidUnlock(const NvMediaImagePyramid *pyramid)
Unlocks an image pyramid.
NvMediaDevice
struct NvMediaDevice NvMediaDevice
An opaque handle representing an NvMediaDevice object.
Definition: nvmedia_core.h:348
NvMediaImagePyramidDestroy
void NvMediaImagePyramidDestroy(NvMediaImagePyramid *pyramid)
Destroys an image pyramid created by NvMediaImagePyramidCreate().
type
int const char int type
Definition: drm-nvdc-docs.h:1479
NvMediaImagePyramidGetScale
float_t NvMediaImagePyramidGetScale(const NvMediaImagePyramid *pyramid)
Returns the scale factor of a pyramid.
NvMediaImageRec
Holds a handle representing image objects.
Definition: nvmedia_image.h:71
NvMediaImageSurfaceMap
Holds an image surface map descriptor used by NvMediaImageLock().
Definition: nvmedia_image.h:397
NvMediaImagePyramidGetStatus
NvMediaStatus NvMediaImagePyramidGetStatus(const NvMediaImagePyramid *pyramid, uint32_t millisecondWait, NvMediaTaskStatus *status)
Gets the status of the current or most recent operation for the image pyramid; optionally waits for t...
NvMediaImagePyramidGetNumLevels
uint32_t NvMediaImagePyramidGetNumLevels(const NvMediaImagePyramid *pyramid)
Returns the number of levels in a pyramid.
nvmedia_core.h
NVIDIA Media Interface: Core
NvMediaSurfaceType
#define NvMediaSurfaceType
Defines the set of NvMedia surface types.
Definition: nvmedia_surface.h:550
NvMediaImagePyramidGetImageForLevel
NvMediaImage * NvMediaImagePyramidGetImageForLevel(const NvMediaImagePyramid *pyramid, uint32_t level)
Gets a pointer to the image for a level.
NvMediaStatus
NvMediaStatus
Defines all possible error codes.
Definition: nvmedia_core.h:180
NvMediaSurfAllocAttr
Holds NvMedia Surface allocation attributes.
Definition: nvmedia_surface.h:540
NvMediaImagePyramidLock
NvMediaStatus NvMediaImagePyramidLock(const NvMediaImagePyramid *pyramid, uint32_t lockAccessType, NvMediaImageSurfaceMap *surfaceMap)
Locks an image pyramid and returns the associated mapped pointers to the image pyramid surface data.
NvMediaTaskStatus
Holds status of latest operation for NvMedia managed data structure.
Definition: nvmedia_core.h:220
nvmedia_image.h
NVIDIA Media Interface: Image Processing