NVIDIA DeepStream SDK API Reference

9.0 Release
9.0/sources/apps/apps-common/includes/deepstream_osd.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2018-2019 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 
13 #ifndef __NVGSTDS_OSD_H__
14 #define __NVGSTDS_OSD_H__
15 
16 #include <gst/gst.h>
17 
18 #ifdef __cplusplus
19 extern "C"
20 {
21 #endif
22 
23 #include "nvll_osd_struct.h"
24 
25 typedef struct
26 {
27  GstElement *bin;
28  GstElement *queue;
29  GstElement *nvvidconv;
30  GstElement *conv_queue;
31  GstElement *cap_filter;
32  GstElement *nvosd;
33 } NvDsOSDBin;
34 
35 typedef struct
36 {
37  gboolean enable;
38  gboolean text_has_bg;
39  gboolean enable_clock;
40  gboolean draw_text;
41  gboolean draw_bbox;
42  gboolean draw_mask;
43  gint text_size;
44  gint border_width;
45  gint clock_text_size;
46  gint clock_x_offset;
47  gint clock_y_offset;
48  guint gpu_id;
49  guint nvbuf_memory_type; /* For nvvidconv */
50  guint num_out_buffers;
51  gchar *font;
52  gchar *hw_blend_color_attr;
53  NvOSD_Mode mode;
54  NvOSD_ColorParams clock_color;
55  NvOSD_ColorParams text_color;
56  NvOSD_ColorParams text_bg_color;
58 
69 gboolean create_osd_bin (NvDsOSDConfig *config, NvDsOSDBin *bin);
70 
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif
create_osd_bin
gboolean create_osd_bin(NvDsOSDConfig *config, NvDsOSDBin *bin)
Initialize NvDsOSDBin.
NvOSD_Mode
NvOSD_Mode
Defines modes used to overlay boxes and text.
Definition: sources/includes/nvll_osd_struct.h:42
NvDsOSDBin
Definition: sources/apps/apps-common/includes/deepstream_osd.h:25
_NvOSD_ColorParams
Holds the color parameters of the box or text to be overlayed.
Definition: sources/includes/nvll_osd_struct.h:81
NvDsOSDConfig
Definition: sources/apps/apps-common/includes/deepstream_osd.h:35