From: <tp...@fr...> - 2005-12-02 16:53:16
|
CVS Root: /cvs/gstreamer Module: gst-plugins-base Changes by: tpm Date: Fri Dec 02 2005 08:53:07 PST Log message: * 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. Modified files: . : ChangeLog docs/plugins : Makefile.am gst-plugins-base-plugins-docs.sgml gst-plugins-base-plugins-sections.txt gst-plugins-base-plugins.hierarchy ext/pango : gstclockoverlay.c gsttextoverlay.c gsttextrender.c gsttimeoverlay.c Links: http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/ChangeLog.diff?r1=1.2205&r2=1.2206 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/docs/plugins/Makefile.am.diff?r1=1.16&r2=1.17 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/docs/plugins/gst-plugins-base-plugins-docs.sgml.diff?r1=1.13&r2=1.14 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/docs/plugins/gst-plugins-base-plugins-sections.txt.diff?r1=1.11&r2=1.12 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/docs/plugins/gst-plugins-base-plugins.hierarchy.diff?r1=1.2&r2=1.3 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/ext/pango/gstclockoverlay.c.diff?r1=1.2&r2=1.3 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/ext/pango/gsttextoverlay.c.diff?r1=1.21&r2=1.22 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/ext/pango/gsttextrender.c.diff?r1=1.2&r2=1.3 http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gst-plugins-base/ext/pango/gsttimeoverlay.c.diff?r1=1.16&r2=1.17 ====Begin Diffs==== Index: ChangeLog =================================================================== RCS file: /cvs/gstreamer/gst-plugins-base/ChangeLog,v retrieving revision 1.2205 retrieving revision 1.2206 diff -u -d -r1.2205 -r1.2206 --- ChangeLog 2 Dec 2005 11:34:49 -0000 1.2205 +++ ChangeLog 2 Dec 2005 16:52:54 -0000 1.2206 @@ -1,3 +1,15 @@ +2005-12-02 Tim-Philipp Müller <tim at centricular dot net> + + * 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 <wi...@fl...> * gst/audioresample/buffer.c: (audioresample_buffer_queue_flush): Index: Makefile.am RCS file: /cvs/gstreamer/gst-plugins-base/docs/plugins/Makefile.am,v retrieving revision 1.16 retrieving revision 1.17 diff -u -d -r1.16 -r1.17 --- Makefile.am 1 Dec 2005 01:12:54 -0000 1.16 +++ Makefile.am 2 Dec 2005 16:52:54 -0000 1.17 @@ -77,6 +77,10 @@ # $(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 \ Index: gst-plugins-base-plugins-docs.sgml RCS file: /cvs/gstreamer/gst-plugins-base/docs/plugins/gst-plugins-base-plugins-docs.sgml,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- gst-plugins-base-plugins-docs.sgml 1 Dec 2005 15:52:26 -0000 1.13 +++ gst-plugins-base-plugins-docs.sgml 2 Dec 2005 16:52:54 -0000 1.14 @@ -14,6 +14,7 @@ <title>gst-plugins-base Elements</title> <xi:include href="xml/element-audioconvert.xml" /> <xi:include href="xml/element-audiotestsrc.xml" /> + <xi:include href="xml/element-clockoverlay.xml" /> <xi:include href="xml/element-ffmpegcolorspace.xml" /> <!-- <xi:include href="xml/element-gnomevfssink.xml" /> @@ -21,6 +22,9 @@ <xi:include href="xml/element-multifdsink.xml" /> <xi:include href="xml/element-tcpserversink.xml" /> <xi:include href="xml/element-theoraenc.xml" /> + <xi:include href="xml/element-textoverlay.xml" /> + <xi:include href="xml/element-textrender.xml" /> + <xi:include href="xml/element-timeoverlay.xml" /> <xi:include href="xml/element-videotestsrc.xml" /> <xi:include href="xml/element-volume.xml" /> <xi:include href="xml/element-vorbisenc.xml" /> Index: gst-plugins-base-plugins-sections.txt RCS file: /cvs/gstreamer/gst-plugins-base/docs/plugins/gst-plugins-base-plugins-sections.txt,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- gst-plugins-base-plugins-sections.txt 26 Nov 2005 15:26:36 -0000 1.11 +++ gst-plugins-base-plugins-sections.txt 2 Dec 2005 16:52:54 -0000 1.12 @@ -16,6 +16,14 @@ </SECTION> <SECTION> +<FILE>element-clockoverlay</FILE> +<TITLE>clockoverlay</TITLE> +GstClockOverlay +<SUBSECTION Standard> +GstClockOverlayClass +</SECTION> +<SECTION> <FILE>element-ffmpegcolorspace</FILE> <TITLE>ffmpegcolorspace</TITLE> GstFFMpegCsp @@ -54,6 +62,22 @@ +<FILE>element-textoverlay</FILE> +<TITLE>textoverlay</TITLE> +GstTextOverlay +GstTextOverlayClass +<FILE>element-textrender</FILE> +<TITLE>textrender</TITLE> +GstTextRender +GstTextRenderClass <FILE>element-theoraenc</FILE> <TITLE>theoraenc</TITLE> GstTheoraEnc @@ -63,6 +87,14 @@ +<FILE>element-timeoverlay</FILE> +<TITLE>timeoverlay</TITLE> +GstTimeOverlay +GstTimeOverlayClass <FILE>element-videotestsrc</FILE> <TITLE>videotestsrc</TITLE> GstVideoTestSrc @@ -108,27 +140,27 @@ CLIENTS_UNLOCK CLIENTS_LOCK_INIT -GST_MULTIFDSINK_GET_CLASS +GST_MULTI_FD_SINK_GET_CLASS CLIENTS_LOCK_FREE -GST_IS_MULTIFDSINK_CLASS -gst_multifdsink_get_type -gst_multifdsink_remove -GST_IS_MULTIFDSINK +GST_IS_MULTI_FD_SINK_CLASS +gst_multi_fd_sinkget_type +gst_multi_fd_sinkremove +GST_IS_MULTI_FD_SINK CLIENTS_LOCK -GST_TYPE_MULTIFDSINK -gst_multifdsink_clear +GST_TYPE_MULTI_FD_SINK +gst_multi_fd_sinkclear GstTCPClient -GST_MULTIFDSINK_CLASS -gst_multifdsink_get_stats -GST_MULTIFDSINK -gst_multifdsink_add +GST_MULTI_FD_SINK_CLASS +gst_multi_fd_sinkget_stats +GST_MULTI_FD_SINK +gst_multi_fd_sinkadd -GST_TCPSERVERSINK +GST_TCP_SERVER_SINK GstTCPServerSinkFlags -GST_TYPE_TCPSERVERSINK -gst_tcpserversink_get_type -GST_IS_TCPSERVERSINK_CLASS -GST_IS_TCPSERVERSINK +GST_TYPE_TCP_SERVER_SINK +gst_tcp_server_sink_get_type +GST_IS_TCP_SERVER_SINK_CLASS +GST_IS_TCP_SERVER_SINK GST_GNOMEVFSSINK_CLASS GST_TYPE_GNOMEVFSSINK @@ -142,7 +174,7 @@ GST_IS_VORBISENC GST_VORBISENC_CLASS GST_VORBISENC -GST_TCPSERVERSINK_CLASS +GST_TCP_SERVER_SINK_CLASS GST_TYPE_VORBISENC GST_IS_VORBISENC_CLASS vorbisenc_get_type Index: gst-plugins-base-plugins.hierarchy RCS file: /cvs/gstreamer/gst-plugins-base/docs/plugins/gst-plugins-base-plugins.hierarchy,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- gst-plugins-base-plugins.hierarchy 15 Sep 2005 14:35:04 -0000 1.2 +++ gst-plugins-base-plugins.hierarchy 2 Dec 2005 16:52:54 -0000 1.3 @@ -47,6 +47,10 @@ GstVorbisEnc GstVorbisDec GstVorbisParse + GstTextOverlay + GstTimeOverlay + GstClockOverlay + GstTextRender GstTheoraDec GstTheoraEnc GstVisual Index: gstclockoverlay.c RCS file: /cvs/gstreamer/gst-plugins-base/ext/pango/gstclockoverlay.c,v --- gstclockoverlay.c 1 Dec 2005 15:56:53 -0000 1.2 +++ gstclockoverlay.c 2 Dec 2005 16:52:54 -0000 1.3 @@ -18,6 +18,37 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-clockoverlay + * @see_also: #GstTextOverlay, #GstTimeOverlay + * + * <refsect2> + * <para> + * This element overlays the current clock time on top of a video + * stream. You can position the text and configure the font details + * using the properties of the #GstTextOverlay class. By default, the + * time is displayed in the top left corner of the picture, with some + * padding to the left and to the top. + * </para> + * Here is a simple pipeline that displays the current time in the top left + * corner of the video picture: + * <programlisting> + * gst-launch -v videotestsrc ! clockoverlay ! xvimagesink + * </programlisting> + * Here is another pipeline that displays the current time 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 ! clockoverlay halign=right valign=bottom text="Edge City" shaded-background=true ! ffmpegcolorspace ! ximagesink + * </refsect2> + */ #ifdef HAVE_CONFIG_H #include "config.h" #endif Index: gsttextoverlay.c RCS file: /cvs/gstreamer/gst-plugins-base/ext/pango/gsttextoverlay.c,v retrieving revision 1.21 retrieving revision 1.22 diff -u -d -r1.21 -r1.22 --- gsttextoverlay.c 30 Nov 2005 13:20:57 -0000 1.21 +++ gsttextoverlay.c 2 Dec 2005 16:52:54 -0000 1.22 @@ -18,6 +18,59 @@ + * SECTION:element-textoverlay + * @see_also: #GstTextRender, #GstClockOverlay, #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. + * Here is a simple pipeline that displays a static text in the top left + * gst-launch -v videotestsrc ! textoverlay text="Room A" valign=top halign=left ! xvimagesink + * 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: + * gst-launch -v filesrc location=subtitles.srt ! subparse ! txt. videotestsrc ! timeoverlay ! textoverlay name=txt shaded-background=yes ! xvimagesink + * If you do not have such a subtitle file, create on 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) #include <config.h> Index: gsttextrender.c RCS file: /cvs/gstreamer/gst-plugins-base/ext/pango/gsttextrender.c,v --- gsttextrender.c 30 Nov 2005 14:53:29 -0000 1.2 +++ gsttextrender.c 2 Dec 2005 16:52:54 -0000 1.3 @@ -18,6 +18,30 @@ + * 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 Index: gsttimeoverlay.c RCS file: /cvs/gstreamer/gst-plugins-base/ext/pango/gsttimeoverlay.c,v --- gsttimeoverlay.c 1 Dec 2005 15:56:53 -0000 1.16 +++ gsttimeoverlay.c 2 Dec 2005 16:52:54 -0000 1.17 + * 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 + * time stamp is displayed in the top left corner of the picture, with some + * Here is a simple pipeline that displays the time stamps in the top left + * gst-launch -v videotestsrc ! timeoverlay ! xvimagesink + * Here is another pipeline that displays the time stamps with some leading + * gst-launch -v videotestsrc ! timeoverlay halign=right valign=bottom text="Stream time:" shaded-background=true ! xvimagesink |