From b7e503a7f91fee881152f49d2ab021a89da15b05 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Sun, 6 May 2007 18:27:25 +0000 Subject: [PATCH] docs/: Correct fixxrefs options. Original commit message from CVS: * docs/gst/Makefile.am: * docs/libs/Makefile.am: Correct fixxrefs options. * docs/plugins/Makefile.am: * docs/plugins/gstreamer-plugins-docs.sgml: * docs/plugins/gstreamer-plugins-sections.txt: * plugins/elements/Makefile.am: * plugins/elements/gstcapsfilter.c (gst_capsfilter_details): * plugins/elements/gstcapsfilter.h (__GST_CAPSFILTER_H__, GST_TYPE_CAPSFILTER, GST_CAPSFILTER, GST_CAPSFILTER_CLASS, GST_IS_CAPSFILTER, GST_IS_CAPSFILTER_CLASS, GstCapsFilter, GstCapsFilterClass, _GstCapsFilter, trans, filter_caps, _GstCapsFilterClass, trans_class): * plugins/elements/gstelements.c (name, rank, type, _elements): * plugins/elements/gstidentity.c (gst_identity_check_imperfect_timestamp, gst_identity_check_imperfect_offset): Document capsfilter and add doc-blurb to identity. --- ChangeLog | 22 ++++++++++ docs/gst/Makefile.am | 2 +- docs/libs/Makefile.am | 2 +- docs/plugins/Makefile.am | 1 + docs/plugins/gstreamer-plugins-docs.sgml | 3 +- docs/plugins/gstreamer-plugins-sections.txt | 15 +++++++ plugins/elements/Makefile.am | 5 ++- plugins/elements/gstcapsfilter.c | 41 ++++-------------- plugins/elements/gstcapsfilter.h | 64 +++++++++++++++++++++++++++++ plugins/elements/gstelements.c | 6 +-- plugins/elements/gstidentity.c | 12 ++++-- 11 files changed, 128 insertions(+), 45 deletions(-) create mode 100644 plugins/elements/gstcapsfilter.h diff --git a/ChangeLog b/ChangeLog index 74aa06c..82a1fc2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,25 @@ +2007-05-06 Stefan Kost + + * docs/gst/Makefile.am: + * docs/libs/Makefile.am: + Correct fixxrefs options. + + * docs/plugins/Makefile.am: + * docs/plugins/gstreamer-plugins-docs.sgml: + * docs/plugins/gstreamer-plugins-sections.txt: + * plugins/elements/Makefile.am: + * plugins/elements/gstcapsfilter.c (gst_capsfilter_details): + * plugins/elements/gstcapsfilter.h (__GST_CAPSFILTER_H__, + GST_TYPE_CAPSFILTER, GST_CAPSFILTER, GST_CAPSFILTER_CLASS, + GST_IS_CAPSFILTER, GST_IS_CAPSFILTER_CLASS, GstCapsFilter, + GstCapsFilterClass, _GstCapsFilter, trans, filter_caps, + _GstCapsFilterClass, trans_class): + * plugins/elements/gstelements.c (name, rank, type, _elements): + * plugins/elements/gstidentity.c + (gst_identity_check_imperfect_timestamp, + gst_identity_check_imperfect_offset): + Document capsfilter and add doc-blurb to identity. + 2007-05-04 Tim-Philipp Müller * libs/gst/controller/gstcontroller.c: diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am index 0b080f5..1f42ee8 100644 --- a/docs/gst/Makefile.am +++ b/docs/gst/Makefile.am @@ -42,7 +42,7 @@ SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" MKDB_OPTIONS=--sgml-mode --ignore-files=parse # Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \ +FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib # The files containing the source code. Relative to $(top_srcdir). diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index 29913ed..5e1aaf3 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -51,7 +51,7 @@ SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED" MKDB_OPTIONS= --output-format=xml --sgml-mode --ignore-files=trio # Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \ +FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \ --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \ --extra-dir=$(datadir)/gtk-doc/html/gstreamer-@GST_MAJORMINOR@ diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 74a2392..b828571 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -76,6 +76,7 @@ IGNORE_CFILES = # the registry won't have the element EXTRA_HFILES = \ + $(top_srcdir)/plugins/elements/gstcapsfilter.h \ $(top_srcdir)/plugins/elements/gstfakesrc.h \ $(top_srcdir)/plugins/elements/gstfakesink.h \ $(top_srcdir)/plugins/elements/gstfdsrc.h \ diff --git a/docs/plugins/gstreamer-plugins-docs.sgml b/docs/plugins/gstreamer-plugins-docs.sgml index b34ba01..36fdc71 100644 --- a/docs/plugins/gstreamer-plugins-docs.sgml +++ b/docs/plugins/gstreamer-plugins-docs.sgml @@ -1,5 +1,5 @@ - %version-entities; @@ -12,6 +12,7 @@ gstreamer Elements + diff --git a/docs/plugins/gstreamer-plugins-sections.txt b/docs/plugins/gstreamer-plugins-sections.txt index 9c2f592..5e765fc 100644 --- a/docs/plugins/gstreamer-plugins-sections.txt +++ b/docs/plugins/gstreamer-plugins-sections.txt @@ -82,6 +82,21 @@ gst_file_sink_get_type
+element-capsfilter +capsfilter +GstCapsFilter + +GstCapsFilterClass +GST_CAPSFILTER +GST_IS_CAPSFILTER +GST_TYPE_CAPSFILTER +GST_CAPSFILTER_CLASS +GST_IS_CAPSFILTER_CLASS + +gst_capsfilter_get_type +
+ +
element-identity identity GstIdentity diff --git a/plugins/elements/Makefile.am b/plugins/elements/Makefile.am index 9099aca..d34951a 100644 --- a/plugins/elements/Makefile.am +++ b/plugins/elements/Makefile.am @@ -1,5 +1,5 @@ # FIXME: -# need to get gstbufferstore.[ch] into its own lib, preferably +# need to get gstbufferstore.[ch] into its own lib, preferably # libs/gst/bufferstore # This requires building libs/gst before this dir, which we currently don't # do. @@ -11,7 +11,7 @@ GSTFDSRC = gstfdsrc.c GSTFDSINK = gstfdsink.c else GSTFDSRC = -GSTFDSINK = +GSTFDSINK = endif libgstcoreelements_la_DEPENDENCIES = $(top_builddir)/gst/libgstreamer-@GST_MAJORMINOR@.la @@ -39,6 +39,7 @@ libgstcoreelements_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS) noinst_HEADERS = \ gstbufferstore.h \ + gstcapsfilter.h \ gstfakesink.h \ gstfakesrc.h \ gstfdsrc.h \ diff --git a/plugins/elements/gstcapsfilter.c b/plugins/elements/gstcapsfilter.c index 614f285..ceadfbb 100644 --- a/plugins/elements/gstcapsfilter.c +++ b/plugins/elements/gstcapsfilter.c @@ -19,15 +19,20 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-capsfilter + * @short_description: pass data though unmodified, but enforces format limmits + * + * The element does not modify data as such, but can enforce limmitations on the + * data format. + */ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include "../../gst/gst-i18n-lib.h" -#include -#include - +#include "gstcapsfilter.h" static const GstElementDetails gst_capsfilter_details = GST_ELEMENT_DETAILS ("CapsFilter", @@ -35,36 +40,6 @@ GST_ELEMENT_DETAILS ("CapsFilter", "Pass data without modification, limiting formats", "David Schleef "); - -#define GST_TYPE_CAPSFILTER \ - (gst_capsfilter_get_type()) -#define GST_CAPSFILTER(obj) \ - (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CAPSFILTER,GstCapsFilter)) -#define GST_CAPSFILTER_CLASS(klass) \ - (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CAPSFILTER,GstCapsFilterClass)) -#define GST_IS_CAPSFILTER(obj) \ - (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CAPSFILTER)) -#define GST_IS_CAPSFILTER_CLASS(klass) \ - (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CAPSFILTER)) - -typedef struct _GstCapsFilter GstCapsFilter; -typedef struct _GstCapsFilterClass GstCapsFilterClass; - -struct _GstCapsFilter -{ - GstBaseTransform trans; - - GstCaps *filter_caps; -}; - -struct _GstCapsFilterClass -{ - GstBaseTransformClass trans_class; -}; - -GType gst_capsfilter_get_type (void); - - enum { PROP_0, diff --git a/plugins/elements/gstcapsfilter.h b/plugins/elements/gstcapsfilter.h new file mode 100644 index 0000000..a07a78a --- /dev/null +++ b/plugins/elements/gstcapsfilter.h @@ -0,0 +1,64 @@ +/* GStreamer + * Copyright (C) 1999,2000 Erik Walthinsen + * 2000 Wim Taymans + * + * gstidentity.h: + * + * 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., 59 Temple Place - Suite 330, + * Boston, MA 02111-1307, USA. + */ + + +#ifndef __GST_CAPSFILTER_H__ +#define __GST_CAPSFILTER_H__ + + +#include +#include + +G_BEGIN_DECLS + +#define GST_TYPE_CAPSFILTER \ + (gst_capsfilter_get_type()) +#define GST_CAPSFILTER(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CAPSFILTER,GstCapsFilter)) +#define GST_CAPSFILTER_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CAPSFILTER,GstCapsFilterClass)) +#define GST_IS_CAPSFILTER(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CAPSFILTER)) +#define GST_IS_CAPSFILTER_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CAPSFILTER)) + +typedef struct _GstCapsFilter GstCapsFilter; +typedef struct _GstCapsFilterClass GstCapsFilterClass; + +struct _GstCapsFilter +{ + GstBaseTransform trans; + + GstCaps *filter_caps; +}; + +struct _GstCapsFilterClass +{ + GstBaseTransformClass trans_class; +}; + +GType gst_capsfilter_get_type (void); + +G_END_DECLS + +#endif /* __GST_CAPSFILTER_H__ */ + diff --git a/plugins/elements/gstelements.c b/plugins/elements/gstelements.c index 93d383a..3e12a89 100644 --- a/plugins/elements/gstelements.c +++ b/plugins/elements/gstelements.c @@ -27,6 +27,7 @@ #include +#include "gstcapsfilter.h" #include "gstfakesink.h" #include "gstfakesrc.h" #include "gstfdsrc.h" @@ -41,15 +42,12 @@ struct _elements_entry { - gchar *name; + const gchar *name; guint rank; GType (*type) (void); }; -/* this declaration is here because there's no gstcapsfilter.h */ -extern GType gst_capsfilter_get_type (void); - static struct _elements_entry _elements[] = { {"capsfilter", GST_RANK_NONE, gst_capsfilter_get_type}, {"fakesrc", GST_RANK_NONE, gst_fake_src_get_type}, diff --git a/plugins/elements/gstidentity.c b/plugins/elements/gstidentity.c index b91a19c..216b623 100644 --- a/plugins/elements/gstidentity.c +++ b/plugins/elements/gstidentity.c @@ -20,7 +20,13 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ - +/** + * SECTION:element-identity + * @short_description: pass data through without modification + * + * Dummy element that passes incomming data through unmodified. I has some + * useful diagnostic functions, such as offset and timestamp checking. + */ #ifdef HAVE_CONFIG_H # include "config.h" @@ -394,7 +400,7 @@ gst_identity_check_imperfect_timestamp (GstIdentity * identity, GstBuffer * buf) * @prev-duration: the previous buffer duration * @prev-offset: the previous buffer offset * @prev-offset-end: the previous buffer offset end - * @cur-timestamp: the current buffer timestamp + * @cur-timestamp: the current buffer timestamp * @cur-duration: the current buffer duration * @cur-offset: the current buffer offset * @cur-offset-end: the current buffer offset end @@ -440,7 +446,7 @@ gst_identity_check_imperfect_offset (GstIdentity * identity, GstBuffer * buf) * @prev-duration: the previous buffer duration * @prev-offset: the previous buffer offset * @prev-offset-end: the previous buffer offset end - * @cur-timestamp: the current buffer timestamp + * @cur-timestamp: the current buffer timestamp * @cur-duration: the current buffer duration * @cur-offset: the current buffer offset * @cur-offset-end: the current buffer offset end -- 2.7.4