Commit 2d826700 authored by Stefan Kost's avatar Stefan Kost
Browse files

Add docs for adder, use GST_ELEMENT_DETAILS macro, define GstElementDetails at the top

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:
* ext/cdparanoia/gstcdparanoiasrc.c:
* ext/gnomevfs/gstgnomevfssink.c: (gst_gnome_vfs_sink_base_init),
(gst_gnome_vfs_sink_class_init):
* ext/gnomevfs/gstgnomevfssrc.c: (gst_gnome_vfs_src_base_init):
* ext/ogg/gstoggdemux.c: (gst_ogg_demux_base_init):
* ext/ogg/gstoggmux.c:
* ext/ogg/gstoggparse.c: (gst_ogg_parse_base_init):
* ext/ogg/gstogmparse.c: (gst_ogm_audio_parse_base_init),
(gst_ogm_video_parse_base_init), (gst_ogm_text_parse_base_init):
* ext/pango/gsttextoverlay.c:
* ext/pango/gsttextrender.c:
* ext/theora/theoradec.c:
* ext/theora/theoraenc.c:
* ext/vorbis/vorbisdec.c:
* ext/vorbis/vorbisenc.c:
* gst-libs/gst/audio/gstaudiofilter.c:
(gst_audio_filter_base_init):
* gst-libs/gst/audio/gstaudiofiltertemplate.c:
(gst_audio_filter_template_base_init):
* gst/adder/gstadder.c: (gst_adder_get_type):
* gst/adder/gstadder.h:
* gst/audioconvert/gstaudioconvert.c:
* gst/audiotestsrc/gstaudiotestsrc.c:
(gst_audiostestsrc_wave_get_type), (gst_audio_test_src_class_init),
(gst_audio_test_src_create):
* gst/ffmpegcolorspace/gstffmpegcolorspace.c:
* gst/playback/gstdecodebin.c:
* gst/playback/gstplaybin.c:
* gst/playback/gststreamselector.c:
(gst_stream_selector_base_init):
* gst/subparse/gstsubparse.c: (gst_sub_parse_base_init):
* gst/volume/gstvolume.c:
* sys/v4l/gstv4lmjpegsink.c:
* sys/v4l/gstv4lmjpegsrc.c:
* tests/check/libs/cddabasesrc.c:
* tests/old/examples/gob/gst-identity2.gob:
Add docs for adder, use GST_ELEMENT_DETAILS macro,
define GstElementDetails at the top
parent 34c9c8df
2006-03-24 Stefan Kost <ensonic@users.sf.net>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-base-plugins-docs.sgml:
* docs/plugins/gst-plugins-base-plugins-sections.txt:
* ext/cdparanoia/gstcdparanoiasrc.c:
* ext/gnomevfs/gstgnomevfssink.c: (gst_gnome_vfs_sink_base_init),
(gst_gnome_vfs_sink_class_init):
* ext/gnomevfs/gstgnomevfssrc.c: (gst_gnome_vfs_src_base_init):
* ext/ogg/gstoggdemux.c: (gst_ogg_demux_base_init):
* ext/ogg/gstoggmux.c:
* ext/ogg/gstoggparse.c: (gst_ogg_parse_base_init):
* ext/ogg/gstogmparse.c: (gst_ogm_audio_parse_base_init),
(gst_ogm_video_parse_base_init), (gst_ogm_text_parse_base_init):
* ext/pango/gsttextoverlay.c:
* ext/pango/gsttextrender.c:
* ext/theora/theoradec.c:
* ext/theora/theoraenc.c:
* ext/vorbis/vorbisdec.c:
* ext/vorbis/vorbisenc.c:
* gst-libs/gst/audio/gstaudiofilter.c:
(gst_audio_filter_base_init):
* gst-libs/gst/audio/gstaudiofiltertemplate.c:
(gst_audio_filter_template_base_init):
* gst/adder/gstadder.c: (gst_adder_get_type):
* gst/adder/gstadder.h:
* gst/audioconvert/gstaudioconvert.c:
* gst/audiotestsrc/gstaudiotestsrc.c:
(gst_audiostestsrc_wave_get_type), (gst_audio_test_src_class_init),
(gst_audio_test_src_create):
* gst/ffmpegcolorspace/gstffmpegcolorspace.c:
* gst/playback/gstdecodebin.c:
* gst/playback/gstplaybin.c:
* gst/playback/gststreamselector.c:
(gst_stream_selector_base_init):
* gst/subparse/gstsubparse.c: (gst_sub_parse_base_init):
* gst/volume/gstvolume.c:
* sys/v4l/gstv4lmjpegsink.c:
* sys/v4l/gstv4lmjpegsrc.c:
* tests/check/libs/cddabasesrc.c:
* tests/old/examples/gob/gst-identity2.gob:
Add docs for adder, use GST_ELEMENT_DETAILS macro,
define GstElementDetails at the top
2006-03-23 Sebastien Moutte <sebastien@moutte.net>
 
