From b0d322c5f5206d1ab637e226a9f93cdb93b91a61 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Thu, 15 Sep 2005 14:35:04 +0000 Subject: [PATCH] only scanobj stuff from our source module. Not sure yet if that's correct, given the hierarchy stuff :) Original commit message from CVS: * common/gstdoc-scangobj: * common/gtk-doc-plugins.mak: * docs/libs/Makefile.am: * docs/plugins/gst-plugins-base-plugins.args: * docs/plugins/gst-plugins-base-plugins.hierarchy: * docs/plugins/gst-plugins-base-plugins.interfaces: * docs/plugins/gst-plugins-base-plugins.prerequisites: * docs/plugins/gst-plugins-base-plugins.signals: only scanobj stuff from our source module. Not sure yet if that's correct, given the hierarchy stuff :) --- ChangeLog | 13 + common | 2 +- docs/libs/Makefile.am | 2 +- docs/plugins/gst-plugins-base-plugins.args | 832 ++++++++---------- .../gst-plugins-base-plugins.hierarchy | 98 +-- .../gst-plugins-base-plugins.interfaces | 16 +- .../gst-plugins-base-plugins.prerequisites | 6 +- docs/plugins/gst-plugins-base-plugins.signals | 32 - 8 files changed, 421 insertions(+), 580 deletions(-) diff --git a/ChangeLog b/ChangeLog index 5674088137..25ade21a84 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2005-09-15 Thomas Vander Stichele + + * common/gstdoc-scangobj: + * common/gtk-doc-plugins.mak: + * docs/libs/Makefile.am: + * docs/plugins/gst-plugins-base-plugins.args: + * docs/plugins/gst-plugins-base-plugins.hierarchy: + * docs/plugins/gst-plugins-base-plugins.interfaces: + * docs/plugins/gst-plugins-base-plugins.prerequisites: + * docs/plugins/gst-plugins-base-plugins.signals: + only scanobj stuff from our source module. Not sure yet + if that's correct, given the hierarchy stuff :) + 2005-09-15 Wim Taymans * gst/audioconvert/gstaudioconvert.c: diff --git a/common b/common index 9a5025a2d2..161ba917f6 160000 --- a/common +++ b/common @@ -1 +1 @@ -Subproject commit 9a5025a2d276796d8d21243ef598e679ff7477bc +Subproject commit 161ba917f65c0961ef173061bf44d4e746feaba3 diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index c830c2fb70..041d812e2d 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -79,7 +79,7 @@ extra_files = # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib # contains GtkObjects/GObjects and you want to document signals and properties. -GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs +GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_srcdir)/gst-libs -I$(top_builddir)/gst-libs GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS) GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) diff --git a/docs/plugins/gst-plugins-base-plugins.args b/docs/plugins/gst-plugins-base-plugins.args index 0ca4e1ca62..bc43d8bfdb 100644 --- a/docs/plugins/gst-plugins-base-plugins.args +++ b/docs/plugins/gst-plugins-base-plugins.args @@ -1,363 +1,3 @@ - -GstVorbisEnc::bitrate -gint -[-1,250001] -rw -Target Bitrate -Attempt to encode at a bitrate averaging this (in bps). This uses the bitrate management engine, and is not recommended for most users. Quality is a better alternative. (-1 == disabled). --1 - - - -GstVorbisEnc::last-message -gchararray - -r -last-message -The last status message. -NULL - - - -GstVorbisEnc::managed -gboolean - -rw -Managed -Enable bitrate management engine. -FALSE - - - -GstVorbisEnc::max-bitrate -gint -[-1,250001] -rw -Maximum Bitrate -Specify a maximum bitrate (in bps). Useful for streaming applications. (-1 == disabled). --1 - - - -GstVorbisEnc::min-bitrate -gint -[-1,250001] -rw -Minimum Bitrate -Specify a minimum bitrate (in bps). Useful for encoding for a fixed-size channel. (-1 == disabled). --1 - - - -GstVorbisEnc::quality -gfloat -[-0.1,1] -rw -Quality -Specify quality instead of specifying a particular bitrate. -0.3 - - - -GstTheoraDec::crop -gboolean - -rw -Crop -Crop the image to the visible region. -TRUE - - - -GstTheoraEnc::bitrate -gint -[0,2000] -rw -Bitrate -Compressed video bitrate (kbps). -0 - - - -GstTheoraEnc::border -GstTheoraEncBorderMode - -rw -Border -Border color to add when sizes not multiple of 16. -BORDER_BLACK - - - -GstTheoraEnc::center -gboolean - -rw -Center -Center image when sizes not multiple of 16. -TRUE - - - -GstTheoraEnc::keyframe-auto -gboolean - -rw -Keyframe Auto -Automatic keyframe detection. -TRUE - - - -GstTheoraEnc::keyframe-force -gint -[1,32768] -rw -Keyframe force -Force keyframe every N frames. -64 - - - -GstTheoraEnc::keyframe-freq -gint -[1,32768] -rw -Keyframe frequency -Keyframe frequency. -64 - - - -GstTheoraEnc::keyframe-mindistance -gint -[1,32768] -rw -Keyframe mindistance -Keyframe mindistance. -8 - - - -GstTheoraEnc::keyframe-threshold -gint -[0,32768] -rw -Keyframe threshold -Keyframe threshold. -80 - - - -GstTheoraEnc::noise-sensitivity -gint -[0,32768] -rw -Noise sensitivity -Noise sensitivity. -1 - - - -GstTheoraEnc::quality -gint -[0,63] -rw -Quality -Video quality. -16 - - - -GstTheoraEnc::quick -gboolean - -rw -Quick -Quick encoding. -TRUE - - - -GstTheoraEnc::sharpness -gint -[0,2] -rw -Sharpness -Sharpness. -0 - - - -GstOggMux::max-delay -guint64 - -rw -Max delay -Maximum delay in multiplexing streams. -500000000 - - - -GstOggMux::max-page-delay -guint64 - -rw -Max page delay -Maximum delay for sending out a page. -500000000 - - - -GstGnomeVFSSrc::handle -gpointer - -rw -GnomeVFSHandle -Handle for GnomeVFS. - - - - -GstGnomeVFSSrc::iradio-genre -gchararray - -r -iradio-genre -Genre of the stream. -NULL - - - -GstGnomeVFSSrc::iradio-mode -gboolean - -rw -iradio-mode -Enable internet radio mode (extraction of icecast/audiocast metadata). -FALSE - - - -GstGnomeVFSSrc::iradio-name -gchararray - -r -iradio-name -Name of the stream. -NULL - - - -GstGnomeVFSSrc::iradio-title -gchararray - -r -iradio-title -Name of currently playing song. -NULL - - - -GstGnomeVFSSrc::iradio-url -gchararray - -r -iradio-url -Homepage URL for radio stream. -NULL - - - -GstGnomeVFSSrc::location -gchararray - -rw -File Location -Location of the file to read. -NULL - - - -GstAlsaSrc::device -gchararray - -rw -Device -ALSA device, as defined in an asound configuration file. -"default" - - - -GstAlsaSrc::device-name -gchararray - -r -Device name -Human-readable name of the sound device. -"" - - - -GstAlsaSink::device -gchararray - -rw -Device -ALSA device, as defined in an asound configuration file. -"default" - - - -GstAlsaSink::device-name -gchararray - -r -Device name -Human-readable name of the sound device. -"" - - - -GstV4lSrc::autoprobe -gboolean - -rw -Autoprobe -Whether the device should be probed for all possible features. -TRUE - - - -GstV4lSrc::autoprobe-fps -gboolean - -rw -Autoprobe FPS -Whether the device should be probed for framerates. -TRUE - - - -GstV4lSrc::copy-mode -gboolean - -rw -Copy mode -Whether to send out copies of buffers, or direct pointers to the mmap region. -TRUE - - - -GstV4lSrc::timestamp-offset -gint64 - -rw -Timestamp offset -A time offset subtracted from timestamps set on buffers (in ns). -0 - - GstXvImageSink::brightness gint @@ -458,6 +98,56 @@ FALSE + +GstV4lSrc::autoprobe +gboolean + +rw +Autoprobe +Whether the device should be probed for all possible features. +TRUE + + + +GstV4lSrc::autoprobe-fps +gboolean + +rw +Autoprobe FPS +Whether the device should be probed for framerates. +TRUE + + + +GstV4lSrc::copy-mode +gboolean + +rw +Copy mode +Whether to send out copies of buffers, or direct pointers to the mmap region. +TRUE + + + +GstV4lSrc::timestamp-offset +gint64 + +rw +Timestamp offset +A time offset subtracted from timestamps set on buffers (in ns). +0 + + + +GstAudioresample::filter-length +gint +>= 0 +rwx +filter_length +filter_length. +16 + + GstVolume::mute gboolean @@ -478,6 +168,26 @@ 1 + +GstVideoTestSrc::pattern +GstVideoTestSrcPattern + +rw +Pattern +Type of test pattern to generate. +snow + + + +GstVideoTestSrc::timestamp-offset +gint64 + +rw +Timestamp offset +An offset added to timestamps set on buffers (in ns). +0 + + GstVideoscale::method GstVideoscaleMethod @@ -548,26 +258,6 @@ TRUE - -GstVideoTestSrc::pattern -GstVideoTestSrcPattern - -rw -Pattern -Type of test pattern to generate. -snow - - - -GstVideoTestSrc::timestamp-offset -gint64 - -rw -Timestamp offset -An offset added to timestamps set on buffers (in ns). -0 - - GstTCPClientSink::host gchararray @@ -918,16 +608,6 @@ 1 - -GstAudioresample::filter-length -gint ->= 0 -rwx -filter_length -filter_length. -16 - - GstAudiorate::add guint64 @@ -979,142 +659,322 @@ -GstQueue::block-timeout -guint64 - +GstVorbisEnc::bitrate +gint +[-1,250001] rw -Timeout for Block -Nanoseconds until blocked queue times out and returns filler event. Value of -1 disables timeout. -18446744073709551615 +Target Bitrate +Attempt to encode at a bitrate averaging this (in bps). This uses the bitrate management engine, and is not recommended for most users. Quality is a better alternative. (-1 == disabled). +-1 -GstQueue::current-level-buffers -guint +GstVorbisEnc::last-message +gchararray r -Current level (buffers) -Current number of buffers in the queue. -0 +last-message +The last status message. +NULL -GstQueue::current-level-bytes -guint - -r -Current level (kB) -Current amount of data in the queue (bytes). -0 - - - -GstQueue::current-level-time -guint64 - -r -Current level (ns) -Current amount of data in the queue (in ns). -0 - - - -GstQueue::leaky -GstQueueLeaky - -rw -Leaky -Where the queue leaks, if at all. -0 - - - -GstQueue::max-size-buffers -guint - -rw -Max. size (buffers) -Max. number of buffers in the queue (0=disable). -0 - - - -GstQueue::max-size-bytes -guint - -rw -Max. size (kB) -Max. amount of data in the queue (bytes, 0=disable). -0 - - - -GstQueue::max-size-time -guint64 - -rw -Max. size (ns) -Max. amount of data in the queue (in ns, 0=disable). -0 - - - -GstQueue::may-deadlock +GstVorbisEnc::managed gboolean rw -May Deadlock -The queue may deadlock if it's full and not PLAYING. +Managed +Enable bitrate management engine. +FALSE + + + +GstVorbisEnc::max-bitrate +gint +[-1,250001] +rw +Maximum Bitrate +Specify a maximum bitrate (in bps). Useful for streaming applications. (-1 == disabled). +-1 + + + +GstVorbisEnc::min-bitrate +gint +[-1,250001] +rw +Minimum Bitrate +Specify a minimum bitrate (in bps). Useful for encoding for a fixed-size channel. (-1 == disabled). +-1 + + + +GstVorbisEnc::quality +gfloat +[-0.1,1] +rw +Quality +Specify quality instead of specifying a particular bitrate. +0.3 + + + +GstTheoraDec::crop +gboolean + +rw +Crop +Crop the image to the visible region. TRUE -GstQueue::min-threshold-buffers -guint - +GstTheoraEnc::bitrate +gint +[0,2000] rw -Min. threshold (buffers) -Min. number of buffers in the queue to allow reading (0=disable). +Bitrate +Compressed video bitrate (kbps). 0 -GstQueue::min-threshold-bytes -guint +GstTheoraEnc::border +GstTheoraEncBorderMode rw -Min. threshold (kB) -Min. amount of data in the queue to allow reading (bytes, 0=disable). +Border +Border color to add when sizes not multiple of 16. +BORDER_BLACK + + + +GstTheoraEnc::center +gboolean + +rw +Center +Center image when sizes not multiple of 16. +TRUE + + + +GstTheoraEnc::keyframe-auto +gboolean + +rw +Keyframe Auto +Automatic keyframe detection. +TRUE + + + +GstTheoraEnc::keyframe-force +gint +[1,32768] +rw +Keyframe force +Force keyframe every N frames. +64 + + + +GstTheoraEnc::keyframe-freq +gint +[1,32768] +rw +Keyframe frequency +Keyframe frequency. +64 + + + +GstTheoraEnc::keyframe-mindistance +gint +[1,32768] +rw +Keyframe mindistance +Keyframe mindistance. +8 + + + +GstTheoraEnc::keyframe-threshold +gint +[0,32768] +rw +Keyframe threshold +Keyframe threshold. +80 + + + +GstTheoraEnc::noise-sensitivity +gint +[0,32768] +rw +Noise sensitivity +Noise sensitivity. +1 + + + +GstTheoraEnc::quality +gint +[0,63] +rw +Quality +Video quality. +16 + + + +GstTheoraEnc::quick +gboolean + +rw +Quick +Quick encoding. +TRUE + + + +GstTheoraEnc::sharpness +gint +[0,2] +rw +Sharpness +Sharpness. 0 -GstQueue::min-threshold-time +GstGnomeVFSSrc::handle +gpointer + +rw +GnomeVFSHandle +Handle for GnomeVFS. + + + + +GstGnomeVFSSrc::iradio-genre +gchararray + +r +iradio-genre +Genre of the stream. +NULL + + + +GstGnomeVFSSrc::iradio-mode +gboolean + +rw +iradio-mode +Enable internet radio mode (extraction of icecast/audiocast metadata). +FALSE + + + +GstGnomeVFSSrc::iradio-name +gchararray + +r +iradio-name +Name of the stream. +NULL + + + +GstGnomeVFSSrc::iradio-title +gchararray + +r +iradio-title +Name of currently playing song. +NULL + + + +GstGnomeVFSSrc::iradio-url +gchararray + +r +iradio-url +Homepage URL for radio stream. +NULL + + + +GstGnomeVFSSrc::location +gchararray + +rw +File Location +Location of the file to read. +NULL + + + +GstOggMux::max-delay guint64 rw -Min. threshold (ns) -Min. amount of data in the queue to allow reading (in ns, 0=disable). -0 +Max delay +Maximum delay in multiplexing streams. +500000000 -GstPipeline::delay +GstOggMux::max-page-delay guint64 rw -Delay -Expected delay needed for elements to spin up to PLAYING in nanoseconds. -0 +Max page delay +Maximum delay for sending out a page. +500000000 -GstPipeline::play-timeout -guint64 +GstAlsaSrc::device +gchararray rw -Play Timeout -Max timeout for going to PLAYING in nanoseconds. -2000000000 +Device +ALSA device, as defined in an asound configuration file. +"default" + + + +GstAlsaSrc::device-name +gchararray + +r +Device name +Human-readable name of the sound device. +"" + + + +GstAlsaSink::device +gchararray + +rw +Device +ALSA device, as defined in an asound configuration file. +"default" + + + +GstAlsaSink::device-name +gchararray + +r +Device name +Human-readable name of the sound device. +"" diff --git a/docs/plugins/gst-plugins-base-plugins.hierarchy b/docs/plugins/gst-plugins-base-plugins.hierarchy index ff0d3ff96f..34b88e4e7e 100644 --- a/docs/plugins/gst-plugins-base-plugins.hierarchy +++ b/docs/plugins/gst-plugins-base-plugins.hierarchy @@ -10,19 +10,45 @@ GObject GstPlayBin GstDecodeBin GstQueue + GstBaseSink + GstVideoSink + GstXvImageSink + GstXImageSink + GstMultiFdSink + GstTCPServerSink + GstBaseAudioSink + GstAudioSink + GstAlsaSink + GstBaseSrc + GstPushSrc + GstV4lElement + GstV4lSrc + GstVideoTestSrc + GstTCPClientSrc + GstTCPServerSrc + GstBaseAudioSrc + GstAudioSrc + GstAlsaSrc + GstSineSrc + GstGnomeVFSSrc GstVorbisTag + GstBaseTransform + GstAudioresample + GstVolume + GstVideoscale + GstFFMpegColorspace + GstAudioConvert + GstVideorate + GstTCPClientSink + GstSubparse + GstAudiorate + GstBufferFramesConvert + GstAdder GstVorbisEnc GstVorbisDec GstVorbisParse GstTheoraDec GstTheoraEnc - GstOggDemux - GstOggMux - GstOgmParse - GstOgmAudioParse - GstOgmVideoParse - GstOgmTextParse - GstOggParse GstVisual GstVisualbumpscope GstVisualcorona @@ -33,46 +59,25 @@ GObject GstVisuallv_scope GstVisualoinksie GstVisualplazma - GstBaseSrc - GstGnomeVFSSrc - GstPushSrc - GstBaseAudioSrc - GstAudioSrc - GstAlsaSrc - GstV4lElement - GstV4lSrc - GstVideoTestSrc - GstTCPClientSrc - GstTCPServerSrc - GstSineSrc + GstOggDemux + GstOggMux + GstOgmParse + GstOgmAudioParse + GstOgmVideoParse + GstOgmTextParse + GstOggParse GstAlsaMixerElement - GstBaseSink - GstBaseAudioSink - GstAudioSink - GstAlsaSink - GstVideoSink - GstXvImageSink - GstXImageSink - GstMultiFdSink - GstTCPServerSink - GstBaseTransform - GstVolume - GstVideoscale - GstFFMpegColorspace - GstAudioresample - GstAudioConvert - GstVideorate - GstTCPClientSink - GstSubparse - GstAudiorate - GstBufferFramesConvert - GstAdder GstPadTemplate GstPluginFeature GstElementFactory GstTypeFindFactory GstIndexFactory GstSignalObject + GstColorBalanceChannel + GstTunerNorm + GstTunerChannel + GstMixerTrack + GstMixerOptions BonoboObject BonoboMonikerContext BonoboForeignObject @@ -83,19 +88,14 @@ GObject LinkServer GIOPServer GConfClient - GstMixerTrack - GstMixerOptions - GstTunerNorm - GstTunerChannel - GstColorBalanceChannel GInterface GstChildProxy GstURIHandler - GstTagSetter GstImplementsInterface - GstMixer - GstTuner + GstNavigation GstXOverlay GstColorBalance + GstTuner GstPropertyProbe - GstNavigation + GstTagSetter + GstMixer diff --git a/docs/plugins/gst-plugins-base-plugins.interfaces b/docs/plugins/gst-plugins-base-plugins.interfaces index c61ae5cfd9..4482c863cd 100644 --- a/docs/plugins/gst-plugins-base-plugins.interfaces +++ b/docs/plugins/gst-plugins-base-plugins.interfaces @@ -3,13 +3,13 @@ GstPipeline GstChildProxy GstPlayBaseBin GstChildProxy GstPlayBin GstChildProxy GstDecodeBin GstChildProxy -GstVorbisTag GstTagSetter -GstVorbisEnc GstTagSetter -GstGnomeVFSSrc GstURIHandler +GstXvImageSink GstColorBalance GstImplementsInterface GstNavigation GstXOverlay +GstXImageSink GstImplementsInterface GstNavigation GstXOverlay +GstV4lElement GstColorBalance GstImplementsInterface GstXOverlay GstTuner GstPropertyProbe +GstV4lSrc GstColorBalance GstImplementsInterface GstXOverlay GstTuner GstPropertyProbe GstAlsaSrc GstImplementsInterface GstMixer -GstV4lElement GstImplementsInterface GstTuner GstXOverlay GstColorBalance GstPropertyProbe -GstV4lSrc GstImplementsInterface GstTuner GstXOverlay GstColorBalance GstPropertyProbe -GstAlsaMixerElement GstImplementsInterface GstMixer -GstXvImageSink GstImplementsInterface GstXOverlay GstColorBalance GstNavigation -GstXImageSink GstImplementsInterface GstXOverlay GstNavigation +GstGnomeVFSSrc GstURIHandler +GstVorbisTag GstTagSetter GstVolume GstImplementsInterface GstMixer +GstVorbisEnc GstTagSetter +GstAlsaMixerElement GstImplementsInterface GstMixer diff --git a/docs/plugins/gst-plugins-base-plugins.prerequisites b/docs/plugins/gst-plugins-base-plugins.prerequisites index 6c9f71a99d..59103b1072 100644 --- a/docs/plugins/gst-plugins-base-plugins.prerequisites +++ b/docs/plugins/gst-plugins-base-plugins.prerequisites @@ -1,7 +1,7 @@ GstChildProxy GstObject -GstTagSetter GstElement GstImplementsInterface GstElement -GstMixer GstImplementsInterface GstElement -GstTuner GstImplementsInterface GstElement GstXOverlay GstImplementsInterface GstElement GstColorBalance GstImplementsInterface GstElement +GstTuner GstImplementsInterface GstElement +GstTagSetter GstElement +GstMixer GstImplementsInterface GstElement diff --git a/docs/plugins/gst-plugins-base-plugins.signals b/docs/plugins/gst-plugins-base-plugins.signals index 65c0d306fc..4b4e0eeefc 100644 --- a/docs/plugins/gst-plugins-base-plugins.signals +++ b/docs/plugins/gst-plugins-base-plugins.signals @@ -63,35 +63,3 @@ GstPad *arg1 GstCaps *arg2 - -GstQueue::overrun -void -GstQueue *gstqueue - - - -GstQueue::running -void -GstQueue *gstqueue - - - -GstQueue::underrun -void -GstQueue *gstqueue - - - -GstBin::element-added -void -GstBin *gstbin -GstElement *arg1 - - - -GstBin::element-removed -void -GstBin *gstbin -GstElement *arg1 - -