From 7002f0336ba04f7e85c81a6287221fa906da3f42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim-Philipp=20M=C3=BCller?= Date: Tue, 24 Apr 2007 09:12:42 +0000 Subject: [PATCH] Add minimal docs blurb to alphacolor; split out headers into separate header file for gtk-doc. Original commit message from CVS: * docs/plugins/Makefile.am: * docs/plugins/gst-plugins-good-plugins-docs.sgml: * docs/plugins/gst-plugins-good-plugins-sections.txt: * docs/plugins/inspect/plugin-alphacolor.xml: * gst/alpha/Makefile.am: * gst/alpha/gstalphacolor.c: * gst/alpha/gstalphacolor.h: Add minimal docs blurb to alphacolor; split out headers into separate header file for gtk-doc. --- ChangeLog | 12 ++++ common | 2 +- docs/plugins/Makefile.am | 1 + .../gst-plugins-good-plugins-docs.sgml | 1 + .../gst-plugins-good-plugins-sections.txt | 14 +++++ docs/plugins/inspect/plugin-alphacolor.xml | 4 +- gst/alpha/Makefile.am | 2 + gst/alpha/gstalphacolor.c | 48 ++++++---------- gst/alpha/gstalphacolor.h | 57 +++++++++++++++++++ 9 files changed, 106 insertions(+), 35 deletions(-) create mode 100644 gst/alpha/gstalphacolor.h diff --git a/ChangeLog b/ChangeLog index 9b1e37567f..b44affeaa1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2007-04-24 Tim-Philipp Müller + + * docs/plugins/Makefile.am: + * docs/plugins/gst-plugins-good-plugins-docs.sgml: + * docs/plugins/gst-plugins-good-plugins-sections.txt: + * docs/plugins/inspect/plugin-alphacolor.xml: + * gst/alpha/Makefile.am: + * gst/alpha/gstalphacolor.c: + * gst/alpha/gstalphacolor.h: + Add minimal docs blurb to alphacolor; split out headers into + separate header file for gtk-doc. + 2007-04-20 Tim-Philipp Müller * gst/debug/progressreport.c: (gst_progress_report_report): diff --git a/common b/common index 765d03a884..a19d235c89 160000 --- a/common +++ b/common @@ -1 +1 @@ -Subproject commit 765d03a88492fb4ac81d70457f671f3a109e93de +Subproject commit a19d235c89d99ca7849078d501129f521e30d98d diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 174bb997c7..e94a8b5c22 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -77,6 +77,7 @@ IGNORE_CFILES = # the registry won't have the element EXTRA_HFILES = \ + $(top_srcdir)/gst/alpha/gstalphacolor.h \ $(top_srcdir)/gst/apetag/gstapedemux.h \ $(top_srcdir)/gst/audiofx/audiopanorama.h \ $(top_srcdir)/gst/audiofx/audioinvert.h \ diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml index 291cc46595..a04e258546 100644 --- a/docs/plugins/gst-plugins-good-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml @@ -12,6 +12,7 @@ gst-plugins-good Elements + diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt index 7a694bbbf8..d8e572b3e1 100644 --- a/docs/plugins/gst-plugins-good-plugins-sections.txt +++ b/docs/plugins/gst-plugins-good-plugins-sections.txt @@ -1,3 +1,17 @@ +
+element-alphacolor +GstAlphaColor +alphacolor + +GstAlphaColorClass +GST_ALPHA_COLOR +GST_IS_ALPHA_COLOR +GST_TYPE_ALPHA_COLOR +gst_alpha_color_get_type +GST_ALPHA_COLOR_CLASS +GST_IS_ALPHA_COLOR_CLASS +
+
element-apedemux GstApeDemux diff --git a/docs/plugins/inspect/plugin-alphacolor.xml b/docs/plugins/inspect/plugin-alphacolor.xml index 8dd253ba50..a2df37e7f3 100644 --- a/docs/plugins/inspect/plugin-alphacolor.xml +++ b/docs/plugins/inspect/plugin-alphacolor.xml @@ -1,6 +1,6 @@ alphacolor - RGB->YUV colorspace conversion preserving the alpha channels + RGBA to AYUV colorspace conversion preserving the alpha channel ../../gst/alpha/.libs/libgstalphacolor.so libgstalphacolor.so 0.10.5.1 @@ -13,7 +13,7 @@ alphacolor Alpha color filter Filter/Effect/Video - RGB->YUV colorspace conversion preserving the alpha channels + RGBA to AYUV colorspace conversion preserving the alpha channel Wim Taymans <wim@fluendo.com> diff --git a/gst/alpha/Makefile.am b/gst/alpha/Makefile.am index daf0050ba0..67c20b74bf 100644 --- a/gst/alpha/Makefile.am +++ b/gst/alpha/Makefile.am @@ -11,3 +11,5 @@ libgstalphacolor_la_CFLAGS = $(GST_PLUGINS_BASE_CFLAGS) \ $(GST_BASE_CFLAGS) $(GST_CFLAGS) libgstalphacolor_la_LIBADD = $(GST_LIBS) $(GST_BASE_LIBS) libgstalphacolor_la_LDFLAGS = $(GST_PLUGIN_LDFLAGS) + +noinst_HEADERS = gstalphacolor.h diff --git a/gst/alpha/gstalphacolor.c b/gst/alpha/gstalphacolor.c index 15c26c127d..118de628e0 100644 --- a/gst/alpha/gstalphacolor.c +++ b/gst/alpha/gstalphacolor.c @@ -17,11 +17,24 @@ * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-alphacolor + * + * + * + * The alphacolor element does memory-efficient (in-place) colourspace + * conversion from RGBA to AYUV, preserving the alpha channel. + * + * + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif + +#include "gstalphacolor.h" + #include -#include #include #include @@ -29,40 +42,11 @@ GST_DEBUG_CATEGORY_STATIC (alpha_color_debug); #define GST_CAT_DEFAULT alpha_color_debug -#define GST_TYPE_ALPHA_COLOR \ - (gst_alpha_color_get_type()) -#define GST_ALPHA_COLOR(obj) \ - (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ALPHA_COLOR,GstAlphaColor)) -#define GST_ALPHA_COLOR_CLASS(klass) \ - (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ALPHA_COLOR,GstAlphaColorClass)) -#define GST_IS_ALPHA_COLOR(obj) \ - (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ALPHA_COLOR)) -#define GST_IS_ALPHA_COLOR_CLASS(klass) \ - (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ALPHA_COLOR)) - -typedef struct _GstAlphaColor GstAlphaColor; -typedef struct _GstAlphaColorClass GstAlphaColorClass; - -struct _GstAlphaColor -{ - GstBaseTransform element; - - /* caps */ - gint in_width, in_height; - gboolean in_rgba; - gint out_width, out_height; -}; - -struct _GstAlphaColorClass -{ - GstBaseTransformClass parent_class; -}; - /* elementfactory information */ static const GstElementDetails gst_alpha_color_details = GST_ELEMENT_DETAILS ("Alpha color filter", "Filter/Effect/Video", - "RGB->YUV colorspace conversion preserving the alpha channels", + "RGBA to AYUV colorspace conversion preserving the alpha channel", "Wim Taymans "); static GstStaticPadTemplate gst_alpha_color_sink_template = @@ -285,5 +269,5 @@ plugin_init (GstPlugin * plugin) GST_PLUGIN_DEFINE (GST_VERSION_MAJOR, GST_VERSION_MINOR, "alphacolor", - "RGB->YUV colorspace conversion preserving the alpha channels", + "RGBA to AYUV colorspace conversion preserving the alpha channel", plugin_init, VERSION, GST_LICENSE, GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN) diff --git a/gst/alpha/gstalphacolor.h b/gst/alpha/gstalphacolor.h new file mode 100644 index 0000000000..306cd2c667 --- /dev/null +++ b/gst/alpha/gstalphacolor.h @@ -0,0 +1,57 @@ +/* GStreamer alphacolor element + * Copyright (C) 2005 Wim Taymans + * + * 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_ALPHA_COLOR_H_ +#define _GST_ALPHA_COLOR_H_ + +#include + +#define GST_TYPE_ALPHA_COLOR \ + (gst_alpha_color_get_type()) +#define GST_ALPHA_COLOR(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ALPHA_COLOR,GstAlphaColor)) +#define GST_ALPHA_COLOR_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ALPHA_COLOR,GstAlphaColorClass)) +#define GST_IS_ALPHA_COLOR(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ALPHA_COLOR)) +#define GST_IS_ALPHA_COLOR_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ALPHA_COLOR)) + +typedef struct _GstAlphaColor GstAlphaColor; +typedef struct _GstAlphaColorClass GstAlphaColorClass; + +struct _GstAlphaColor +{ + GstBaseTransform element; + + /*< private >*/ + /* caps */ + gint in_width, in_height; + gboolean in_rgba; + gint out_width, out_height; +}; + +struct _GstAlphaColorClass +{ + GstBaseTransformClass parent_class; +}; + +GType gst_alpha_color_get_type (void); + +#endif /* _GST_ALPHA_COLOR_H_ */