From 7ed5aa6c0eb65adc4b2b345f117bf61ca9d4bf35 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Tim-Philipp=20M=C3=BCller?= Date: Fri, 2 Dec 2005 16:52:54 +0000 Subject: [PATCH] Add gtk-doc blurbs to pango elements. Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-base-plugins-docs.sgml: * docs/plugins/gst-plugins-base-plugins-sections.txt: * docs/plugins/gst-plugins-base-plugins.hierarchy: * ext/pango/gstclockoverlay.c: * ext/pango/gsttextoverlay.c: * ext/pango/gsttextrender.c: * ext/pango/gsttimeoverlay.c: Add gtk-doc blurbs to pango elements. --- ChangeLog | 12 ++++ docs/plugins/Makefile.am | 4 ++ docs/plugins/gst-plugins-base-plugins-docs.sgml | 4 ++ docs/plugins/gst-plugins-base-plugins-sections.txt | 66 ++++++++++++++++------ docs/plugins/gst-plugins-base-plugins.hierarchy | 4 ++ ext/pango/gstclockoverlay.c | 31 ++++++++++ ext/pango/gsttextoverlay.c | 53 +++++++++++++++++ ext/pango/gsttextrender.c | 24 ++++++++ ext/pango/gsttimeoverlay.c | 31 ++++++++++ 9 files changed, 212 insertions(+), 17 deletions(-) diff --git a/ChangeLog b/ChangeLog index a83a043..1679067 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2005-12-02 Tim-Philipp Müller + + * docs/plugins/Makefile.am: + * docs/plugins/gst-plugins-base-plugins-docs.sgml: + * docs/plugins/gst-plugins-base-plugins-sections.txt: + * docs/plugins/gst-plugins-base-plugins.hierarchy: + * ext/pango/gstclockoverlay.c: + * ext/pango/gsttextoverlay.c: + * ext/pango/gsttextrender.c: + * ext/pango/gsttimeoverlay.c: + Add gtk-doc blurbs to pango elements. + 2005-12-02 Wim Taymans * gst/audioresample/buffer.c: (audioresample_buffer_queue_flush): diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 209da7e..da3b90e 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -77,6 +77,10 @@ IGNORE_CFILES = utils.c mem.c imgconvert.c # $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c EXTRA_HFILES = \ + $(top_srcdir)/ext/pango/gstclockoverlay.h \ + $(top_srcdir)/ext/pango/gsttextoverlay.h \ + $(top_srcdir)/ext/pango/gsttextrender.h \ + $(top_srcdir)/ext/pango/gsttimeoverlay.h \ $(top_srcdir)/ext/theora/gsttheoraenc.h \ $(top_srcdir)/ext/vorbis/vorbisenc.h \ $(top_srcdir)/gst/audioconvert/gstaudioconvert.h \ diff --git a/docs/plugins/gst-plugins-base-plugins-docs.sgml b/docs/plugins/gst-plugins-base-plugins-docs.sgml index 7092993..8235b30 100644 --- a/docs/plugins/gst-plugins-base-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-base-plugins-docs.sgml @@ -14,6 +14,7 @@ gst-plugins-base Elements + 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 #endif diff --git a/ext/pango/gsttextrender.c b/ext/pango/gsttextrender.c index 27e9d4c..365436a 100644 --- a/ext/pango/gsttextrender.c +++ b/ext/pango/gsttextrender.c @@ -18,6 +18,30 @@ * Boston, MA 02111-1307, USA. */ + +/** + * SECTION:element-textrender + * @see_also: #GstTextOverlay + * + * + * + * This plugin renders text received on the text sink pad to a video + * buffer (retaining the alpha channel), so it can later be overlayed + * on top of video streams using other elements. + * + * + * The text can contain newline characters. (FIXME: What about text + * wrapping? It does not make sense in this context) + * + * + * Example pipeline: + * + * gst-launch -v filesrc location=subtitles.srt ! subparse ! textrender ! xvimagesink + * + * + * + */ + #ifdef HAVE_CONFIG_H #include #endif diff --git a/ext/pango/gsttimeoverlay.c b/ext/pango/gsttimeoverlay.c index c3d9fc0..edbcea6 100644 --- a/ext/pango/gsttimeoverlay.c +++ b/ext/pango/gsttimeoverlay.c @@ -18,6 +18,37 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-timeoverlay + * @see_also: #GstTextOverlay, #GstClockOverlay + * + * + * + * This element overlays the buffer time stamps of a video stream on + * top of itself. You can position the text and configure the font details + * using the properties of the #GstTextOverlay class. By default, the + * time stamp is displayed in the top left corner of the picture, with some + * padding to the left and to the top. + * + * + * Here is a simple pipeline that displays the time stamps in the top left + * corner of the video picture: + * + * gst-launch -v videotestsrc ! timeoverlay ! xvimagesink + * + * + * + * Here is another pipeline that displays the time stamps with some leading + * text in the bottom right corner of the video picture, with the background + * of the text being shaded in order to make it more legible on top of a + * bright video background: + * + * gst-launch -v videotestsrc ! timeoverlay halign=right valign=bottom text="Stream time:" shaded-background=true ! xvimagesink + * + * + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif -- 2.7.4