* win32/common/libgstinterfaces.def:
......
......@@ -74,10 +74,10 @@ IGNORE_CFILES = utils.c mem.c imgconvert.c
# the registry won't have the element
EXTRA_HFILES = \
$(top_srcdir)/ext/cdparanoia/gstcdparanoiasrc.h \
$(top_srcdir)/ext/alsa/gstalsamixerelement.h \
$(top_srcdir)/ext/alsa/gstalsasink.h \
$(top_srcdir)/ext/alsa/gstalsasrc.h \
$(top_srcdir)/ext/cdparanoia/gstcdparanoiasrc.h \
$(top_srcdir)/ext/gnomevfs/gstgnomevfssink.h \
$(top_srcdir)/ext/gnomevfs/gstgnomevfssrc.h \
$(top_srcdir)/ext/pango/gstclockoverlay.h \
......@@ -89,6 +89,7 @@ EXTRA_HFILES = \
$(top_srcdir)/ext/vorbis/vorbisdec.h \
$(top_srcdir)/ext/vorbis/vorbisenc.h \
$(top_srcdir)/ext/vorbis/vorbisparse.h \
$(top_srcdir)/gst/adder/gstadder.h \
$(top_srcdir)/gst/audioconvert/gstaudioconvert.h \
$(top_srcdir)/gst/audioresample/gstaudioresample.h \
$(top_srcdir)/gst/audiotestsrc/gstaudiotestsrc.h \
......
......@@ -12,6 +12,7 @@
<chapter>
<title>gst-plugins-base Elements</title>
<xi:include href="xml/element-adder.xml" />
<xi:include href="xml/element-alsamixer.xml" />
<xi:include href="xml/element-alsasink.xml" />
<xi:include href="xml/element-alsasrc.xml" />
......
<SECTION>
<FILE>element-adder</FILE>
<TITLE>adder</TITLE>
GstAdder
<SUBSECTION Standard>
GST_ADDER
GST_IS_ADDER
GST_TYPE_ADDER
gst_adder_factory_init
gst_adder_get_type
GST_ADDER_CLASS
GST_IS_ADDER_CLASS
GstAdderClass
GstAdderFormat
</SECTION>
<SECTION>
<FILE>element-alsamixer</FILE>
GstAlsaMixerElement
......
......@@ -2,7 +2,7 @@
/* GStreamer
* Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
* <2005> Wim Taymans <wim@fluendo.com>
* <2005> Tim-Philipp Müller <tim centricular net>
* <2005> Tim-Philipp M??ller <tim centricular net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
......@@ -68,12 +68,11 @@ static gboolean gst_cd_paranoia_src_open (GstCddaBaseSrc * src,
const gchar * device);
static void gst_cd_paranoia_src_close (GstCddaBaseSrc * src);
static GstElementDetails cdparanoia_details = {
"CD Audio (cdda) Source, Paranoia IV",
"Source/File",
"Read audio from CD in paranoid mode",
"Erik Walthinsen <omega@cse.ogi.edu>, " "Wim Taymans <wim@fluendo.com>"
};
static GstElementDetails cdparanoia_details =
GST_ELEMENT_DETAILS ("CD Audio (cdda) Source, Paranoia IV",
"Source/File",
"Read audio from CD in paranoid mode",
"Erik Walthinsen <omega@cse.ogi.edu>, " "Wim Taymans <wim@fluendo.com>");
/* We use these to serialize calls to paranoia_read() among several
* cdparanoiasrc instances. We do this because it's the only reasonably
......
......@@ -3,7 +3,7 @@
* 2000 Wim Taymans <wtay@chello.be>
* 2001 Bastien Nocera <hadess@hadess.net>
* 2003 Colin Walters <walters@verbum.org>
* 2005 Tim-Philipp Müller <tim centricular net>
* 2005 Tim-Philipp M??ller <tim centricular net>
*
* gstgnomevfssink.c:
*
......@@ -73,6 +73,12 @@
#include <string.h>
#include <errno.h>
static GstElementDetails gst_gnome_vfs_sink_details =
GST_ELEMENT_DETAILS ("GnomeVFS Sink",
"Sink/File",
"Write a stream to a GnomeVFS URI",
"Bastien Nocera <hadess@hadess.net>");
enum
{
SIGNAL_ERASE_ASK,
......@@ -139,11 +145,6 @@ static void
gst_gnome_vfs_sink_base_init (gpointer g_class)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
static GstElementDetails gst_gnome_vfs_sink_details =
GST_ELEMENT_DETAILS ("GnomeVFS Sink",
"Sink/File",
"Write a stream to a GnomeVFS URI",
"Bastien Nocera <hadess@hadess.net>");
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&sinktemplate));
......
......@@ -96,6 +96,12 @@
GST_DEBUG_CATEGORY_STATIC (gnomevfssrc_debug);
#define GST_CAT_DEFAULT gnomevfssrc_debug
static GstElementDetails gst_gnome_vfs_src_details =
GST_ELEMENT_DETAILS ("GnomeVFS Source",
"Source/File",
"Read from any GnomeVFS-supported file",
"Bastien Nocera <hadess@hadess.net>\n"
"Ronald S. Bultje <rbultje@ronald.bitfreak.net>");
static GStaticMutex count_lock = G_STATIC_MUTEX_INIT;
static gint ref_count = 0;
......@@ -183,12 +189,6 @@ static void
gst_gnome_vfs_src_base_init (gpointer g_class)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
static GstElementDetails gst_gnome_vfs_src_details =
GST_ELEMENT_DETAILS ("GnomeVFS Source",
"Source/File",
"Read from any GnomeVFS-supported file",
"Bastien Nocera <hadess@hadess.net>\n"
"Ronald S. Bultje <rbultje@ronald.bitfreak.net>");
gst_element_class_add_pad_template (element_class,
gst_static_pad_template_get (&srctemplate));
......
......@@ -27,6 +27,12 @@
#include <string.h>
#include <gst/gst-i18n-plugin.h>
static GstElementDetails gst_ogg_demux_details =
GST_ELEMENT_DETAILS ("ogg demuxer",
"Codec/Demuxer",
"demux ogg streams (info about ogg: http://xiph.org)",
"Wim Taymand <wim@fluendo.com>");
#define CHUNKSIZE (8500) /* this is out of vorbisfile */
#define SKELETON_FISHEAD_SIZE 64
#define SKELETON_FISBONE_MIN_SIZE 52
......@@ -1277,11 +1283,6 @@ static void
gst_ogg_demux_base_init (gpointer g_class)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
static GstElementDetails gst_ogg_demux_details =
GST_ELEMENT_DETAILS ("ogg demuxer",
"Codec/Demuxer",
"demux ogg streams (info about ogg: http://xiph.org)",
"Wim Taymand <wim@fluendo.com>");
gst_element_class_set_details (element_class, &gst_ogg_demux_details);
......
......@@ -36,6 +36,12 @@
#include <ogg/ogg.h>
#include <string.h>
static GstElementDetails gst_ogg_parse_details =
GST_ELEMENT_DETAILS ("ogg parser",
"Codec/Parser",
"parse ogg streams into pages (info about ogg: http://xiph.org)",
"Michael Smith <msmith@fluendo.com>");
GST_DEBUG_CATEGORY_STATIC (gst_ogg_parse_debug);
#define GST_CAT_DEFAULT gst_ogg_parse_debug
......@@ -211,11 +217,6 @@ static void
gst_ogg_parse_base_init (gpointer g_class)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
static GstElementDetails gst_ogg_parse_details =
GST_ELEMENT_DETAILS ("ogg parser",
"Codec/Parser",
"parse ogg streams into pages (info about ogg: http://xiph.org)",
"Michael Smith <msmith@fluendo.com>");
gst_element_class_set_details (element_class, &gst_ogg_parse_details);
......
......@@ -55,6 +55,24 @@ GST_DEBUG_CATEGORY_STATIC (gst_ogm_parse_debug);
#define GST_OGM_PARSE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_OGM_PARSE, GstOgmParseClass))
static GstElementDetails gst_ogm_audio_parse_details =
GST_ELEMENT_DETAILS ("OGM audio stream parser",
"Codec/Decoder/Audio",
"parse an OGM audio header and stream",
"Ronald Bultje <rbultje@ronald.bitfreak.net>");
static GstElementDetails gst_ogm_video_parse_details =
GST_ELEMENT_DETAILS ("OGM video stream parser",
"Codec/Decoder/Video",
"parse an OGM video header and stream",
"Ronald Bultje <rbultje@ronald.bitfreak.net>");
static GstElementDetails gst_ogm_text_parse_details =
GST_ELEMENT_DETAILS ("OGM text stream parser",
"Codec/Decoder/Subtitle",
"parse an OGM text header and stream",
"Ronald Bultje <rbultje@ronald.bitfreak.net>");
typedef struct _stream_header_video
{
gint32 width;
......@@ -260,11 +278,6 @@ static void
gst_ogm_audio_parse_base_init (GstOgmParseClass * klass)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
static GstElementDetails gst_ogm_audio_parse_details =
GST_ELEMENT_DETAILS ("OGM audio stream parser",
"Codec/Decoder/Audio",
"parse an OGM audio header and stream",
"Ronald Bultje <rbultje@ronald.bitfreak.net>");
GstCaps *caps = gst_riff_create_audio_template_caps ();
gst_element_class_set_details (element_class, &gst_ogm_audio_parse_details);
......@@ -280,11 +293,6 @@ static void
gst_ogm_video_parse_base_init (GstOgmParseClass * klass)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
static GstElementDetails gst_ogm_video_parse_details =
GST_ELEMENT_DETAILS ("OGM video stream parser",
"Codec/Decoder/Video",
"parse an OGM video header and stream",
"Ronald Bultje <rbultje@ronald.bitfreak.net>");
GstCaps *caps = gst_riff_create_video_template_caps ();
gst_element_class_set_details (element_class, &gst_ogm_video_parse_details);
......@@ -300,11 +308,6 @@ static void
gst_ogm_text_parse_base_init (GstOgmParseClass * klass)
{
GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
static GstElementDetails gst_ogm_text_parse_details =
GST_ELEMENT_DETAILS ("OGM text stream parser",
"Codec/Decoder/Subtitle",
"parse an OGM text header and stream",
"Ronald Bultje <rbultje@ronald.bitfreak.net>");
GstCaps *caps = gst_caps_new_simple ("text/plain", NULL, NULL);
gst_element_class_set_details (element_class, &gst_ogm_text_parse_details);
......
......@@ -53,18 +53,18 @@
* If you do not have such a subtitle file, create one looking like this
* in a text editor:
* <programlisting>
* 1
* 00:00:03,000 --> 00:00:05,000
* Hello? (3-5s)
*
* 2
* 00:00:08,000 --> 00:00:13,000
* 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&apos;t
* you like it? (8-13s)
*
* 3
* 00:00:18,826 --> 00:01:02,886
* Uh? What are you talking about?
* you like it? (8-13s)
*
* 3
* 00:00:18,826 --> 00:01:02,886
* Uh? What are you talking about?
* I don&apos;t understand (18-62s)
* </programlisting>
* </para>
......@@ -93,12 +93,11 @@
GST_DEBUG_CATEGORY (pango_debug);
#define GST_CAT_DEFAULT pango_debug
static GstElementDetails text_overlay_details = {
"Text Overlay",
"Filter/Editor/Video",
"Adds text strings on top of a video buffer",
"David Schleef <ds@schleef.org>"
};
static GstElementDetails text_overlay_details =
GST_ELEMENT_DETAILS ("Text Overlay",
"Filter/Editor/Video",
"Adds text strings on top of a video buffer",
"David Schleef <ds@schleef.org>");
#define DEFAULT_PROP_TEXT ""
......
......@@ -54,13 +54,12 @@
GST_DEBUG_CATEGORY_EXTERN (pango_debug);
#define GST_CAT_DEFAULT pango_debug
static GstElementDetails text_render_details = {
"Text Render",
"Filter/Editor/Video",
"Renders a text string to an image bitmap",
"David Schleef <ds@schleef.org>, "
"Ronald S. Bultje <rbultje@ronald.bitfreak.net>"
};
static GstElementDetails text_render_details =
GST_ELEMENT_DETAILS ("Text Render",
"Filter/Editor/Video",
"Renders a text string to an image bitmap",
"David Schleef <ds@schleef.org>, "
"Ronald S. Bultje <rbultje@ronald.bitfreak.net>");
enum
{
......
......@@ -58,13 +58,11 @@ enum
ARG_CROP
};
static GstElementDetails theora_dec_details = {
"TheoraDec",
"Codec/Decoder/Video",
"decode raw theora streams to raw YUV video",
"Benjamin Otte <in7y118@public.uni-hamburg.de>, "
"Wim Taymans <wim@fluendo.com>",
};
static GstElementDetails theora_dec_details = GST_ELEMENT_DETAILS ("TheoraDec",
"Codec/Decoder/Video",
"decode raw theora streams to raw YUV video",
"Benjamin Otte <in7y118@public.uni-hamburg.de>, "
"Wim Taymans <wim@fluendo.com>");
static GstStaticPadTemplate theora_dec_src_factory =
GST_STATIC_PAD_TEMPLATE ("src",
......
......@@ -149,12 +149,10 @@ granulepos_to_timestamp (GstTheoraEnc * theoraenc, ogg_int64_t granulepos)
theoraenc->info.fps_numerator);
}
static GstElementDetails theora_enc_details = {
"TheoraEnc",
"Codec/Encoder/Video",
"encode raw YUV video to a theora stream",
"Wim Taymans <wim@fluendo.com>",
};
static GstElementDetails theora_enc_details = GST_ELEMENT_DETAILS ("TheoraEnc",
"Codec/Encoder/Video",
"encode raw YUV video to a theora stream",
"Wim Taymans <wim@fluendo.com>");
static GstStaticPadTemplate theora_enc_sink_factory =
GST_STATIC_PAD_TEMPLATE ("sink",
......
......@@ -54,12 +54,10 @@
GST_DEBUG_CATEGORY_EXTERN (vorbisdec_debug);
#define GST_CAT_DEFAULT vorbisdec_debug
static GstElementDetails vorbis_dec_details = {
"VorbisDec",
"Codec/Decoder/Audio",
"decode raw vorbis streams to float audio",
"Benjamin Otte <in7y118@public.uni-hamburg.de>",
};
static GstElementDetails vorbis_dec_details = GST_ELEMENT_DETAILS ("VorbisDec",
"Codec/Decoder/Audio",
"decode raw vorbis streams to float audio",
"Benjamin Otte <in7y118@public.uni-hamburg.de>");
/* Filter signals and args */
enum
......
......@@ -66,12 +66,10 @@ GST_DEBUG_CATEGORY_EXTERN (vorbisenc_debug);
static GstPadTemplate *gst_vorbisenc_src_template, *gst_vorbisenc_sink_template;
/* elementfactory information */
GstElementDetails vorbisenc_details = {
"Vorbis encoder",
"Codec/Encoder/Audio",
"Encodes audio in Vorbis format",
"Monty <monty@xiph.org>, " "Wim Taymans <wim@fluendo.com>",
};
GstElementDetails vorbisenc_details = GST_ELEMENT_DETAILS ("Vorbis encoder",
"Codec/Encoder/Audio",
"Encodes audio in Vorbis format",
"Monty <monty@xiph.org>, " "Wim Taymans <wim@fluendo.com>");
/* GstVorbisEnc signals and args */
enum
......
......@@ -27,6 +27,11 @@
#include <string.h>
static GstElementDetails audio_filter_details =
GST_ELEMENT_DETAILS ("Audio filter base class",
"Filter/Effect/Audio",
"Filters audio",
"David Schleef <ds@schleef.org>");
/* GstAudioFilter signals and args */
enum
......@@ -83,12 +88,6 @@ gst_audio_filter_get_type (void)
static void
gst_audio_filter_base_init (gpointer g_class)
{
static GstElementDetails audio_filter_details = {
"Audio filter base class",
"Filter/Effect/Audio",
"Filters audio",
"David Schleef <ds@schleef.org>"
};
GstAudioFilterClass *klass = (GstAudioFilterClass *) g_class;
GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
......
......@@ -34,6 +34,12 @@
#include <gst/audio/gstaudiofilter.h>
#include <string.h>
static GstElementDetails audio_filter_template_details =
GST_ELEMENT_DETAILS ("Audio filter template",
"Filter/Effect/Audio",
"Filters audio",
"David Schleef <ds@schleef.org>");
typedef struct _GstAudioFilterTemplate GstAudioFilterTemplate;
typedef struct _GstAudioFilterTemplateClass GstAudioFilterTemplateClass;
......@@ -117,12 +123,6 @@ gst_audio_filter_template_get_type (void)
static void
gst_audio_filter_template_base_init (gpointer g_class)
{
static GstElementDetails audio_filter_template_details = {
"Audio filter template",
"Filter/Effect/Audio",
"Filters audio",
"David Schleef <ds@schleef.org>"
};
GstAudioFilterTemplateClass *klass = (GstAudioFilterTemplateClass *) g_class;
GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
......
......@@ -20,6 +20,21 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-adder
*
* <refsect2>
* The Adder allows to mix several streams into one by adding the data.
* Mixed data is clamped to the min/max values of the data format.
* <title>Example launch line</title>
* <para>
* <programlisting>
* gst-launch audiotestsrc freq=100 ! adder name=mix ! audioconvert ! alsasink audiotestsrc freq=500 ! mix.
* </programlisting>
* This pipeline produces two sine waves mixed together.
* </para>
* </refsect2>
*/
/* Element-Checklist-Version: 5 */
#ifdef HAVE_CONFIG_H
......@@ -90,7 +105,7 @@ gst_adder_get_type (void)
{
static GType adder_type = 0;
if (!adder_type) {
if (G_UNLIKELY (adder_type == 0)) {
static const GTypeInfo adder_info = {
sizeof (GstAdderClass), NULL, NULL,
(GClassInitFunc) gst_adder_class_init, NULL, NULL,
......
......@@ -28,8 +28,6 @@
G_BEGIN_DECLS
extern GstElementDetails gst_adder_details;
#define GST_TYPE_ADDER \
(gst_adder_get_type())
#define GST_ADDER(obj) \
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment