NVIDIA DeepStream SDK API Reference

7.0 Release
nvll_osd_struct.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2019-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 
29 #ifndef __NVLL_OSD_STRUCT_DEFS__
30 #define __NVLL_OSD_STRUCT_DEFS__
31 
32 #include <stdbool.h>
33 
34 #ifdef __cplusplus
35 extern "C"
36 {
37 #endif
38 
42 typedef enum {
48 } NvOSD_Mode;
49 
53 typedef enum
54 {
62 
66 typedef struct _NvBbox_Coords {
67  float left;
70  float top;
73  float width;
75  float height;
77 
81 typedef struct _NvOSD_ColorParams {
82  double red;
85  double green;
88  double blue;
91  double alpha;
94 
98 typedef struct _NvOSD_FontParams {
99  char * font_name;
103 // char font_name[64]; /**< Holds a pointer to a string containing
104 // the font name. */
105 
106  unsigned int font_size;
110 
111 
115 typedef struct _NvOSD_TextParams {
116  char * display_text;
118  unsigned int x_offset;
120  unsigned int y_offset;
131 
132 typedef struct _NvOSD_Color_info {
133  int id;
136 
140 typedef struct _NvOSD_RectParams {
141  float left;
144  float top;
147  float width;
149  float height;
151  unsigned int border_width;
156  unsigned int has_bg_color;
159  unsigned int reserved;
164  int color_id;
166 
170 typedef struct _NvOSD_MaskParams {
171  float *data;
172  unsigned int size;
173  float threshold;
174  unsigned int width;
175  unsigned int height;
177 
181 typedef struct _NvOSD_LineParams {
182  unsigned int x1;
185  unsigned int y1;
188  unsigned int x2;
190  unsigned int y2;
192  unsigned int line_width;
196 
200 typedef struct _NvOSD_ArrowParams {
201  unsigned int x1;
203  unsigned int y1;
205  unsigned int x2;
207  unsigned int y2;
209  unsigned int arrow_width;
217  unsigned int reserved;
220 
224 typedef struct _NvOSD_CircleParams {
225  unsigned int xc;
227  unsigned int yc;
229  unsigned int radius;
234  unsigned int has_bg_color; /*< Holds a Boolean value indicating whether
235  the circle has a background color. */
236 
237  NvOSD_ColorParams bg_color; /*< Holds the circle's background color. */
238 
239  unsigned int circle_width;
241  unsigned int reserved;
244 
245 #ifdef __cplusplus
246 }
247 #endif
248 
249 #endif
_NvOSD_ArrowParams::y1
unsigned int y1
Holds the start vertical coordinate in pixels.
Definition: nvll_osd_struct.h:203
_NvOSD_LineParams
Holds the box parameters of a line to be overlayed.
Definition: nvll_osd_struct.h:181
_NvOSD_MaskParams::threshold
float threshold
Size of mask buffer in bytes.
Definition: nvll_osd_struct.h:173
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:140
_NvOSD_MaskParams
Holds the mask parameters of the segment to be overlayed.
Definition: nvll_osd_struct.h:170
_NvOSD_ArrowParams::x2
unsigned int x2
Holds the end horizontal coordinate in pixels.
Definition: nvll_osd_struct.h:205
_NvOSD_RectParams::width
float width
Holds the box's width in pixels.
Definition: nvll_osd_struct.h:147
_NvOSD_ArrowParams::arrow_width
unsigned int arrow_width
Holds the arrow shaft width in pixels.
Definition: nvll_osd_struct.h:209
_NvOSD_Color_info
Definition: nvll_osd_struct.h:132
_NvOSD_RectParams::bg_color
NvOSD_ColorParams bg_color
Holds the box's background color.
Definition: nvll_osd_struct.h:161
_NvOSD_CircleParams::yc
unsigned int yc
Holds the start vertical coordinate in pixels.
Definition: nvll_osd_struct.h:227
MODE_GPU
@ MODE_GPU
Specifies using the GPU for OSD processing.
Definition: nvll_osd_struct.h:45
_NvBbox_Coords::height
float height
Holds the box's height in pixels.
Definition: nvll_osd_struct.h:75
_NvOSD_LineParams::y1
unsigned int y1
Holds the box's top coordinate in pixels.
Definition: nvll_osd_struct.h:185
_NvOSD_LineParams::x1
unsigned int x1
Holds the box's left coordinate in pixels.
Definition: nvll_osd_struct.h:182
_NvOSD_CircleParams
Holds circle parameters to be overlayed.
Definition: nvll_osd_struct.h:224
MODE_NONE
@ MODE_NONE
Invalid mode.
Definition: nvll_osd_struct.h:47
_NvOSD_FontParams::font_size
unsigned int font_size
Holds the size of the font.
Definition: nvll_osd_struct.h:106
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:134
_NvOSD_FontParams::font_name
char * font_name
Holds a pointer to the string containing the font name.
Definition: nvll_osd_struct.h:99
_NvOSD_ColorParams::red
double red
Holds the red component of color.
Definition: nvll_osd_struct.h:82
_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:124
_NvBbox_Coords::left
float left
Holds the box's left coordinate in pixels.
Definition: nvll_osd_struct.h:67
_NvOSD_LineParams::line_width
unsigned int line_width
Holds the box's border width in pixels.
Definition: nvll_osd_struct.h:192
_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:120
START_HEAD
@ START_HEAD
Specifies an arrow head only at start = 0.
Definition: nvll_osd_struct.h:56
_NvOSD_CircleParams::circle_width
unsigned int circle_width
Holds the circle's border width in pixels.
Definition: nvll_osd_struct.h:239
_NvOSD_FontParams::font_color
NvOSD_ColorParams font_color
Holds the font color.
Definition: nvll_osd_struct.h:108
_NvOSD_RectParams::reserved
unsigned int reserved
Holds a field reserved for future use.
Definition: nvll_osd_struct.h:159
_NvOSD_ArrowParams::arrow_head
NvOSD_Arrow_Head_Direction arrow_head
Holds the arrowhead position.
Definition: nvll_osd_struct.h:211
_NvOSD_ArrowParams
Holds arrow parameters to be overlaid.
Definition: nvll_osd_struct.h:200
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:207
_NvOSD_MaskParams::size
unsigned int size
Mask buffer.
Definition: nvll_osd_struct.h:172
_NvOSD_CircleParams::radius
unsigned int radius
Holds the radius of circle in pixels.
Definition: nvll_osd_struct.h:229
_NvOSD_CircleParams::has_bg_color
unsigned int has_bg_color
Definition: nvll_osd_struct.h:234
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:98
_NvOSD_MaskParams::width
unsigned int width
Threshold for binarization.
Definition: nvll_osd_struct.h:174
_NvOSD_LineParams::x2
unsigned int x2
Holds the box's width in pixels.
Definition: nvll_osd_struct.h:188
_NvOSD_ColorParams::blue
double blue
Holds the blue component of color.
Definition: nvll_osd_struct.h:88
_NvOSD_RectParams::has_color_info
int has_color_info
Definition: nvll_osd_struct.h:163
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:73
_NvOSD_TextParams::text_bg_clr
NvOSD_ColorParams text_bg_clr
Holds the text's background color, if specified.
Definition: nvll_osd_struct.h:127
_NvOSD_ArrowParams::reserved
unsigned int reserved
Reserved for future use; currently for internal use only.
Definition: nvll_osd_struct.h:217
NvOSD_Mode
NvOSD_Mode
Defines modes used to overlay boxes and text.
Definition: nvll_osd_struct.h:42
_NvOSD_RectParams::color_id
int color_id
Definition: nvll_osd_struct.h:164
BOTH_HEAD
@ BOTH_HEAD
Specifies arrow heads at both start and end = 2.
Definition: nvll_osd_struct.h:60
_NvOSD_Color_info::id
int id
Definition: nvll_osd_struct.h:133
_NvOSD_RectParams::left
float left
Holds the box's left coordinate in pixels.
Definition: nvll_osd_struct.h:141
_NvOSD_RectParams::border_color
NvOSD_ColorParams border_color
Holds the box's border color.
Definition: nvll_osd_struct.h:153
_NvOSD_TextParams::display_text
char * display_text
Holds the text to be overlayed.
Definition: nvll_osd_struct.h:116
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:156
_NvOSD_MaskParams::height
unsigned int height
Mask width.
Definition: nvll_osd_struct.h:175
_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:118
_NvOSD_ArrowParams::x1
unsigned int x1
Holds the start horizontal coordinate in pixels.
Definition: nvll_osd_struct.h:201
_NvOSD_TextParams::font_params
NvOSD_FontParams font_params
Holds the font parameters of the text to be overlaid.
Definition: nvll_osd_struct.h:122
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:43
END_HEAD
@ END_HEAD
Specifies an arrow head only at end = 1.
Definition: nvll_osd_struct.h:58
_NvOSD_TextParams
Holds parameters of text to be overlayed.
Definition: nvll_osd_struct.h:115
_NvOSD_ArrowParams::arrow_color
NvOSD_ColorParams arrow_color
Holds color parameters of the arrow box.
Definition: nvll_osd_struct.h:214
_NvOSD_ColorParams
Holds the color parameters of the box or text to be overlayed.
Definition: nvll_osd_struct.h:81
_NvOSD_RectParams::height
float height
Holds the box's height in pixels.
Definition: nvll_osd_struct.h:149
_NvOSD_ColorParams::green
double green
Holds the green component of color.
Definition: nvll_osd_struct.h:85
_NvOSD_CircleParams::xc
unsigned int xc
Holds the start horizontal coordinate in pixels.
Definition: nvll_osd_struct.h:225
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:231
_NvOSD_CircleParams::reserved
unsigned int reserved
Reserved for future use; currently for internal use only.
Definition: nvll_osd_struct.h:241
_NvOSD_CircleParams::bg_color
NvOSD_ColorParams bg_color
Definition: nvll_osd_struct.h:237
_NvOSD_LineParams::line_color
NvOSD_ColorParams line_color
Holds the box's border color.
Definition: nvll_osd_struct.h:194
_NvOSD_RectParams::border_width
unsigned int border_width
Holds the box's border width in pixels.
Definition: nvll_osd_struct.h:151
_NvBbox_Coords::top
float top
Holds the box's top coordinate in pixels.
Definition: nvll_osd_struct.h:70
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:144
NvOSD_Arrow_Head_Direction
NvOSD_Arrow_Head_Direction
Specifies arrow head positions.
Definition: nvll_osd_struct.h:53
_NvBbox_Coords
Holds unclipped bounding box coordinates of the object.
Definition: nvll_osd_struct.h:66
_NvOSD_ColorParams::alpha
double alpha
Holds the alpha component of color.
Definition: nvll_osd_struct.h:91
_NvOSD_MaskParams::data
float * data
Definition: nvll_osd_struct.h:171
_NvOSD_LineParams::y2
unsigned int y2
Holds the box's height in pixels.
Definition: nvll_osd_struct.h:190