NVIDIA DRIVE OS Linux SDK API Reference

5.2.6 Release
For Test and Development only
nvmedia_vop.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 - 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 
15 #ifndef _NVMEDIA_VOP_H
16 #define _NVMEDIA_VOP_H
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
22 #include "nvmedia_core.h"
23 #include "nvmedia_common.h"
24 #include "nvmedia_video.h"
25 
39 #define NVMEDIA_VOP_VERSION_MAJOR 3
40 
41 #define NVMEDIA_VOP_VERSION_MINOR 1
42 
46 typedef struct {
48  uint32_t width;
50  uint32_t height;
52  float_t refreshRate;
54 
60 typedef struct {
62  uint32_t width;
64  uint32_t height;
66  float_t refreshRate;
68 
72 typedef struct {
74  uint32_t displayId;
78  uint32_t width;
80  uint32_t height;
82  float_t refreshRate;
84 
96  NvMediaVideoOutput *output,
97  NvMediaRect *position
98 );
99 
113  NvMediaVideoOutput *output,
114  uint32_t depth
115 );
116 
140  int32_t *outputDevices,
141  NvMediaVideoOutputDeviceParams *outputParams
142 );
143 
155  NvMediaVersion *version
156 );
157 
177  uint32_t displayId,
178  uint32_t windowId,
179  NvMediaVideoOutputPreferences *outputPreference,
180  NvMediaBool alreadyCreated
181 );
182 
187 void
189  NvMediaVideoOutput *output
190 );
191 
205 void
207  NvMediaVideoOutput *output,
208  uint32_t attributeMask,
209  NvMediaDispAttributes *attributes
210 );
211 
244  NvMediaVideoOutput *output,
245  NvMediaVideoSurface *videoSurface,
246  NvMediaRect *srcRect,
247  NvMediaRect *dstRect,
248  NvMediaVideoSurface **releaseList,
249  NvMediaTime *timeStamp
250 );
253 /*
254  * \defgroup history_nvmedia_vop History
255  * Provides change history for the NvMedia Video Output API.
256  *
257  * \section history_nvmedia_vop Version History
258  *
259  * <b> Version 1.0 </b> March 21, 2017
260  * - Initial release
261  *
262  * <b> Version 2.0 </b> May 16, 2017
263  * - Removed NvMediaVideoOutputType and NvMediaVideoOutputDevice types
264  * - Removed NvMediaVideoOutputCreateEx function
265  * - Removed NvMediaVideoOutputCheckFormatSupport function
266  * - Changed parameters of NvMediaVideoOutputCreate function
267  * - Added NvMediaVideoOutputGetVersion function
268  * - All NvMedia data types are moved to standard data types
269  *
270  * <b> Version 3.0 </b> February 6, 2019
271  * - Deprecated brightness, hue, saturation, contrast, limitedRGB and
272  * colorStandard support from \ref NvMediaVideoOutputSetAttributes.
273  * - Updated description of \ref NvMediaVideoOutputSetAttributes API to
274  * add composition, depth and position attributes
275  *
276  * <b> Version 3.1 </b> April 28, 2020
277  * - Added supported surface format types in NvMediaVideoOutputFlip API
278  *
279  */
280 
281 #ifdef __cplusplus
282 }; /* extern "C" */
283 #endif
284 
285 #endif /* _NVMEDIA_VOP_H */
NvMediaTime
struct timespec NvMediaTime
Holds the media time in timespec format as defined by the POSIX specification.
Definition: nvmedia_core.h:85
nvmedia_video.h
NVIDIA Media Interface: Video Surface Processing
NvMediaVideoOutputFlip
NvMediaStatus NvMediaVideoOutputFlip(NvMediaVideoOutput *output, NvMediaVideoSurface *videoSurface, NvMediaRect *srcRect, NvMediaRect *dstRect, NvMediaVideoSurface **releaseList, NvMediaTime *timeStamp)
Displays a video surface using video output that NvMediaVideoOutputCreate() created.
NvMediaVideoOutputDeviceParams::enabled
NvMediaBool enabled
Set to NVMEDIA_TRUE if the device is already enabled (initialized) by the system.
Definition: nvmedia_vop.h:76
NvMediaVideoOutputGetVersion
NvMediaStatus NvMediaVideoOutputGetVersion(NvMediaVersion *version)
Returns the version information for the Video Output Processing library.
NvMediaVideoOutputDeviceParams::refreshRate
float_t refreshRate
Display refresh rate in Hertz.
Definition: nvmedia_vop.h:82
NvMediaVideoOutputDeviceParams
Device parameters returned by NvMediaVideoOutputDevicesQuery function.
Definition: nvmedia_vop.h:72
NvMediaVideoOutputSetAttributes
void NvMediaVideoOutputSetAttributes(NvMediaVideoOutput *output, uint32_t attributeMask, NvMediaDispAttributes *attributes)
Sets NvMediaVideoOutput attributes.
NvMediaVideoOutputDeviceParams::displayId
uint32_t displayId
Display identification.
Definition: nvmedia_vop.h:74
NvMediaVideoOutput::width
uint32_t width
Display width.
Definition: nvmedia_vop.h:48
NvMediaVideoOutputPreferences::refreshRate
float_t refreshRate
Display refresh rate in Hertz.
Definition: nvmedia_vop.h:66
nvmedia_common.h
NVIDIA Media Interface: Common Types for Video/Image Encode/Decode
NvMediaVideoOutput
Video output object created by NvMediaVideoOutputCreate.
Definition: nvmedia_vop.h:46
NvMediaVideoOutputCreate
NvMediaVideoOutput * NvMediaVideoOutputCreate(uint32_t displayId, uint32_t windowId, NvMediaVideoOutputPreferences *outputPreference, NvMediaBool alreadyCreated)
Creates a video output object.
NvMediaVersion
Holds NvMedia version information.
Definition: nvmedia_core.h:237
NvMediaVideoOutputDeviceParams::width
uint32_t width
Display width.
Definition: nvmedia_vop.h:78
NvMediaVideoOutputDevicesQuery
NvMediaStatus NvMediaVideoOutputDevicesQuery(int32_t *outputDevices, NvMediaVideoOutputDeviceParams *outputParams)
Queries the display system and returns the parameters of all display devices.
NvMediaVideoSurface
A handle representing a video surface object.
Definition: nvmedia_video.h:58
NvMediaVideoOutput::height
uint32_t height
Display height.
Definition: nvmedia_vop.h:50
NvMediaRect
Holds a rectangular region of a surface.
Definition: nvmedia_core.h:133
nvmedia_core.h
NVIDIA Media Interface: Core
NvMediaStatus
NvMediaStatus
Defines all possible error codes.
Definition: nvmedia_core.h:180
NvMediaVideoOutput::refreshRate
float_t refreshRate
Display refresh rate in Hertz.
Definition: nvmedia_vop.h:52
NvMediaVideoOutputPreferences
Sets the preferences for the video output creation.
Definition: nvmedia_vop.h:60
NvMediaVideoOutputDeviceParams::height
uint32_t height
Display height.
Definition: nvmedia_vop.h:80
NvMediaVideoOutputPreferences::width
uint32_t width
Display width.
Definition: nvmedia_vop.h:62
NvMediaVideoOutputSetPosition
NvMediaStatus NvMediaVideoOutputSetPosition(NvMediaVideoOutput *output, NvMediaRect *position)
Sets video output position and size.
NvMediaBool
uint32_t NvMediaBool
A boolean value, holding NVMEDIA_TRUE or NVMEDIA_FALSE.
Definition: nvmedia_core.h:80
NvMediaVideoOutputSetDepth
NvMediaStatus NvMediaVideoOutputSetDepth(NvMediaVideoOutput *output, uint32_t depth)
Sets video output depth.
NvMediaVideoOutputDestroy
void NvMediaVideoOutputDestroy(NvMediaVideoOutput *output)
Destroys a video output created by NvMediaVideoOutputCreate.
NvMediaVideoOutputPreferences::height
uint32_t height
Display height.
Definition: nvmedia_vop.h:64
NvMediaDispAttributes
Holds NvMedia display attributes.
Definition: nvmedia_common.h:97