mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-03 16:09:39 +00:00
Code Issues 1 Projects Releases Wiki Activity
gstreamer/subprojects/gst-plugins-base/ext/pango/gstbasetextoverlay.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

248 lines
9.4 KiB
C
Raw Normal View History

pango: Add license/copyright header to header file
2014-12-15 09:35:35 +00:00
/* GStreamer
* Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
* Copyright (C) <2003> David Schleef <ds@schleef.org>
* Copyright (C) <2006> Julien Moutte <julien@moutte.net>
* Copyright (C) <2006> Zeeshan Ali <zeeshan.ali@nokia.com>
* Copyright (C) <2006-2008> Tim-Philipp Müller <tim centricular net>
* Copyright (C) <2009> Young-Ho Cha <ganadist@gmail.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
#ifndef __GST_BASE_TEXT_OVERLAY_H__
#define __GST_BASE_TEXT_OVERLAY_H__
#include <gst/gst.h>
#include <gst/video/video.h>
pango: use ported GstVideoOverlayComposition functionality Based on commits by Thibault Saunier <thibault.saunier@collabora.co.uk>
2012-06-28 16:14:10 +00:00
#include <gst/video/video-overlay-composition.h>
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
#include <pango/pangocairo.h>
G_BEGIN_DECLS
#define GST_TYPE_BASE_TEXT_OVERLAY (gst_base_text_overlay_get_type())
#define GST_BASE_TEXT_OVERLAY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),\
GST_TYPE_BASE_TEXT_OVERLAY, GstBaseTextOverlay))
#define GST_BASE_TEXT_OVERLAY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),\
GST_TYPE_BASE_TEXT_OVERLAY,GstBaseTextOverlayClass))
#define GST_BASE_TEXT_OVERLAY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj),\
GST_TYPE_BASE_TEXT_OVERLAY, GstBaseTextOverlayClass))
#define GST_IS_BASE_TEXT_OVERLAY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),\
GST_TYPE_BASE_TEXT_OVERLAY))
#define GST_IS_BASE_TEXT_OVERLAY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),\
GST_TYPE_BASE_TEXT_OVERLAY))
typedef struct _GstBaseTextOverlay GstBaseTextOverlay;
typedef struct _GstBaseTextOverlayClass GstBaseTextOverlayClass;
/**
* GstBaseTextOverlayVAlign:
* @GST_BASE_TEXT_OVERLAY_VALIGN_BASELINE: draw text on the baseline
* @GST_BASE_TEXT_OVERLAY_VALIGN_BOTTOM: draw text on the bottom
* @GST_BASE_TEXT_OVERLAY_VALIGN_TOP: draw text on top
* @GST_BASE_TEXT_OVERLAY_VALIGN_POS: draw text according to the #GstBaseTextOverlay:ypos property
* @GST_BASE_TEXT_OVERLAY_VALIGN_CENTER: draw text vertically centered
*
* Vertical alignment of the text.
*/
typedef enum {
GST_BASE_TEXT_OVERLAY_VALIGN_BASELINE,
GST_BASE_TEXT_OVERLAY_VALIGN_BOTTOM,
GST_BASE_TEXT_OVERLAY_VALIGN_TOP,
GST_BASE_TEXT_OVERLAY_VALIGN_POS,
basetextoverlay: Add new properties and alignment type for unclamped absolute positions Introduces [x-absolute, y-absolute] properties for positioning in +/- MAX_DOUBLE range. Adds new (h/v)alignment type "absolute" where coordinates map the text area to be exactly inside of video canvas for [0, 0] - [1, 1]: [0, 0]: Top-Lefts of video and text are aligned [0.5, 0.5]: Centers are aligned [1, 1]: Bottom-Rights are aligned https://bugzilla.gnome.org/show_bug.cgi?id=761251
2016-03-08 18:22:34 +00:00
GST_BASE_TEXT_OVERLAY_VALIGN_CENTER,
GST_BASE_TEXT_OVERLAY_VALIGN_ABSOLUTE
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
} GstBaseTextOverlayVAlign;
/**
* GstBaseTextOverlayHAlign:
* @GST_BASE_TEXT_OVERLAY_HALIGN_LEFT: align text left
* @GST_BASE_TEXT_OVERLAY_HALIGN_CENTER: align text center
* @GST_BASE_TEXT_OVERLAY_HALIGN_RIGHT: align text right
* @GST_BASE_TEXT_OVERLAY_HALIGN_POS: position text according to the #GstBaseTextOverlay:xpos property
*
* Horizontal alignment of the text.
*/
/* FIXME 0.11: remove GST_BASE_TEXT_OVERLAY_HALIGN_UNUSED */
typedef enum {
GST_BASE_TEXT_OVERLAY_HALIGN_LEFT,
GST_BASE_TEXT_OVERLAY_HALIGN_CENTER,
GST_BASE_TEXT_OVERLAY_HALIGN_RIGHT,
GST_BASE_TEXT_OVERLAY_HALIGN_UNUSED,
basetextoverlay: Add new properties and alignment type for unclamped absolute positions Introduces [x-absolute, y-absolute] properties for positioning in +/- MAX_DOUBLE range. Adds new (h/v)alignment type "absolute" where coordinates map the text area to be exactly inside of video canvas for [0, 0] - [1, 1]: [0, 0]: Top-Lefts of video and text are aligned [0.5, 0.5]: Centers are aligned [1, 1]: Bottom-Rights are aligned https://bugzilla.gnome.org/show_bug.cgi?id=761251
2016-03-08 18:22:34 +00:00
GST_BASE_TEXT_OVERLAY_HALIGN_POS,
GST_BASE_TEXT_OVERLAY_HALIGN_ABSOLUTE
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
} GstBaseTextOverlayHAlign;
/**
* GstBaseTextOverlayWrapMode:
* @GST_BASE_TEXT_OVERLAY_WRAP_MODE_NONE: no wrapping
* @GST_BASE_TEXT_OVERLAY_WRAP_MODE_WORD: do word wrapping
* @GST_BASE_TEXT_OVERLAY_WRAP_MODE_CHAR: do char wrapping
* @GST_BASE_TEXT_OVERLAY_WRAP_MODE_WORD_CHAR: do word and char wrapping
*
* Whether to wrap the text and if so how.
*/
typedef enum {
GST_BASE_TEXT_OVERLAY_WRAP_MODE_NONE = -1,
GST_BASE_TEXT_OVERLAY_WRAP_MODE_WORD = PANGO_WRAP_WORD,
GST_BASE_TEXT_OVERLAY_WRAP_MODE_CHAR = PANGO_WRAP_CHAR,
GST_BASE_TEXT_OVERLAY_WRAP_MODE_WORD_CHAR = PANGO_WRAP_WORD_CHAR
} GstBaseTextOverlayWrapMode;
/**
* GstBaseTextOverlayLineAlign:
* @GST_BASE_TEXT_OVERLAY_LINE_ALIGN_LEFT: lines are left-aligned
* @GST_BASE_TEXT_OVERLAY_LINE_ALIGN_CENTER: lines are center-aligned
* @GST_BASE_TEXT_OVERLAY_LINE_ALIGN_RIGHT: lines are right-aligned
*
* Alignment of text lines relative to each other
*/
typedef enum {
GST_BASE_TEXT_OVERLAY_LINE_ALIGN_LEFT = PANGO_ALIGN_LEFT,
GST_BASE_TEXT_OVERLAY_LINE_ALIGN_CENTER = PANGO_ALIGN_CENTER,
GST_BASE_TEXT_OVERLAY_LINE_ALIGN_RIGHT = PANGO_ALIGN_RIGHT
} GstBaseTextOverlayLineAlign;
textoverlay: optionally scale text to ensure proper display text aspect ratio ... by prescaling with an inverse aspect scaling as applied by video scaling
2017-05-21 10:34:08 +00:00
/**
* GstBaseTextOverlayScaleMode:
* @GST_BASE_TEXT_OVERLAY_SCALE_MODE_NONE: no compensation
* @GST_BASE_TEXT_OVERLAY_SCALE_MODE_PAR: compensate pixel-aspect-ratio scaling
* @GST_BASE_TEXT_OVERLAY_SCALE_MODE_DISPLAY: compensate for scaling to display (as determined by overlay allocation meta)
* @GST_BASE_TEXT_OVERLAY_SCALE_MODE_USER: compensate scaling set by #GstBaseTextOverlay:scale-pixel-aspect-ratio property
*
* Scale text to compensate for and avoid aspect distortion by subsequent
* scaling of video
*/
typedef enum {
GST_BASE_TEXT_OVERLAY_SCALE_MODE_NONE,
GST_BASE_TEXT_OVERLAY_SCALE_MODE_PAR,
GST_BASE_TEXT_OVERLAY_SCALE_MODE_DISPLAY,
GST_BASE_TEXT_OVERLAY_SCALE_MODE_USER
} GstBaseTextOverlayScaleMode;
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
/**
* GstBaseTextOverlay:
*
* Opaque textoverlay object structure
*/
struct _GstBaseTextOverlay {
GstElement element;
GstPad *video_sinkpad;
GstPad *text_sinkpad;
GstPad *srcpad;
pango: Create one context per instance and remove class mutex PangoCairo is thread-safe as long as the context and fontmap are not shared between threads. Previously each subclass had its own context and a class mutex for this reason, but apart from hurting performance this was also not completely safe yet: the same fontmap might've been used by different classes from different threads as the thread-default fontmap (at time of class initialization) was used.
2018-08-27 12:41:31 +00:00
PangoContext *pango_context;
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
GstSegment segment;
GstSegment text_segment;
GstBuffer *text_buffer;
basetextoverlay: Don't miscalculate text running times When a new segment event arrives, it immediately updates the current stored segment, which was used for calculating the running time of the current text buffer for every passing video frame. This means a segment that arrives after the text buffer might get used to (mis)calculate the running times subsequently. Instead, calculate and store the right running time using the current segment when storing the buffer. Later the stored segment can get freely updated. This fixes the case where pieces of video and text streams are seamlessly concatenated and fed through the text overlay. Previously, it could lead to the current text buffer suddenly have a massive running time and blocking all further input. Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/2802>
2022-07-27 12:34:42 +00:00
GstClockTime text_buffer_running_time;
GstClockTime text_buffer_running_time_end;
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
gboolean text_linked;
gboolean video_flushing;
gboolean video_eos;
gboolean text_flushing;
gboolean text_eos;
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
textoverlay: Use an external lock Conflicts: ext/pango/gsttextoverlay.c ext/pango/gsttextoverlay.h
2012-05-28 17:18:10 +00:00
GMutex lock;
pango: port to new GLib threading API
2012-01-18 17:21:02 +00:00
GCond cond; /* to signal removal of a queued text
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
* buffer, arrival of a text buffer,
* a text segment update, or a change
* in status (e.g. shutdown, flushing) */
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
/* stream metrics */
-base: port to GstVideoFrame API
2011-06-17 13:31:59 +00:00
GstVideoInfo info;
GstVideoFormat format;
basetextoverlay: Ensure meta coordinate are in stream scale The GstVideoOverlayComposition meta coordinates should always be in stream scale, regardless of the window size downstream. This way the sink can always scale the composition if the window size have changed after a buffer (with his meta) was rendered before. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 22:40:59 +00:00
gint width;
gint height;
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
/* properties */
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
gint xpad;
gint ypad;
gint deltax;
gint deltay;
gdouble xpos;
gdouble ypos;
gchar *default_text;
gboolean want_shading;
gboolean silent;
gboolean wait_text;
Merge branch 'master' into 0.11
2011-05-26 11:47:24 +00:00
guint color, outline_color;
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
PangoLayout *layout;
gboolean auto_adjust_size;
basetextoverlay: add "draw-shadow" and "draw-outline" properties https://bugzilla.gnome.org/show_bug.cgi?id=749823
2015-05-27 09:20:19 +00:00
gboolean draw_shadow;
gboolean draw_outline;
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
gint shading_value; /* for timeoverlay subclass */
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
gboolean use_vertical_render;
GstBaseTextOverlayVAlign valign;
GstBaseTextOverlayHAlign halign;
GstBaseTextOverlayWrapMode wrap_mode;
GstBaseTextOverlayLineAlign line_align;
textoverlay: optionally scale text to ensure proper display text aspect ratio ... by prescaling with an inverse aspect scaling as applied by video scaling
2017-05-21 10:34:08 +00:00
GstBaseTextOverlayScaleMode scale_mode;
gint scale_par_n;
gint scale_par_d;
pango: Add a property to compensate for display response time When measuring video latency, one mechanism involves taking a photo with a camera of two screens showing the test video overlayed with timeoverlay or clockoverlay. In these cases, if the display's pixel response time is crappy, you will see ghosting due to which it can be quite difficult to discern what the current timestamp being shown is. This commit adds a property that *also* shows the timestamp in a different (sequentially predictable) location every frame, which makes it easy to tell what the latest rendered timestamp is. For bonus points, you can also use the fade-time of the previous frame to measure with sub-framerate accuracy when the photo was taken, not just clamped to the framerate, giving you a higher precision latency value. Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6935>
2024-05-28 08:07:39 +00:00
gboolean alt_render;
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
/* text pad format */
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
gboolean have_pango_markup;
pango: use ported GstVideoOverlayComposition functionality Based on commits by Thibault Saunier <thibault.saunier@collabora.co.uk>
2012-06-28 16:14:10 +00:00
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
/* rendering state */
gboolean need_render;
GstBuffer *text_image;
basetextoverlay: Ensure meta coordinate are in stream scale The GstVideoOverlayComposition meta coordinates should always be in stream scale, regardless of the window size downstream. This way the sink can always scale the composition if the window size have changed after a buffer (with his meta) was rendered before. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 22:40:59 +00:00
/* dimension relative to witch the render is done, this is the stream size
* or a portion of the window_size (adapted to aspect ratio) */
gint render_width;
gint render_height;
/* This is (render_width / width) uses to convert to stream scale */
gdouble render_scale;
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
/* dimension of text_image, the physical dimension */
textoverlay: Expose rendering dimensions as properties. In order to detect graphical user input on the textoverlay, the resulting rendering properties need to be exposed to applications. Fixes delayx property declaration. https://bugzilla.gnome.org/show_bug.cgi?id=761251
2016-01-21 08:43:35 +00:00
guint text_width;
guint text_height;
/* position of rendering in image coordinates */
gint text_x;
gint text_y;
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
/* window dimension, reported in the composition meta params. This is set
basetextoverlay: Ensure meta coordinate are in stream scale The GstVideoOverlayComposition meta coordinates should always be in stream scale, regardless of the window size downstream. This way the sink can always scale the composition if the window size have changed after a buffer (with his meta) was rendered before. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 22:40:59 +00:00
* to stream width, height if missing */
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
gint window_width;
gint window_height;
gdouble shadow_offset;
gdouble outline_offset;
basetextoverlay: Use the extents rectangle for positioning the extents rectangle is what you need to know to properly position a buffer that has been rendered in a surface of the ink rectangle size. This patch make the placement on par with the placement we had before without having to over allocate. This patch also enable placement for vertical rendering. Note that the halginement, valighment and line-alignment default are set to the previous default when this property is set. This is for backward compatibility, you can change the value after setting vertical render. https://bugzilla.gnome.org/show_bug.cgi?id=728636
2015-07-23 19:28:42 +00:00
PangoRectangle ink_rect;
PangoRectangle logical_rect;
pango: use ported GstVideoOverlayComposition functionality Based on commits by Thibault Saunier <thibault.saunier@collabora.co.uk>
2012-06-28 16:14:10 +00:00
basetextoverlay: Reorder and cleanup class attribute Also add a minimum amount of comment so we can understand what is doing what. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-07-21 18:12:41 +00:00
gboolean attach_compo_to_buffer;
pango: use ported GstVideoOverlayComposition functionality Based on commits by Thibault Saunier <thibault.saunier@collabora.co.uk>
2012-06-28 16:14:10 +00:00
GstVideoOverlayComposition *composition;
basetestoverlay: Pass down meta buffers from upstream that supports GstVideoOverlayComposition This makes pipelines with multiple textoverlay elements possible. The meta data is collected from the upstream textoverlay element, merged into a new GstVideoOverlayComposition and passed down downstream. https://bugzilla.gnome.org/show_bug.cgi?id=751157
2015-03-19 16:59:16 +00:00
GstVideoOverlayComposition *upstream_composition;
pango: Create a new base class for all the elements This prevents the ugly hack where the text_sink pad template was only added for textoverlay but not for the subclasses. Also makes this work with the core change that made subclasses inherit the templates of their parent class.
2011-04-16 13:56:55 +00:00
};
struct _GstBaseTextOverlayClass {
GstElementClass parent_class;
gchar * (*get_text) (GstBaseTextOverlay *overlay, GstBuffer *video_frame);
};
GType gst_base_text_overlay_get_type(void) G_GNUC_CONST;
G_END_DECLS
#endif /* __GST_BASE_TEXT_OVERLAY_H */
Reference in a new issue Copy permalink