NVIDIA DeepStream SDK API Reference

6.3 Release
nvll_osd_struct.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-2020, NVIDIA CORPORATION. All rights reserved.
3  *
4  * NVIDIA Corporation and its licensors retain all intellectual property
5  * and proprietary rights in and to this software, related documentation
6  * and any modifications thereto. Any use, reproduction, disclosure or
7  * distribution of this software and related documentation without an express
8  * license agreement from NVIDIA Corporation is strictly prohibited.
9  *
10  */
11 
28 #ifndef __NVLL_OSD_STRUCT_DEFS__
29 #define __NVLL_OSD_STRUCT_DEFS__
30 
31 #include <stdbool.h>
32 
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37 
41 typedef enum {
47 } NvOSD_Mode;
48 
52 typedef enum
53 {
61 
65 typedef struct _NvBbox_Coords {
66  float left;
69  float top;
72  float width;
74  float height;
76 
80 typedef struct _NvOSD_ColorParams {
81  double red;
84  double green;
87  double blue;
90  double alpha;
93 
97 typedef struct _NvOSD_FontParams {
98  char * font_name;
102 // char font_name[64]; /**< Holds a pointer to a string containing
103 // the font name. */
104 
105  unsigned int font_size;
109 
110 
114 typedef struct _NvOSD_TextParams {
115  char * display_text;
117  unsigned int x_offset;
119  unsigned int y_offset;
130 
131 typedef struct _NvOSD_Color_info {
132  int id;
135 
139 typedef struct _NvOSD_RectParams {
140  float left;
143  float top;
146  float width;
148  float height;
150  unsigned int border_width;
155  unsigned int has_bg_color;
158  unsigned int reserved;
163  int color_id;
165 
169 typedef struct _NvOSD_MaskParams {
170  float *data;
171  unsigned int size;
172  float threshold;
173  unsigned int width;
174  unsigned int height;
176 
180 typedef struct _NvOSD_LineParams {
181  unsigned int x1;
184  unsigned int y1;
187  unsigned int x2;
189  unsigned int y2;
191  unsigned int line_width;
195 
199 typedef struct _NvOSD_ArrowParams {
200  unsigned int x1;
202  unsigned int y1;
204  unsigned int x2;
206  unsigned int y2;
208  unsigned int arrow_width;
216  unsigned int reserved;
219 
223 typedef struct _NvOSD_CircleParams {
224  unsigned int xc;
226  unsigned int yc;
228  unsigned int radius;
233  unsigned int has_bg_color; /*< Holds a Boolean value indicating whether
234  the circle has a background color. */
235 
236  NvOSD_ColorParams bg_color; /*< Holds the circle's background color. */
237 
238  unsigned int reserved;
242 
243 #ifdef __cplusplus
244 }
245 #endif
246 
247 #endif
_NvOSD_ArrowParams::y1
unsigned int y1
Holds the start vertical coordinate in pixels.
Definition: nvll_osd_struct.h:202
_NvOSD_LineParams
Holds the box parameters of a line to be overlayed.
Definition: nvll_osd_struct.h:180
_NvOSD_MaskParams::threshold
float threshold
Size of mask buffer in bytes.
Definition: nvll_osd_struct.h:172
NvOSD_MaskParams
struct _NvOSD_MaskParams NvOSD_MaskParams
Holds the mask parameters of the segment to be overlayed.
_NvOSD_RectParams
Holds the box parameters of the box to be overlayed.
Definition: nvll_osd_struct.h:139
_NvOSD_MaskParams
Holds the mask parameters of the segment to be overlayed.
Definition: nvll_osd_struct.h:169
_NvOSD_ArrowParams::x2
unsigned int x2
Holds the end horizontal coordinate in pixels.
Definition: nvll_osd_struct.h:204
_NvOSD_RectParams::width
float width
Holds the box's width in pixels.
Definition: nvll_osd_struct.h:146
_NvOSD_ArrowParams::arrow_width
unsigned int arrow_width
Holds the arrow shaft width in pixels.
Definition: nvll_osd_struct.h:208
_NvOSD_Color_info
Definition: nvll_osd_struct.h:131
_NvOSD_RectParams::bg_color
NvOSD_ColorParams bg_color
Holds the box's background color.
Definition: nvll_osd_struct.h:160
_NvOSD_CircleParams::yc
unsigned int yc
Holds the start vertical coordinate in pixels.
Definition: nvll_osd_struct.h:226
MODE_GPU
@ MODE_GPU
Specifies using the GPU for OSD processing.
Definition: nvll_osd_struct.h:44
_NvBbox_Coords::height
float height
Holds the box's height in pixels.
Definition: nvll_osd_struct.h:74
_NvOSD_LineParams::y1
unsigned int y1
Holds the box's top coordinate in pixels.
Definition: nvll_osd_struct.h:184
_NvOSD_LineParams::x1
unsigned int x1
Holds the box's left coordinate in pixels.
Definition: nvll_osd_struct.h:181
_NvOSD_CircleParams
Holds circle parameters to be overlayed.
Definition: nvll_osd_struct.h:223
MODE_NONE
@ MODE_NONE
Invalid mode.
Definition: nvll_osd_struct.h:46
_NvOSD_FontParams::font_size
unsigned int font_size
Holds the size of the font.
Definition: nvll_osd_struct.h:105
NvOSD_LineParams
struct _NvOSD_LineParams NvOSD_LineParams
Holds the box parameters of a line to be overlayed.
_NvOSD_Color_info::color
NvOSD_ColorParams color
Definition: nvll_osd_struct.h:133
_NvOSD_FontParams::font_name
char * font_name
Holds a pointer to the string containing the font name.
Definition: nvll_osd_struct.h:98
_NvOSD_ColorParams::red
double red
Holds the red component of color.
Definition: nvll_osd_struct.h:81
_NvOSD_TextParams::set_bg_clr
int set_bg_clr
Holds a Boolean; true if the text has a background color.
Definition: nvll_osd_struct.h:123
_NvBbox_Coords::left
float left
Holds the box's left coordinate in pixels.
Definition: nvll_osd_struct.h:66
_NvOSD_LineParams::line_width
unsigned int line_width
Holds the box's border width in pixels.
Definition: nvll_osd_struct.h:191
_NvOSD_TextParams::y_offset
unsigned int y_offset
Holds the text's vertical offset from the top left pixel of the frame.
Definition: nvll_osd_struct.h:119
START_HEAD
@ START_HEAD
Specifies an arrow head only at start = 0.
Definition: nvll_osd_struct.h:55
_NvOSD_FontParams::font_color
NvOSD_ColorParams font_color
Holds the font color.
Definition: nvll_osd_struct.h:107
_NvOSD_RectParams::reserved
unsigned int reserved
Holds a field reserved for future use.
Definition: nvll_osd_struct.h:158
_NvOSD_ArrowParams::arrow_head
NvOSD_Arrow_Head_Direction arrow_head
Holds the arrowhead position.
Definition: nvll_osd_struct.h:210
_NvOSD_ArrowParams
Holds arrow parameters to be overlaid.
Definition: nvll_osd_struct.h:199
NvOSD_Color_info
struct _NvOSD_Color_info NvOSD_Color_info
NvOSD_CircleParams
struct _NvOSD_CircleParams NvOSD_CircleParams
Holds circle parameters to be overlayed.
_NvOSD_ArrowParams::y2
unsigned int y2
Holds the end vertical coordinate in pixels.
Definition: nvll_osd_struct.h:206
_NvOSD_MaskParams::size
unsigned int size
Mask buffer.
Definition: nvll_osd_struct.h:171
_NvOSD_CircleParams::radius
unsigned int radius
Holds the radius of circle in pixels.
Definition: nvll_osd_struct.h:228
_NvOSD_CircleParams::has_bg_color
unsigned int has_bg_color
Definition: nvll_osd_struct.h:233
NvOSD_TextParams
struct _NvOSD_TextParams NvOSD_TextParams
Holds parameters of text to be overlayed.
_NvOSD_FontParams
Holds the font parameters of the text to be overlayed.
Definition: nvll_osd_struct.h:97
_NvOSD_MaskParams::width
unsigned int width
Threshold for binarization.
Definition: nvll_osd_struct.h:173
_NvOSD_LineParams::x2
unsigned int x2
Holds the box's width in pixels.
Definition: nvll_osd_struct.h:187
_NvOSD_ColorParams::blue
double blue
Holds the blue component of color.
Definition: nvll_osd_struct.h:87
_NvOSD_RectParams::has_color_info
int has_color_info
Definition: nvll_osd_struct.h:162
NvBbox_Coords
struct _NvBbox_Coords NvBbox_Coords
Holds unclipped bounding box coordinates of the object.
_NvBbox_Coords::width
float width
Holds the box's width in pixels.
Definition: nvll_osd_struct.h:72
_NvOSD_TextParams::text_bg_clr
NvOSD_ColorParams text_bg_clr
Holds the text's background color, if specified.
Definition: nvll_osd_struct.h:126
_NvOSD_ArrowParams::reserved
unsigned int reserved
Reserved for future use; currently for internal use only.
Definition: nvll_osd_struct.h:216
NvOSD_Mode
NvOSD_Mode
Defines modes used to overlay boxes and text.
Definition: nvll_osd_struct.h:41
_NvOSD_RectParams::color_id
int color_id
Definition: nvll_osd_struct.h:163
BOTH_HEAD
@ BOTH_HEAD
Specifies arrow heads at both start and end = 2.
Definition: nvll_osd_struct.h:59
_NvOSD_Color_info::id
int id
Definition: nvll_osd_struct.h:132
_NvOSD_RectParams::left
float left
Holds the box's left coordinate in pixels.
Definition: nvll_osd_struct.h:140
_NvOSD_RectParams::border_color
NvOSD_ColorParams border_color
Holds the box's border color.
Definition: nvll_osd_struct.h:152
_NvOSD_TextParams::display_text
char * display_text
Holds the text to be overlayed.
Definition: nvll_osd_struct.h:115
NvOSD_FontParams
struct _NvOSD_FontParams NvOSD_FontParams
Holds the font parameters of the text to be overlayed.
_NvOSD_RectParams::has_bg_color
unsigned int has_bg_color
Holds a Boolean; true if the box has a background color.
Definition: nvll_osd_struct.h:155
_NvOSD_MaskParams::height
unsigned int height
Mask width.
Definition: nvll_osd_struct.h:174
_NvOSD_TextParams::x_offset
unsigned int x_offset
Holds the text's horizontal offset from the top left pixel of the frame.
Definition: nvll_osd_struct.h:117
_NvOSD_ArrowParams::x1
unsigned int x1
Holds the start horizontal coordinate in pixels.
Definition: nvll_osd_struct.h:200
_NvOSD_TextParams::font_params
NvOSD_FontParams font_params
Holds the font parameters of the text to be overlaid.
Definition: nvll_osd_struct.h:121
NvOSD_ArrowParams
struct _NvOSD_ArrowParams NvOSD_ArrowParams
Holds arrow parameters to be overlaid.
MODE_CPU
@ MODE_CPU
Specifies using the CPU for OSD processing.
Definition: nvll_osd_struct.h:42
END_HEAD
@ END_HEAD
Specifies an arrow head only at end = 1.
Definition: nvll_osd_struct.h:57
_NvOSD_TextParams
Holds parameters of text to be overlayed.
Definition: nvll_osd_struct.h:114
_NvOSD_ArrowParams::arrow_color
NvOSD_ColorParams arrow_color
Holds color parameters of the arrow box.
Definition: nvll_osd_struct.h:213
_NvOSD_ColorParams
Holds the color parameters of the box or text to be overlayed.
Definition: nvll_osd_struct.h:80
_NvOSD_RectParams::height
float height
Holds the box's height in pixels.
Definition: nvll_osd_struct.h:148
_NvOSD_ColorParams::green
double green
Holds the green component of color.
Definition: nvll_osd_struct.h:84
_NvOSD_CircleParams::xc
unsigned int xc
Holds the start horizontal coordinate in pixels.
Definition: nvll_osd_struct.h:224
NvOSD_RectParams
struct _NvOSD_RectParams NvOSD_RectParams
Holds the box parameters of the box to be overlayed.
_NvOSD_CircleParams::circle_color
NvOSD_ColorParams circle_color
Holds the color parameters of the arrow box.
Definition: nvll_osd_struct.h:230
_NvOSD_CircleParams::reserved
unsigned int reserved
Reserved for future use; currently for internal use only.
Definition: nvll_osd_struct.h:238
_NvOSD_CircleParams::bg_color
NvOSD_ColorParams bg_color
Definition: nvll_osd_struct.h:236
_NvOSD_LineParams::line_color
NvOSD_ColorParams line_color
Holds the box's border color.
Definition: nvll_osd_struct.h:193
_NvOSD_RectParams::border_width
unsigned int border_width
Holds the box's border width in pixels.
Definition: nvll_osd_struct.h:150
_NvBbox_Coords::top
float top
Holds the box's top coordinate in pixels.
Definition: nvll_osd_struct.h:69
NvOSD_ColorParams
struct _NvOSD_ColorParams NvOSD_ColorParams
Holds the color parameters of the box or text to be overlayed.
_NvOSD_RectParams::top
float top
Holds the box's top coordinate in pixels.
Definition: nvll_osd_struct.h:143
NvOSD_Arrow_Head_Direction
NvOSD_Arrow_Head_Direction
Specifies arrow head positions.
Definition: nvll_osd_struct.h:52
_NvBbox_Coords
Holds unclipped bounding box coordinates of the object.
Definition: nvll_osd_struct.h:65
_NvOSD_ColorParams::alpha
double alpha
Holds the alpha component of color.
Definition: nvll_osd_struct.h:90
_NvOSD_MaskParams::data
float * data
Definition: nvll_osd_struct.h:170
_NvOSD_LineParams::y2
unsigned int y2
Holds the box's height in pixels.
Definition: nvll_osd_struct.h:189