NVIDIA DeepStream SDK API Reference

6.4 Release
deepstream_osd.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2019, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef __NVGSTDS_OSD_H__
24 #define __NVGSTDS_OSD_H__
25 
26 #include <gst/gst.h>
27 
28 #ifdef __cplusplus
29 extern "C"
30 {
31 #endif
32 
33 #include "nvll_osd_struct.h"
34 
35 typedef struct
36 {
37  GstElement *bin;
38  GstElement *queue;
39  GstElement *nvvidconv;
40  GstElement *conv_queue;
41  GstElement *cap_filter;
42  GstElement *nvosd;
43 } NvDsOSDBin;
44 
45 typedef struct
46 {
47  gboolean enable;
48  gboolean text_has_bg;
49  gboolean enable_clock;
50  gboolean draw_text;
51  gboolean draw_bbox;
52  gboolean draw_mask;
53  gint text_size;
58  guint gpu_id;
59  guint nvbuf_memory_type; /* For nvvidconv */
61  gchar *font;
68 
79 gboolean create_osd_bin (NvDsOSDConfig *config, NvDsOSDBin *bin);
80 
81 #ifdef __cplusplus
82 }
83 #endif
84 
85 #endif
NvDsOSDConfig::clock_text_size
gint clock_text_size
Definition: deepstream_osd.h:55
NvDsOSDConfig::draw_bbox
gboolean draw_bbox
Definition: deepstream_osd.h:51
NvDsOSDConfig::enable_clock
gboolean enable_clock
Definition: deepstream_osd.h:49
create_osd_bin
gboolean create_osd_bin(NvDsOSDConfig *config, NvDsOSDBin *bin)
Initialize NvDsOSDBin.
NvDsOSDConfig::font
gchar * font
Definition: deepstream_osd.h:61
NvDsOSDConfig::text_color
NvOSD_ColorParams text_color
Definition: deepstream_osd.h:65
NvDsOSDConfig::clock_y_offset
gint clock_y_offset
Definition: deepstream_osd.h:57
NvDsOSDConfig::nvbuf_memory_type
guint nvbuf_memory_type
Definition: deepstream_osd.h:59
NvDsOSDConfig::gpu_id
guint gpu_id
Definition: deepstream_osd.h:58
NvDsOSDConfig::hw_blend_color_attr
gchar * hw_blend_color_attr
Definition: deepstream_osd.h:62
NvDsOSDConfig::draw_mask
gboolean draw_mask
Definition: deepstream_osd.h:52
NvDsOSDConfig::border_width
gint border_width
Definition: deepstream_osd.h:54
NvDsOSDBin::queue
GstElement * queue
Definition: deepstream_osd.h:38
NvDsOSDConfig::clock_x_offset
gint clock_x_offset
Definition: deepstream_osd.h:56
NvDsOSDBin::conv_queue
GstElement * conv_queue
Definition: deepstream_osd.h:40
NvOSD_Mode
NvOSD_Mode
Defines modes used to overlay boxes and text.
Definition: nvll_osd_struct.h:41
NvDsOSDConfig::text_size
gint text_size
Definition: deepstream_osd.h:53
NvDsOSDBin::bin
GstElement * bin
Definition: deepstream_osd.h:37
NvDsOSDBin
Definition: deepstream_osd.h:35
NvDsOSDConfig::text_has_bg
gboolean text_has_bg
Definition: deepstream_osd.h:48
NvDsOSDConfig::draw_text
gboolean draw_text
Definition: deepstream_osd.h:50
NvDsOSDConfig::num_out_buffers
guint num_out_buffers
Definition: deepstream_osd.h:60
NvDsOSDBin::nvvidconv
GstElement * nvvidconv
Definition: deepstream_osd.h:39
NvDsOSDConfig::enable
gboolean enable
Definition: deepstream_osd.h:47
NvDsOSDBin::cap_filter
GstElement * cap_filter
Definition: deepstream_osd.h:41
NvDsOSDBin::nvosd
GstElement * nvosd
Definition: deepstream_osd.h:42
_NvOSD_ColorParams
Holds the color parameters of the box or text to be overlayed.
Definition: nvll_osd_struct.h:80
NvDsOSDConfig::clock_color
NvOSD_ColorParams clock_color
Definition: deepstream_osd.h:64
NvDsOSDConfig::text_bg_color
NvOSD_ColorParams text_bg_color
Definition: deepstream_osd.h:66
nvll_osd_struct.h
NvDsOSDConfig
Definition: deepstream_osd.h:45
NvDsOSDConfig::mode
NvOSD_Mode mode
Definition: deepstream_osd.h:63