/* GStreamer * Copyright (C) <1999> Erik Walthinsen * Copyright (C) <2003> David Schleef * Copyright (C) <2006> Julien Moutte * Copyright (C) <2006> Zeeshan Ali * Copyright (C) <2006-2008> Tim-Philipp Müller * Copyright (C) <2009> Young-Ho Cha * Copyright (C) <2011> Sebastian Dröge * * 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. */ /** * SECTION:element-textoverlay * @title: textoverlay * @see_also: #GstTextRender, #GstTextOverlay, #GstTimeOverlay, #GstSubParse * * This plugin renders text on top of a video stream. This can be either * static text or text from buffers received on the text sink pad, e.g. * as produced by the subparse element. If the text sink pad is not linked, * the text set via the "text" property will be rendered. If the text sink * pad is linked, text will be rendered as it is received on that pad, * honouring and matching the buffer timestamps of both input streams. * * The text can contain newline characters and text wrapping is enabled by * default. * * ## Example launch lines * |[ * gst-launch-1.0 -v videotestsrc ! textoverlay text="Room A" valignment=top halignment=left font-desc="Sans, 72" ! autovideosink * ]| * Here is a simple pipeline that displays a static text in the top left * corner of the video picture * |[ * gst-launch-1.0 -v filesrc location=subtitles.srt ! subparse ! txt. videotestsrc ! timeoverlay ! textoverlay name=txt shaded-background=yes ! autovideosink * ]| * Here is another pipeline that displays subtitles from an .srt subtitle * file, centered at the bottom of the picture and with a rectangular shading * around the text in the background: * * If you do not have such a subtitle file, create one looking like this * in a text editor: * |[ * 1 * 00:00:03,000 --> 00:00:05,000 * Hello? (3-5s) * * 2 * 00:00:08,000 --> 00:00:13,000 * Yes, this is a subtitle. Don't * you like it? (8-13s) * * 3 * 00:00:18,826 --> 00:01:02,886 * Uh? What are you talking about? * I don't understand (18-62s) * ]| * */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include static GstStaticPadTemplate text_sink_template_factory = GST_STATIC_PAD_TEMPLATE ("text_sink", GST_PAD_SINK, GST_PAD_ALWAYS, GST_STATIC_CAPS ("text/x-raw, format = { pango-markup, utf8 }") ); G_DEFINE_TYPE (GstTextOverlay, gst_text_overlay, GST_TYPE_BASE_TEXT_OVERLAY); static void gst_text_overlay_class_init (GstTextOverlayClass * klass) { GstElementClass *element_class = (GstElementClass *) klass; gst_element_class_add_static_pad_template (element_class, &text_sink_template_factory); gst_element_class_set_static_metadata (element_class, "Text overlay", "Filter/Editor/Video", "Adds text strings on top of a video buffer", "David Schleef , " "Zeeshan Ali "); } static void gst_text_overlay_init (GstTextOverlay * overlay) { }