NVIDIA DRIVE OS Linux SDK API Reference

5.2.6 Release
For Test and Development only
nvmedia_idp.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014-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_IDP_H
16 #define _NVMEDIA_IDP_H
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
22 #include "nvmedia_core.h"
23 #include "nvmedia_common.h"
24 #include "nvmedia_image.h"
25 
36 #define NVMEDIA_IDP_VERSION_MAJOR 3
37 
38 #define NVMEDIA_IDP_VERSION_MINOR 1
39 
43 typedef struct {
45  uint32_t displayId;
47  uint32_t windowId;
49  uint32_t width;
51  uint32_t height;
53  float_t refreshRate;
54 } NvMediaIDP;
55 
61 typedef struct {
63  uint32_t width;
65  uint32_t height;
67  float_t refreshRate;
69 
73 typedef struct {
75  uint32_t displayId;
79  uint32_t width;
81  uint32_t height;
83  float_t refreshRate;
85 
97  NvMediaVersion *version
98 );
99 
112 NvMediaIDP *
114  uint32_t displayId,
115  uint32_t windowId,
116  NvMediaIDPPreferences *displayPreference,
117  NvMediaBool alreadyCreated
118 );
119 
125 void
127  NvMediaIDP *idp
128 );
129 
148  NvMediaIDP *idp,
149  uint32_t attributeMask,
150  NvMediaDispAttributes *attributes
151 );
152 
169  int32_t *displayDevices,
170  NvMediaIDPDeviceParams *displayParams
171 );
172 
200  NvMediaIDP *idp,
201  NvMediaImage *image,
202  NvMediaRect *srcRect,
203  NvMediaRect *dstRect,
204  NvMediaImage **releaseList,
205  NvMediaTime *timeStamp
206 );
207 
208 /*
209  * \defgroup history_nvmedia_idp History
210  * Provides change history for the NvMedia IDP API.
211  *
212  * \section history_nvmedia_idp Version History
213  *
214  * <b> Version 1.1 </b> September 24, 2015
215  * - Initial release
216  *
217  * <b> Version 1.2 </b> May 11, 2016
218  * - Added \ref NvMediaIDPCheckVersion API
219  *
220  * <b> Version 2.0 </b> May 12, 2017
221  * - Added \ref NvMediaIDPGetVersion API to get the version of NvMedia image display library
222  * - NvMediaIDPCheckVersion is deprecated. Use NvMediaIDPGetVersion() instead
223  * - Remove NvMediaIDPDeviceType
224  * - Remove imageType as input parameter of \ref NvMediaIDPCreate
225  * - Replace NvMediaIDPCompositionModes with \ref NvMediaDispCompMode
226  * - Replace NvMediaIDPAttributes with \ref NvMediaDispAttributes
227  * - Deprecated NvMediaIDPSetDepth, use NvMediaIDPSetAttributes with
228  * NVMEDIA_DISP_ATTR_SET_DEPTH instead
229  * - All NvMedia data types are moved to standard data types
230  *
231  * <b> Version 3.0 </b> February 6, 2019
232  * - Deprecated brightness, hue, saturation, contrast, limitedRGB and
233  * colorStandard support from \ref NvMediaIDPSetAttributes.
234  *
235  * <b> Version 3.1 </b> April 28, 2020
236  * - Added supported surface format types description in NvMediaIDPFlip API.
237  */
240 #ifdef __cplusplus
241 }; /* extern "C" */
242 #endif
243 
244 #endif /* _NVMEDIA_IDP_H */
NvMediaTime
struct timespec NvMediaTime
Holds the media time in timespec format as defined by the POSIX specification.
Definition: nvmedia_core.h:85
NvMediaIDPFlip
NvMediaStatus NvMediaIDPFlip(NvMediaIDP *idp, NvMediaImage *image, NvMediaRect *srcRect, NvMediaRect *dstRect, NvMediaImage **releaseList, NvMediaTime *timeStamp)
Displays an image on the display device.
NvMediaIDP::windowId
uint32_t windowId
Display window Id.
Definition: nvmedia_idp.h:47
NvMediaIDPPreferences::width
uint32_t width
Display width.
Definition: nvmedia_idp.h:63
NvMediaIDP::displayId
uint32_t displayId
Display device (head) Id.
Definition: nvmedia_idp.h:45
NvMediaIDPDestroy
void NvMediaIDPDestroy(NvMediaIDP *idp)
Destroy an image display object created by NvMediaIDPCreate.
nvmedia_common.h
NVIDIA Media Interface: Common Types for Video/Image Encode/Decode
NvMediaVersion
Holds NvMedia version information.
Definition: nvmedia_core.h:237
NvMediaImageRec
Holds a handle representing image objects.
Definition: nvmedia_image.h:71
NvMediaIDP
Image display object created by NvMediaIDPCreate.
Definition: nvmedia_idp.h:43
NvMediaIDPDeviceParams::width
uint32_t width
Display width.
Definition: nvmedia_idp.h:79
NvMediaIDPDeviceParams::displayId
uint32_t displayId
Display device Id.
Definition: nvmedia_idp.h:75
NvMediaRect
Holds a rectangular region of a surface.
Definition: nvmedia_core.h:133
nvmedia_core.h
NVIDIA Media Interface: Core
NvMediaIDPDeviceParams
Device parameters returned by NvMediaIDPQuery function.
Definition: nvmedia_idp.h:73
NvMediaIDP::refreshRate
float_t refreshRate
Display refresh rate in Hertz.
Definition: nvmedia_idp.h:53
NvMediaStatus
NvMediaStatus
Defines all possible error codes.
Definition: nvmedia_core.h:180
NvMediaIDPGetVersion
NvMediaStatus NvMediaIDPGetVersion(NvMediaVersion *version)
Gets the version compatibility for the NvMedia IDP library.
NvMediaIDPPreferences::refreshRate
float_t refreshRate
Display refresh rate in Hertz.
Definition: nvmedia_idp.h:67
NvMediaIDPDeviceParams::height
uint32_t height
Display height.
Definition: nvmedia_idp.h:81
NvMediaIDPDeviceParams::refreshRate
float_t refreshRate
Display refresh rate in Hertz.
Definition: nvmedia_idp.h:83
NvMediaIDPCreate
NvMediaIDP * NvMediaIDPCreate(uint32_t displayId, uint32_t windowId, NvMediaIDPPreferences *displayPreference, NvMediaBool alreadyCreated)
Creates an image display object.
NvMediaIDP::width
uint32_t width
Display width.
Definition: nvmedia_idp.h:49
NvMediaIDPPreferences
Sets the preferences for the image display creation.
Definition: nvmedia_idp.h:61
NvMediaIDPPreferences::height
uint32_t height
Display height.
Definition: nvmedia_idp.h:65
NvMediaIDPQuery
NvMediaStatus NvMediaIDPQuery(int32_t *displayDevices, NvMediaIDPDeviceParams *displayParams)
Queries the display system and returns the parameters of all display devices.
NvMediaBool
uint32_t NvMediaBool
A boolean value, holding NVMEDIA_TRUE or NVMEDIA_FALSE.
Definition: nvmedia_core.h:80
NvMediaIDPDeviceParams::enabled
NvMediaBool enabled
Set to NVMEDIA_TRUE if the device is already enabled (initialized) by the system.
Definition: nvmedia_idp.h:77
nvmedia_image.h
NVIDIA Media Interface: Image Processing
NvMediaIDP::height
uint32_t height
Display height.
Definition: nvmedia_idp.h:51
NvMediaIDPSetAttributes
NvMediaStatus NvMediaIDPSetAttributes(NvMediaIDP *idp, uint32_t attributeMask, NvMediaDispAttributes *attributes)
Set NvMediaIDP attributes.
NvMediaDispAttributes
Holds NvMedia display attributes.
Definition: nvmedia_common.h:97