From 6de7f9183064f4d72dd6e255af9ea1e061e68a16 Mon Sep 17 00:00:00 2001 From: "Bujewski, Tomasz" Date: Fri, 13 Mar 2026 14:41:04 +0100 Subject: [PATCH] [DOCS] Enhance gvawatermark documentation with additional display configuration options --- docs/source/elements/gvawatermark.md | 31 ++++++++++++------- .../gvawatermark/gstgvawatermarkimpl.h | 7 +++-- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/docs/source/elements/gvawatermark.md b/docs/source/elements/gvawatermark.md index ec2eb7a7..2c28e06b 100644 --- a/docs/source/elements/gvawatermark.md +++ b/docs/source/elements/gvawatermark.md @@ -68,22 +68,29 @@ Element Properties: Boolean. Default: false displ-cfg : Comma separated list of KEY=VALUE parameters of displayed notations. Available options: - show-labels= enable or disable displaying text labels, default true - font-scale= scale factor for text labels, default 0.5 - thickness= bounding box thickness, default 2 - color-idx= color index for bounding box, keypoints, and text, default -1 (use default colors: 0 red, 1 green, 2 blue) - draw-txt-bg= enable or disable displaying text labels background, by enabling it the text color is set to white, default true - font-type= font type for text labels, default triplex. Supported fonts: simplex, plain, duplex, complex, triplex, complex_small, script_simplex, script_complex - text-x= x position (pixels) for full-frame text (e.g. from gvagenai), default 0 - text-y= y position (pixels) for full-frame text (e.g. from gvagenai), default 25 - enable-blur= enable ROI blurring for privacy protection, default false - NOTE : this option is supported only for CPU for now. - show-blur-roi= colon-separated list of object labels to blur (e.g., "face:person") - hide-blur-roi= colon-separated list of labels to exclude from blurring (show-blur-roi takes precedence) + * show-labels= enable or disable displaying text labels, default true + * font-scale= scale factor for text labels, default 0.5 + * thickness= bounding box thickness, default 2 + * color-idx= color index for bounding box, keypoints, and text, default -1 (use default colors: 0 red, 1 green, 2 blue) + * font-type= font type for text labels, default triplex. Supported fonts: simplex, plain, duplex, complex, triplex, complex_small, script_simplex, script_complex + * draw-txt-bg= enable or disable displaying text labels background, by enabling it the text color is set to white, default true + * show-roi= colon-separated list of labels to include (only these objects will be shown), default empty + * hide-roi= colon-separated list of labels to exclude (these objects will be hidden), default empty + * enable-blur= enable ROI blurring for privacy protection, default false + NOTE : show-blur-roi takes precedence over hide-blur-roi when both are specified + NOTE : this option is supported only for CPU for now. + * show-blur-roi= colon-separated list of object labels to blur (e.g., "face:person") + * hide-blur-roi= colon-separated list of labels to exclude from blurring (show-blur-roi takes precedence) + * text-x= x position (pixels) for full-frame text (e.g. from gvagenai), default 0 + * text-y= y position (pixels) for full-frame text (e.g. from gvagenai), default 25 + e.g.: displ-cfg=show-labels=false e.g.: displ-cfg=font-scale=0.5,thickness=3,color-idx=2,font-type=plain + e.g.: displ-cfg=show-labels=true,show-roi=person:car:truck + e.g.: displ-cfg=show-labels=true,hide-roi=bottle:cup e.g.: displ-cfg=enable-blur=true,show-blur-roi=face:person e.g.: displ-cfg=text-y=680 (place full-frame text near bottom of a 720p frame) + flags: readable, writable String. Default: null device : Supported devices are CPU and GPU. Default is CPU on system memory and GPU on video memory diff --git a/src/monolithic/gst/elements/gvawatermark/gstgvawatermarkimpl.h b/src/monolithic/gst/elements/gvawatermark/gstgvawatermarkimpl.h index 3744e516..eae8d9a5 100644 --- a/src/monolithic/gst/elements/gvawatermark/gstgvawatermarkimpl.h +++ b/src/monolithic/gst/elements/gvawatermark/gstgvawatermarkimpl.h @@ -91,11 +91,14 @@ enum { PROP_0, PROP_DEVICE, PROP_OBB, PROP_DISPL_AVGFPS, PROP_DISPL_CFG }; "\t\t\thide-blur-roi= colon-separated list of object labels to exclude from blurring\n" \ "\t\t\tNOTE: show-blur-roi takes precedence over hide-blur-roi when both are specified\n" \ "\t\t\tNOTE: currently this option is only supported for CPU\n" \ + "\t\t\ttext-x= x position (pixels) for full-frame text (e.g. from gvagenai), default 0\n" \ + "\t\t\ttext-y= y position (pixels) for full-frame text (e.g. from gvagenai), default 25\n" \ "\t\t\te.g.: displ-cfg=show-labels=false\n" \ - "\t\t\te.g.: displ-cfg=font-scale=0.5,thickness=3,color-idx=2,font-type=simplex\n" \ + "\t\t\te.g.: displ-cfg=font-scale=0.5,thickness=3,color-idx=2,font-type=plain\n" \ "\t\t\te.g.: displ-cfg=show-labels=true,show-roi=person:car:truck\n" \ "\t\t\te.g.: displ-cfg=show-labels=true,hide-roi=bottle:cup\n" \ - "\t\t\te.g.: displ-cfg=enable-blur=true,show-blur-roi=face:person\n" + "\t\t\te.g.: displ-cfg=enable-blur=true,show-blur-roi=face:person\n" \ + "\t\t\te.g.: displ-cfg=text-y=680 (place full-frame text near bottom of a 720p frame)\n" G_END_DECLS