sources/gst-plugins/gst-nvdsosd/gstnvdsosd.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2016-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __GST_NVDSOSD_H__
#define __GST_NVDSOSD_H__
 
#include <gst/gst.h>
#include <gst/video/video.h>
#include <gst/video/gstvideofilter.h>
#include <stdlib.h>
#include "nvll_osd_api.h"
#include "gstnvdsmeta.h"
 
#define MAX_BG_CLR 20
 
G_BEGIN_DECLS
/* Standard GStreamer boilerplate */
#define GST_TYPE_NVDSOSD \
  (gst_nvds_osd_get_type())
#define GST_NVDSOSD(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_NVDSOSD,GstNvDsOsd))
#define GST_NVDSOSD_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_NVDSOSD,GstNvDsOsdClass))
#define GST_IS_NVDSOSD(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_NVDSOSD))
#define GST_IS_NVDSOSD_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_NVDSOSD))
/* Version number of package */
#define VERSION "1.8.2"
#define PACKAGE_DESCRIPTION "Gstreamer plugin to draw rectangles and text"
/* Define under which licence the package has been released */
#define PACKAGE_LICENSE "Proprietary"
#define PACKAGE_NAME "GStreamer nvosd Plugin"
/* Define to the home page for this package. */
#define PACKAGE_URL "http://nvidia.com/"
#define GST_CAPS_FEATURE_MEMORY_NVMM      "memory:NVMM"
typedef struct _GstNvDsOsd GstNvDsOsd;
typedef struct _GstNvDsOsdClass GstNvDsOsdClass;
 
struct _GstNvDsOsd
{
  GstBaseTransform parent_instance;
 
  /* Width of buffer. */
  gint width;
  /* Height of buffer. */
  gint height;
 
  void *nvdsosd_context;
  NvOSD_Mode nvdsosd_mode;
 
  gboolean show_clock;
  NvOSD_TextParams clock_text_params;
 
  NvOSD_TextParams *text_params;
  NvOSD_RectParams *rect_params;
  NvOSD_RectParams *blur_rect_params;
  NvOSD_RectParams *mask_rect_params;
  NvOSD_MaskParams *mask_params;
  NvOSD_LineParams *line_params;
  NvOSD_ArrowParams *arrow_params;
  NvOSD_CircleParams *circle_params;
 
  guint num_rect;
  guint num_segments;
  guint num_strings;
  guint num_lines;
  guint num_arrows;
  guint num_circles;
  guint num_blurs;
 
 
  NvOSD_FrameRectParams *frame_rect_params;
  NvOSD_FrameSegmentMaskParams *frame_mask_params;
  NvOSD_FrameTextParams *frame_text_params;
  NvOSD_FrameLineParams *frame_line_params;
  NvOSD_FrameArrowParams *frame_arrow_params;
  NvOSD_FrameCircleParams *frame_circle_params;
  NvOSD_FrameRectParams *frame_blur_params;
 
  gchar *font;
  guint clock_color;
  guint clock_font_size;
  guint border_width;
  guint frame_num;
  gboolean draw_text;
  gboolean draw_bbox;
  gboolean draw_mask;
  NvOSD_Color_info color_info[MAX_BG_CLR];
 
  int num_class_entries;
  guint gpu_id;
  void *conv_buf;
 
  guint blur_bbox;
  gchar *blur_gie_class_ids;
  GList *blur_gie_class_list;
};
 
/* GStreamer boilerplate. */
struct _GstNvDsOsdClass
{
  GstBaseTransformClass parent_class;
};
 
GType gst_nvds_osd_get_type (void);
 
G_END_DECLS
#endif /* __GST_NVDSOSD_H__ */