From a99d3f8769ed3fd1266d5216ecefebfd1bdcf663 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 28 Jan 2009 12:29:42 +0200 Subject: [PATCH] Update and add documentation for plugins with no deps (gst). Link to properties. Correct titles for examples. Document a few trivial cases. Keep lists in section file and docs/plugins/Makefile.am alphabetically ordered. --- docs/plugins/Makefile.am | 18 +- .../gst-plugins-good-plugins-docs.sgml | 10 + .../gst-plugins-good-plugins-sections.txt | 256 ++++++++++++++---- docs/plugins/gst-plugins-good-plugins.args | 34 +-- .../gst-plugins-good-plugins.hierarchy | 121 ++++----- .../gst-plugins-good-plugins.interfaces | 24 +- docs/plugins/inspect/plugin-aasink.xml | 2 +- docs/plugins/inspect/plugin-alaw.xml | 2 +- docs/plugins/inspect/plugin-alpha.xml | 2 +- docs/plugins/inspect/plugin-alphacolor.xml | 2 +- docs/plugins/inspect/plugin-annodex.xml | 2 +- docs/plugins/inspect/plugin-apetag.xml | 2 +- docs/plugins/inspect/plugin-audiofx.xml | 2 +- docs/plugins/inspect/plugin-auparse.xml | 2 +- docs/plugins/inspect/plugin-autodetect.xml | 2 +- docs/plugins/inspect/plugin-avi.xml | 2 +- docs/plugins/inspect/plugin-cacasink.xml | 2 +- docs/plugins/inspect/plugin-cairo.xml | 2 +- docs/plugins/inspect/plugin-cutter.xml | 2 +- docs/plugins/inspect/plugin-debug.xml | 2 +- docs/plugins/inspect/plugin-dv.xml | 2 +- docs/plugins/inspect/plugin-efence.xml | 2 +- docs/plugins/inspect/plugin-effectv.xml | 2 +- docs/plugins/inspect/plugin-equalizer.xml | 2 +- docs/plugins/inspect/plugin-esdsink.xml | 2 +- docs/plugins/inspect/plugin-flac.xml | 2 +- docs/plugins/inspect/plugin-flxdec.xml | 2 +- docs/plugins/inspect/plugin-gamma.xml | 2 +- docs/plugins/inspect/plugin-gconfelements.xml | 2 +- docs/plugins/inspect/plugin-gdkpixbuf.xml | 2 +- docs/plugins/inspect/plugin-goom.xml | 2 +- docs/plugins/inspect/plugin-goom2k1.xml | 2 +- docs/plugins/inspect/plugin-halelements.xml | 2 +- docs/plugins/inspect/plugin-icydemux.xml | 2 +- docs/plugins/inspect/plugin-id3demux.xml | 2 +- docs/plugins/inspect/plugin-interleave.xml | 2 +- docs/plugins/inspect/plugin-jpeg.xml | 2 +- docs/plugins/inspect/plugin-level.xml | 2 +- docs/plugins/inspect/plugin-matroska.xml | 2 +- docs/plugins/inspect/plugin-monoscope.xml | 4 +- docs/plugins/inspect/plugin-mulaw.xml | 2 +- docs/plugins/inspect/plugin-multifile.xml | 2 +- docs/plugins/inspect/plugin-multipart.xml | 2 +- .../plugins/inspect/plugin-navigationtest.xml | 2 +- docs/plugins/inspect/plugin-ossaudio.xml | 2 +- docs/plugins/inspect/plugin-png.xml | 2 +- docs/plugins/inspect/plugin-pulseaudio.xml | 2 +- docs/plugins/inspect/plugin-quicktime.xml | 2 +- docs/plugins/inspect/plugin-replaygain.xml | 2 +- docs/plugins/inspect/plugin-rtp.xml | 2 +- docs/plugins/inspect/plugin-rtsp.xml | 2 +- docs/plugins/inspect/plugin-smpte.xml | 2 +- docs/plugins/inspect/plugin-soup.xml | 2 +- docs/plugins/inspect/plugin-spectrum.xml | 2 +- docs/plugins/inspect/plugin-speex.xml | 2 +- docs/plugins/inspect/plugin-taglib.xml | 2 +- docs/plugins/inspect/plugin-udp.xml | 2 +- docs/plugins/inspect/plugin-video4linux2.xml | 2 +- docs/plugins/inspect/plugin-videobalance.xml | 2 +- docs/plugins/inspect/plugin-videobox.xml | 2 +- docs/plugins/inspect/plugin-videocrop.xml | 2 +- docs/plugins/inspect/plugin-videoflip.xml | 2 +- docs/plugins/inspect/plugin-videomixer.xml | 2 +- docs/plugins/inspect/plugin-wavenc.xml | 2 +- docs/plugins/inspect/plugin-wavpack.xml | 2 +- docs/plugins/inspect/plugin-wavparse.xml | 2 +- docs/plugins/inspect/plugin-ximagesrc.xml | 2 +- gst/alpha/gstalphacolor.c | 4 - gst/apetag/gstapedemux.c | 19 +- gst/audiofx/audioamplify.c | 9 +- gst/audiofx/audiochebband.c | 29 +- gst/audiofx/audiocheblimit.c | 27 +- gst/audiofx/audiodynamic.c | 10 +- gst/audiofx/audioecho.c | 16 +- gst/audiofx/audiofirfilter.c | 18 +- gst/audiofx/audioiirfilter.c | 18 +- gst/audiofx/audioinvert.c | 10 +- gst/audiofx/audiokaraoke.c | 10 +- gst/audiofx/audiopanorama.c | 10 +- gst/audiofx/audiowsincband.c | 15 +- gst/audiofx/audiowsinclimit.c | 15 +- gst/auparse/gstauparse.c | 7 +- gst/avi/gstavidemux.c | 15 +- gst/avi/gstavimux.c | 26 +- gst/cutter/gstcutter.c | 95 +++++-- gst/debug/gstpushfilesrc.c | 15 +- gst/debug/gsttaginject.c | 4 + gst/debug/progressreport.c | 39 +-- gst/equalizer/gstiirequalizer10bands.c | 13 +- gst/equalizer/gstiirequalizer3bands.c | 13 +- gst/equalizer/gstiirequalizernbands.c | 100 ++++--- gst/flx/gstflxdec.c | 3 - gst/goom/gstgoom.c | 11 +- gst/goom2k1/gstgoom.c | 11 +- gst/icydemux/gsticydemux.c | 14 +- gst/id3demux/gstid3demux.c | 31 ++- gst/law/alaw-decode.c | 5 + gst/law/alaw-encode.c | 5 + gst/law/mulaw-decode.c | 5 + gst/law/mulaw-encode.c | 5 + gst/law/mulaw.c | 18 ++ gst/level/gstlevel.c | 12 +- gst/monoscope/gstmonoscope.c | 11 +- gst/multifile/gstmultifilesink.c | 5 +- gst/multifile/gstmultifilesrc.c | 21 +- gst/multipart/multipartdemux.c | 33 +-- gst/multipart/multipartmux.c | 16 +- gst/qtdemux/qtdemux.c | 15 +- gst/rtp/gstrtpjpegpay.c | 14 +- gst/rtsp/gstrtpdec.c | 12 +- gst/rtsp/gstrtspsrc.c | 27 +- gst/smpte/gstsmpte.c | 30 +- gst/smpte/gstsmptealpha.c | 32 +-- gst/spectrum/gstspectrum.c | 24 +- gst/udp/gstmultiudpsink.c | 4 - gst/udp/gstudpsink.c | 15 +- gst/udp/gstudpsrc.c | 129 ++++----- gst/videobox/gstvideobox.c | 21 +- gst/videocrop/gstaspectratiocrop.c | 10 +- gst/videocrop/gstvideocrop.c | 26 +- gst/videofilter/gstgamma.c | 12 +- gst/videofilter/gstvideobalance.c | 13 +- gst/videofilter/gstvideoflip.c | 12 +- gst/videomixer/videomixer.c | 17 +- gst/wavenc/gstwavenc.c | 7 +- gst/wavparse/gstwavparse.c | 22 +- win32/common/config.h | 6 +- 127 files changed, 909 insertions(+), 869 deletions(-) diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am index 49b811af4d..7815a15fa3 100644 --- a/docs/plugins/Makefile.am +++ b/docs/plugins/Makefile.am @@ -103,6 +103,9 @@ EXTRA_HFILES = \ $(top_srcdir)/ext/pulse/pulsesink.h \ $(top_srcdir)/ext/pulse/pulsesrc.h \ $(top_srcdir)/ext/pulse/pulsemixer.h \ + $(top_srcdir)/ext/wavpack/gstwavpackdec.h \ + $(top_srcdir)/ext/wavpack/gstwavpackenc.h \ + $(top_srcdir)/ext/wavpack/gstwavpackparse.h \ $(top_srcdir)/gst/alpha/gstalphacolor.h \ $(top_srcdir)/gst/apetag/gstapedemux.h \ $(top_srcdir)/gst/audiofx/audioamplify.h \ @@ -124,6 +127,7 @@ EXTRA_HFILES = \ $(top_srcdir)/gst/avi/gstavidemux.h \ $(top_srcdir)/gst/avi/gstavimux.h \ $(top_srcdir)/gst/avi/gstavisubtitle.h \ + $(top_srcdir)/gst/cutter/gstcutter.h \ $(top_srcdir)/gst/debug/gsttaginject.h \ $(top_srcdir)/gst/debug/progressreport.h \ $(top_srcdir)/gst/equalizer/gstiirequalizer.h \ @@ -131,6 +135,11 @@ EXTRA_HFILES = \ $(top_srcdir)/gst/equalizer/gstiirequalizer10bands.h \ $(top_srcdir)/gst/equalizer/gstiirequalizernbands.h \ $(top_srcdir)/gst/goom/gstgoom.h \ + $(top_srcdir)/gst/goom2k1/gstgoom.h \ + $(top_srcdir)/gst/law/alaw-decode.h \ + $(top_srcdir)/gst/law/alaw-encode.h \ + $(top_srcdir)/gst/law/mulaw-decode.h \ + $(top_srcdir)/gst/law/mulaw-encode.h \ $(top_srcdir)/gst/icydemux/gsticydemux.h \ $(top_srcdir)/gst/id3demux/gstid3demux.h \ $(top_srcdir)/gst/interleave/deinterleave.h \ @@ -147,13 +156,16 @@ EXTRA_HFILES = \ $(top_srcdir)/gst/replaygain/gstrganalysis.h \ $(top_srcdir)/gst/replaygain/gstrglimiter.h \ $(top_srcdir)/gst/replaygain/gstrgvolume.h \ + $(top_srcdir)/gst/rtp/gstrtpjpegpay.h \ $(top_srcdir)/gst/rtsp/gstrtpdec.h \ $(top_srcdir)/gst/rtsp/gstrtspsrc.h \ $(top_srcdir)/gst/smpte/gstsmpte.h \ $(top_srcdir)/gst/smpte/gstsmptealpha.h \ $(top_srcdir)/gst/spectrum/gstspectrum.h \ + $(top_srcdir)/gst/udp/gstdynudpsink.h \ $(top_srcdir)/gst/udp/gstmultiudpsink.h \ $(top_srcdir)/gst/udp/gstudpsrc.h \ + $(top_srcdir)/gst/udp/gstudpsink.h \ $(top_srcdir)/gst/videocrop/gstvideocrop.h \ $(top_srcdir)/gst/videocrop/gstaspectratiocrop.h \ $(top_srcdir)/gst/videofilter/gstgamma.h \ @@ -161,10 +173,7 @@ EXTRA_HFILES = \ $(top_srcdir)/gst/videofilter/gstvideoflip.h \ $(top_srcdir)/gst/videomixer/videomixer.h \ $(top_srcdir)/gst/videomixer/videomixerpad.h \ - $(top_srcdir)/sys/waveform/gstwaveformsink.h \ - $(top_srcdir)/ext/wavpack/gstwavpackdec.h \ - $(top_srcdir)/ext/wavpack/gstwavpackenc.h \ - $(top_srcdir)/ext/wavpack/gstwavpackparse.h \ + $(top_srcdir)/gst/wavenc/gstwavenc.h \ $(top_srcdir)/gst/wavparse/gstwavparse.h \ $(top_srcdir)/sys/directdraw/gstdirectdrawsink.h \ $(top_srcdir)/sys/directsound/gstdirectsoundsink.h \ @@ -175,6 +184,7 @@ EXTRA_HFILES = \ $(top_srcdir)/sys/osxaudio/gstosxaudiosink.h \ $(top_srcdir)/sys/osxvideo/osxvideosink.h \ $(top_srcdir)/sys/v4l2/gstv4l2src.h \ + $(top_srcdir)/sys/waveform/gstwaveformsink.h \ $(top_srcdir)/sys/ximage/gstximagesrc.h diff --git a/docs/plugins/gst-plugins-good-plugins-docs.sgml b/docs/plugins/gst-plugins-good-plugins-docs.sgml index 7a81eaf209..010acb2ff9 100644 --- a/docs/plugins/gst-plugins-good-plugins-docs.sgml +++ b/docs/plugins/gst-plugins-good-plugins-docs.sgml @@ -1,6 +1,7 @@ %version-entities; ]> @@ -14,6 +15,8 @@ gst-plugins-good Elements + + @@ -40,6 +43,7 @@ + @@ -70,6 +74,8 @@ + + @@ -92,6 +98,7 @@ + @@ -101,11 +108,14 @@ + + + diff --git a/docs/plugins/gst-plugins-good-plugins-sections.txt b/docs/plugins/gst-plugins-good-plugins-sections.txt index 398effddc0..6b9e1b9a47 100644 --- a/docs/plugins/gst-plugins-good-plugins-sections.txt +++ b/docs/plugins/gst-plugins-good-plugins-sections.txt @@ -12,6 +12,33 @@ GST_IS_AASINK_CLASS gst_aasink_get_type +
+element-alawdec +alawdec +GstALawDec + +GstALawDecClass +GST_ALAW_DEC +GST_IS_ALAW_DEC +GST_TYPE_ALAW_DEC +GST_ALAW_DEC_CLASS +GST_IS_ALAW_DEC_CLASS +gst_alaw_dec_get_type +
+ +element-alawenc +alawenc +GstALawEnc + +GstALawEncClass +GST_ALAW_ENC +GST_IS_ALAW_ENC +GST_TYPE_ALAW_ENC +GST_ALAW_ENC_CLASS +GST_IS_ALAW_ENC_CLASS +gst_alaw_enc_get_type + +
element-alphacolor alphacolor @@ -103,17 +130,19 @@ gst_audio_cheb_limit_get_type
-element-audioiirfilter -audioiirfilter -GstAudioIIRFilter +element-audiodynamic +audiodynamic +GstAudioDynamic -GstAudioIIRFilterClass -GST_AUDIO_IIR_FILTER -GST_AUDIO_IIR_FILTER_CLASS -GST_IS_AUDIO_IIR_FILTER_BAND -GST_IS_AUDIO_IIR_FILTER_CLASS -GST_TYPE_AUDIO_IIR_FILTER -gst_audio_iir_filter_get_type +GstAudioDynamicClass +GstAudioDynamicProcessFunc +GST_AUDIO_DYNAMIC +GST_AUDIO_DYNAMIC_CLASS +GST_AUDIO_DYNAMIC_GET_CLASS +GST_IS_AUDIO_DYNAMIC +GST_IS_AUDIO_DYNAMIC_CLASS +GST_TYPE_AUDIO_DYNAMIC +gst_audio_dynamic_get_type
@@ -133,19 +162,31 @@ gst_audio_echo_get_type
-element-audiodynamic -audiodynamic -GstAudioDynamic +element-audiofirfilter +audiofirfilter +GstAudioFIRFilter -GstAudioDynamicClass -GstAudioDynamicProcessFunc -GST_AUDIO_DYNAMIC -GST_AUDIO_DYNAMIC_CLASS -GST_AUDIO_DYNAMIC_GET_CLASS -GST_IS_AUDIO_DYNAMIC -GST_IS_AUDIO_DYNAMIC_CLASS -GST_TYPE_AUDIO_DYNAMIC -gst_audio_dynamic_get_type +GstAudioFIRFilterClass +GST_AUDIO_FIR_FILTER +GST_AUDIO_FIR_FILTER_CLASS +GST_IS_AUDIO_FIR_FILTER +GST_IS_AUDIO_FIR_FILTER_CLASS +GST_TYPE_AUDIO_FIR_FILTER +gst_audio_fir_filter_get_type +
+ +
+element-audioiirfilter +audioiirfilter +GstAudioIIRFilter + +GstAudioIIRFilterClass +GST_AUDIO_IIR_FILTER +GST_AUDIO_IIR_FILTER_CLASS +GST_IS_AUDIO_IIR_FILTER +GST_IS_AUDIO_IIR_FILTER_CLASS +GST_TYPE_AUDIO_IIR_FILTER +gst_audio_iir_filter_get_type
@@ -226,20 +267,6 @@ GST_TYPE_AUDIO_WSINC_LIMIT gst_audio_wsinclimit_get_type
-
-element-audiofirfilter -audiofirfilter -GstAudioFIRFilter - -GstAudioFIRFilterClass -GST_AUDIO_FIR_FILTER -GST_AUDIO_FIR_FILTER_CLASS -GST_IS_AUDIO_FIR_FILTER_BAND -GST_IS_AUDIO_FIR_FILTER_CLASS -GST_TYPE_AUDIO_FIR_FILTER -gst_audio_fir_filter_get_type -
-
element-autoaudiosink autoaudiosink @@ -316,12 +343,8 @@ GST_IS_AVI_DEMUX_CLASS GST_AVI_DEMUX_MAX_STREAMS gst_avi_demux_get_type GST_AVI_INDEX_ENTRY_FLAG_KEYFRAME -GST_AVI_INDEX_OF_CHUNKS -GST_AVI_INDEX_OF_INDEXES -GST_AVI_SUPERINDEX_COUNT avi_stream_context gst_avi_index_entry -gst_avi_superindex_entry CHUNKID_TO_STREAMNR
@@ -337,6 +360,11 @@ GST_AVI_MUX_CLASS GST_IS_AVI_MUX GST_IS_AVI_MUX_CLASS gst_avi_mux_get_type +GST_AVI_INDEX_OF_CHUNKS +GST_AVI_INDEX_OF_INDEXES +GST_AVI_SUPERINDEX_COUNT +gst_avi_superindex_entry +gst_riff_strh_full
@@ -348,6 +376,7 @@ GstAviSubtitleClass GST_TYPE_AVI_SUBTITLE GST_AVI_SUBTITLE GST_AVI_SUBTITLE_CLASS +GST_AVI_SUBTITLE_GET_CLASS GST_IS_AVI_SUBTITLE GST_IS_AVI_SUBTITLE_CLASS gst_avi_subtitle_get_type @@ -411,6 +440,21 @@ GST_IS_CMML_ENC_CLASS gst_cmml_enc_plugin_init
+
+element-cutter +cutter +GstCutter + +GST_CUTTER +GST_CUTTER_CLASS +GST_CUTTER_GET_CLASS +GST_IS_CUTTER +GST_IS_CUTTER_CLASS +GST_TYPE_CUTTER +GstCutterClass +gst_cutter_get_type +
+
element-deinterleave deinterleave @@ -616,6 +660,7 @@ LEGACY_FLAC GstFlacEnc GstFlacEncClass +GstFlacTagState GST_TYPE_FLAC_ENC GST_FLAC_ENC GST_FLAC_ENC_CLASS @@ -830,12 +875,14 @@ gst_level_get_type GstMatroskaMux GstMatroskaMuxClass +GstMatroskaMuxState GST_TYPE_MATROSKA_MUX GST_MATROSKA_MUX GST_MATROSKA_MUX_CLASS GST_IS_MATROSKA_MUX GST_IS_MATROSKA_MUX_CLASS gst_matroska_mux_get_type +gst_matroska_mux_plugin_init
@@ -844,12 +891,14 @@ gst_matroska_mux_get_type GstMatroskaDemux GstMatroskaDemuxClass +GstMatroskaDemuxState GST_TYPE_MATROSKA_DEMUX GST_MATROSKA_DEMUX GST_MATROSKA_DEMUX_CLASS GST_IS_MATROSKA_DEMUX GST_IS_MATROSKA_DEMUX_CLASS gst_matroska_demux_get_type +gst_matroska_demux_plugin_init
@@ -865,6 +914,33 @@ GST_MONOSCOPE_CLASS GST_IS_MONOSCOPE_CLASS
+
+element-mulawdec +mulawdec +GstMuLawDec + +GstMuLawDecClass +GST_MULAWDEC +GST_IS_MULAWDEC +GST_TYPE_MULAWDEC +GST_MULAWDEC_CLASS +GST_IS_MULAWDEC_CLASS +gst_mulawdec_get_type +
+ +element-mulawenc +mulawenc +GstMuLawEnc + +GstMuLawEncClass +GST_MULAWENC +GST_IS_MULAWENC +GST_TYPE_MULAWENC +GST_MULAWENC_CLASS +GST_IS_MULAWENC_CLASS +gst_mulawenc_get_type + +
element-multifilesrc multifilesrc @@ -918,6 +994,7 @@ GST_MULTIPART_DEMUX GST_MULTIPART_DEMUX_CLASS GST_IS_MULTIPART_DEMUX GST_IS_MULTIPART_DEMUX_CLASS +GST_MULTIPART_DEMUX_GET_CLASS MULTIPART_DATA_EOS MULTIPART_DATA_ERROR MULTIPART_NEED_MORE_DATA @@ -1106,6 +1183,7 @@ GST_PROGRESS_REPORT GST_PROGRESS_REPORT_CLASS GST_IS_PROGRESS_REPORT GST_IS_PROGRESS_REPORT_CLASS +gst_progress_report_get_type
@@ -1167,6 +1245,35 @@ GST_IS_RG_VOLUME_CLASS gst_rg_volume_get_type
+
+element-rtpdec +rtpdec +GstRTPDec + +GstRTPDecClass +GstRTPDecSession +GST_RTP_DEC +GST_IS_RTP_DEC +GST_TYPE_RTP_DEC +GST_RTP_DEC_CLASS +GST_IS_RTP_DEC_CLASS +gst_rtp_dec_get_type +
+ +
+element-rtpjpegpay +rtpjpegpay +GstRtpJPEGPay + +GstRtpJPEGPayClass +GST_RTP_JPEG_PAY +GST_IS_RTP_JPEG_PAY +GST_TYPE_RTP_JPEG_PAY +GST_RTP_JPEG_PAY_CLASS +GST_IS_RTP_JPEG_PAY_CLASS +gst_rtp_jpeg_pay_get_type +
+
element-rtspsrc rtspsrc @@ -1177,7 +1284,6 @@ GstRTSPSrcClass GST_RTSPSRC GST_IS_RTSPSRC GST_TYPE_RTSPSRC -gst_rtspsrc_get_type GST_RTSPSRC_CLASS GST_IS_RTSPSRC_CLASS GST_RTSPSRC_CAST @@ -1190,21 +1296,7 @@ GST_RTSP_STATE_UNLOCK GST_RTSP_STREAM_GET_LOCK GST_RTSP_STREAM_LOCK GST_RTSP_STREAM_UNLOCK -
- -
-element-rtpdec -rtpdec -GstRTPDec - -GstRTPDecClass -GstRTPDecSession -GST_RTP_DEC -GST_IS_RTP_DEC -GST_TYPE_RTP_DEC -gst_rtp_dec_get_type -GST_RTP_DEC_CLASS -GST_IS_RTP_DEC_CLASS +gst_rtspsrc_get_type
@@ -1218,6 +1310,7 @@ GST_IS_SMPTE GST_TYPE_SMPTE GST_SMPTE_CLASS GST_IS_SMPTE_CLASS +gst_smpte_plugin_init
@@ -1231,6 +1324,7 @@ GST_IS_SMPTE_ALPHA GST_TYPE_SMPTE_ALPHA GST_SMPTE_ALPHA_CLASS GST_IS_SMPTE_ALPHA_CLASS +gst_smpte_alpha_plugin_init
@@ -1328,9 +1422,36 @@ GstUDPSrcClass GST_UDPSRC GST_IS_UDPSRC GST_TYPE_UDPSRC -gst_udpsrc_get_type GST_UDPSRC_CLASS GST_IS_UDPSRC_CLASS +gst_udpsrc_get_type +
+ +
+element-udpsink +udpsink +GstUDPSink + +GstUDPSinkClass +GST_UDPSINK +GST_IS_UDPSINK +GST_TYPE_UDPSINK +GST_UDPSINK_CLASS +GST_IS_UDPSINK_CLASS +gst_udpsink_get_type +
+ +
+element-videobox +videobox +GstVideoBox + +GstVideoBoxClass +GST_IS_VIDEO_BOX +GST_IS_VIDEO_BOX_CLASS +GST_VIDEO_BOX +GST_VIDEO_BOX_CLASS +GST_TYPE_VIDEO_BOX
@@ -1361,6 +1482,7 @@ GST_IS_ASPECT_RATIO_CROP_CLASS GST_ASPECT_RATIO_CROP GST_ASPECT_RATIO_CROP_CLASS GST_TYPE_ASPECT_RATIO_CROP +gst_aspect_ratio_crop_get_type
@@ -1435,9 +1557,9 @@ GstV4l2SrcClass GST_V4L2SRC GST_IS_V4L2SRC GST_TYPE_V4L2SRC -gst_v4l2src_get_type GST_V4L2SRC_CLASS GST_IS_V4L2SRC_CLASS +gst_v4l2src_get_type
@@ -1461,6 +1583,20 @@ BUFFER_SIZE ERROR_LENGTH
+
+element-wavenc +wavenc +GstWavEnc + +GstWavEncClass +GST_WAVENC +GST_IS_WAVENC +GST_TYPE_WAVENC +GST_WAVENC_CLASS +GST_IS_WAVENC_CLASS +gst_wavenc_get_type +
+
element-wavpackdec wavpackdec @@ -1517,9 +1653,9 @@ GstWavParseState GST_WAVPARSE GST_IS_WAVPARSE GST_TYPE_WAVPARSE -gst_wavparse_get_type GST_WAVPARSE_CLASS GST_IS_WAVPARSE_CLASS +gst_wavparse_get_type
@@ -1531,7 +1667,7 @@ GstXImageSrcClass GST_XIMAGE_SRC GST_IS_XIMAGE_SRC GST_TYPE_XIMAGE_SRC -gst_ximage_src_get_type GST_XIMAGE_SRC_CLASS GST_IS_XIMAGE_SRC_CLASS +gst_ximage_src_get_type
diff --git a/docs/plugins/gst-plugins-good-plugins.args b/docs/plugins/gst-plugins-good-plugins.args index f352ceb0e0..48bbaac98f 100644 --- a/docs/plugins/gst-plugins-good-plugins.args +++ b/docs/plugins/gst-plugins-good-plugins.args @@ -411,7 +411,7 @@ GstUDPSrc::sockfd gint ->= G_MAXULONG +>= -1 rw Socket Handle Socket to use for UDP reception. (-1 == allocate). @@ -461,7 +461,7 @@ GstUDPSrc::sock gint ->= G_MAXULONG +>= -1 r Socket Handle Socket currently in use for UDP reception. (-1 = no socket). @@ -1671,7 +1671,7 @@ GstTest::allowed-timestamp-deviation gint64 ->= G_MAXULONG +>= -1 rwx allowed timestamp deviation allowed average difference in usec between timestamp of next buffer and expected timestamp from analyzing last buffer. @@ -1681,7 +1681,7 @@ GstTest::buffer-count gint64 ->= G_MAXULONG +>= -1 r buffer count number of buffers in stream. @@ -1691,7 +1691,7 @@ GstTest::expected-buffer-count gint64 ->= G_MAXULONG +>= -1 rwx expected buffer count expected number of buffers in stream. @@ -1701,7 +1701,7 @@ GstTest::expected-length gint64 ->= G_MAXULONG +>= -1 rwx expected length expected length of stream. @@ -1721,7 +1721,7 @@ GstTest::length gint64 ->= G_MAXULONG +>= -1 r length length of stream. @@ -1741,7 +1741,7 @@ GstTest::timestamp-deviation gint64 ->= G_MAXULONG +>= -1 r timestamp deviation average difference in usec between timestamp of next buffer and expected timestamp from analyzing last buffer. @@ -1811,7 +1811,7 @@ GstBreakMyData::set-to gint -[G_MAXULONG,255] +[-1,255] rwx set-to set changed bytes to this value (-1 means random value. @@ -2131,7 +2131,7 @@ GstDynUDPSink::sockfd gint -[G_MAXULONG,32767] +[-1,32767] rw socket handle Socket to use for UDP sending. (-1 == allocate). @@ -2201,7 +2201,7 @@ GstMultiUDPSink::sock gint ->= G_MAXULONG +>= -1 r Socket Handle Socket currently in use for UDP sending. (-1 == no socket). @@ -2211,7 +2211,7 @@ GstMultiUDPSink::sockfd gint ->= G_MAXULONG +>= -1 rw Socket Handle Socket to use for UDP sending. (-1 == allocate). @@ -2241,7 +2241,7 @@ GstMultiUDPSink::qos-dscp gint -[G_MAXULONG,63] +[-1,63] rw QoS diff srv code point Quality of Service, differentiated services code point (-1 default). @@ -2811,7 +2811,7 @@ GstV4l2Src::device-fd gint ->= G_MAXULONG +>= -1 r File descriptor File descriptor of the device. @@ -3031,7 +3031,7 @@ GstRndBufferSize::max glong -[1,G_MAXINT] +>= 1 rwx maximum maximum buffer size. @@ -3041,7 +3041,7 @@ GstRndBufferSize::min glong -[0,G_MAXINT] +>= 0 rwx mininum mininum buffer size. @@ -3051,7 +3051,7 @@ GstRndBufferSize::seed gulong -<= G_MAXUINT + rwx random number seed seed for randomness (initialized when going from READY to PAUSED). diff --git a/docs/plugins/gst-plugins-good-plugins.hierarchy b/docs/plugins/gst-plugins-good-plugins.hierarchy index edae7e4392..87350892b6 100644 --- a/docs/plugins/gst-plugins-good-plugins.hierarchy +++ b/docs/plugins/gst-plugins-good-plugins.hierarchy @@ -11,25 +11,28 @@ GObject GstElement GstBin GstPipeline + GstHalAudioSink + GstHalAudioSrc GstGConfVideoSink GstGConfVideoSrc GstSwitchSink GstGConfAudioSink GstGConfAudioSrc - GstHalAudioSink - GstHalAudioSrc GstAspectRatioCrop + GstRTSPSrc GstRgVolume GstAutoVideoSink GstAutoVideoSrc GstAutoAudioSink GstAutoAudioSrc - GstRTSPSrc + GstWavpackParse + GstWavpackDec + GstWavpackEnc GstTagLibMux GstId3v2Mux GstApev2Mux - GstPngDec - GstPngEnc + GstSpeexEnc + GstSpeexDec GstBaseSrc GstPushSrc GstSoupHTTPSrc @@ -37,53 +40,42 @@ GObject GstAudioSrc GstPulseSrc GstOssSrc - GstDV1394Src - GstHDV1394Src - GstV4l2Src GstXImageSrc - GstMultiFileSrc + GstV4l2Src GstUDPSrc + GstMultiFileSrc GstBaseSink + GstShout2send GstBaseAudioSink GstAudioSink - GstEsdSink GstPulseSink + GstEsdSink GstOssSink - GstAASink + GstCACASink GstVideoSink GstGdkPixbufSink - GstCACASink - GstShout2send - GstTest - GstMultiFileSink + GstAASink GstMultiUDPSink GstUDPSink GstDynUDPSink + GstMultiFileSink + GstTest GstPulseMixer + GstPngDec + GstPngEnc GstJpegEnc GstJpegDec GstSmokeEnc GstSmokeDec - GstWavpackParse - GstWavpackDec - GstWavpackEnc - GstFlacEnc - GstFlacDec - GstFlacTag - GstDVDemux - GstDVDec - GstSpeexEnc - GstSpeexDec GstGdkPixbuf GstBaseTransform GstPixbufScale GstCairoTimeOverlay - GstVideoBox GstVideoFilter - GstVideoFlip - GstVideoBalance GstGamma - GstNavigationtest + GstVideoBalance + GstVideoFlip + GstSMPTEAlpha GstEdgeTV GstAgingTV GstDiceTV @@ -92,10 +84,15 @@ GObject GstVertigoTV GstRevTV GstQuarkTV - GstSMPTEAlpha + GstNavigationtest GstVideoCrop - GstAudioPanorama + GstVideoBox GstAudioFilter + GstSpectrum + GstIirEqualizer + GstIirEqualizerNBands + GstIirEqualizer3Bands + GstIirEqualizer10Bands GstAudioInvert GstAudioKaraoke GstAudioAmplify @@ -109,40 +106,30 @@ GObject GstAudioWSincBand GstAudioFIRFilter GstAudioEcho - GstIirEqualizer - GstIirEqualizerNBands - GstIirEqualizer3Bands - GstIirEqualizer10Bands - GstSpectrum GstRgAnalysis GstRgLimiter + GstLevel GstBreakMyData GstNavSeek GstProgressReport GstTagInject + GstAudioPanorama GstAlphaColor GstAlpha - GstLevel + GstFlacEnc + GstFlacDec + GstFlacTag + GstDVDemux + GstDVDec + GstCairoTextOverlay GstCmmlEnc GstCmmlDec - GstCairoTextOverlay GstOssMixerElement - GstMultipartDemux - GstMultipartMux - GstFlxDec - GstAuParse - GstALawEnc - GstALawDec - GstMuLawEnc - GstMuLawDec - GstVideoMixer - GstRndBufferSize - GstEFence - GstTagDemux - GstID3Demux - GstApeDemux - GstGoom2k1 + GstWavParse GstWavEnc + GstVideoMixer + GstSMPTE + GstRTPDec GstRTPDepay GstBaseRTPDepayload GstRtpAC3Depay @@ -198,21 +185,33 @@ GObject GstRtpVorbisPay GstRtpVRawPay GstAsteriskh263 + GstQTDemux + GstMultipartDemux + GstMultipartMux + GstMonoscope GstEbmlRead GstMatroskaDemux GstMatroskaMux - GstCutter + GstMuLawEnc + GstMuLawDec + GstALawEnc + GstALawDec + GstInterleave + GstDeinterleave + GstTagDemux + GstID3Demux + GstApeDemux GstICYDemux + GstGoom2k1 + GstGoom + GstFlxDec + GstRndBufferSize + GstEFence + GstCutter GstAviDemux GstAviMux GstAviSubtitle - GstRTPDec - GstWavParse - GstQTDemux - GstSMPTE - GstInterleave - GstDeinterleave - GstGoom + GstAuParse GstBus GstTask GstClock diff --git a/docs/plugins/gst-plugins-good-plugins.interfaces b/docs/plugins/gst-plugins-good-plugins.interfaces index b5c5bbbd2c..ca06f59fb7 100644 --- a/docs/plugins/gst-plugins-good-plugins.interfaces +++ b/docs/plugins/gst-plugins-good-plugins.interfaces @@ -1,42 +1,40 @@ GstBin GstChildProxy GstPipeline GstChildProxy +GstHalAudioSink GstChildProxy +GstHalAudioSrc GstChildProxy GstGConfVideoSink GstChildProxy GstGConfVideoSrc GstChildProxy GstSwitchSink GstChildProxy GstGConfAudioSink GstChildProxy GstGConfAudioSrc GstChildProxy -GstHalAudioSink GstChildProxy -GstHalAudioSrc GstChildProxy GstAspectRatioCrop GstChildProxy +GstRTSPSrc GstChildProxy GstURIHandler GstRgVolume GstChildProxy GstAutoVideoSink GstChildProxy GstAutoVideoSrc GstChildProxy GstAutoAudioSink GstChildProxy GstAutoAudioSrc GstChildProxy -GstRTSPSrc GstChildProxy GstURIHandler GstTagLibMux GstTagSetter GstId3v2Mux GstTagSetter GstApev2Mux GstTagSetter +GstSpeexEnc GstTagSetter GstSoupHTTPSrc GstURIHandler -GstPulseSrc GstImplementsInterface GstPropertyProbe GstMixer -GstOssSrc GstImplementsInterface GstMixer -GstDV1394Src GstURIHandler GstPropertyProbe -GstHDV1394Src GstURIHandler GstPropertyProbe +GstPulseSrc GstMixer GstImplementsInterface GstPropertyProbe +GstOssSrc GstMixer GstImplementsInterface GstV4l2Src GstImplementsInterface GstPropertyProbe GstTuner GstColorBalance GstVideoOrientation GstUDPSrc GstURIHandler -GstPulseSink GstImplementsInterface GstPropertyProbe GstShout2send GstTagSetter +GstPulseSink GstImplementsInterface GstPropertyProbe GstUDPSink GstURIHandler -GstPulseMixer GstImplementsInterface GstPropertyProbe GstMixer -GstFlacEnc GstTagSetter -GstFlacTag GstTagSetter -GstSpeexEnc GstTagSetter +GstPulseMixer GstMixer GstImplementsInterface GstPropertyProbe GstVideoBalance GstImplementsInterface GstColorBalance GstIirEqualizer GstChildProxy GstIirEqualizerNBands GstChildProxy GstIirEqualizer3Bands GstChildProxy GstPreset GstIirEqualizer10Bands GstChildProxy GstPreset -GstOssMixerElement GstImplementsInterface GstMixer +GstFlacEnc GstTagSetter +GstFlacTag GstTagSetter +GstOssMixerElement GstMixer GstImplementsInterface GstVideoMixer GstChildProxy GstMatroskaMux GstTagSetter GstAviMux GstTagSetter diff --git a/docs/plugins/inspect/plugin-aasink.xml b/docs/plugins/inspect/plugin-aasink.xml index 1be6d0508f..55b5b7106c 100644 --- a/docs/plugins/inspect/plugin-aasink.xml +++ b/docs/plugins/inspect/plugin-aasink.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org aasink diff --git a/docs/plugins/inspect/plugin-alaw.xml b/docs/plugins/inspect/plugin-alaw.xml index fcec748c12..fff72eebdd 100644 --- a/docs/plugins/inspect/plugin-alaw.xml +++ b/docs/plugins/inspect/plugin-alaw.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org alawdec diff --git a/docs/plugins/inspect/plugin-alpha.xml b/docs/plugins/inspect/plugin-alpha.xml index 4de356da18..669f3dca2b 100644 --- a/docs/plugins/inspect/plugin-alpha.xml +++ b/docs/plugins/inspect/plugin-alpha.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org alpha diff --git a/docs/plugins/inspect/plugin-alphacolor.xml b/docs/plugins/inspect/plugin-alphacolor.xml index 1812c19b1f..6ac6ec5b18 100644 --- a/docs/plugins/inspect/plugin-alphacolor.xml +++ b/docs/plugins/inspect/plugin-alphacolor.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org alphacolor diff --git a/docs/plugins/inspect/plugin-annodex.xml b/docs/plugins/inspect/plugin-annodex.xml index 5b1536c66a..44cb45a7f5 100644 --- a/docs/plugins/inspect/plugin-annodex.xml +++ b/docs/plugins/inspect/plugin-annodex.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org cmmldec diff --git a/docs/plugins/inspect/plugin-apetag.xml b/docs/plugins/inspect/plugin-apetag.xml index 745f6a8e47..861b13a3e0 100644 --- a/docs/plugins/inspect/plugin-apetag.xml +++ b/docs/plugins/inspect/plugin-apetag.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org apedemux diff --git a/docs/plugins/inspect/plugin-audiofx.xml b/docs/plugins/inspect/plugin-audiofx.xml index 6fa035a72d..9d558af8b9 100644 --- a/docs/plugins/inspect/plugin-audiofx.xml +++ b/docs/plugins/inspect/plugin-audiofx.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org audioamplify diff --git a/docs/plugins/inspect/plugin-auparse.xml b/docs/plugins/inspect/plugin-auparse.xml index 63c0995e29..643d371d9b 100644 --- a/docs/plugins/inspect/plugin-auparse.xml +++ b/docs/plugins/inspect/plugin-auparse.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org auparse diff --git a/docs/plugins/inspect/plugin-autodetect.xml b/docs/plugins/inspect/plugin-autodetect.xml index 40d65145f6..d6ed757e68 100644 --- a/docs/plugins/inspect/plugin-autodetect.xml +++ b/docs/plugins/inspect/plugin-autodetect.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org autoaudiosink diff --git a/docs/plugins/inspect/plugin-avi.xml b/docs/plugins/inspect/plugin-avi.xml index e4ad6122dd..36d158172a 100644 --- a/docs/plugins/inspect/plugin-avi.xml +++ b/docs/plugins/inspect/plugin-avi.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org avidemux diff --git a/docs/plugins/inspect/plugin-cacasink.xml b/docs/plugins/inspect/plugin-cacasink.xml index d051c1f0da..3631160b64 100644 --- a/docs/plugins/inspect/plugin-cacasink.xml +++ b/docs/plugins/inspect/plugin-cacasink.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org cacasink diff --git a/docs/plugins/inspect/plugin-cairo.xml b/docs/plugins/inspect/plugin-cairo.xml index d372b0cfc0..dc6b0fb6e9 100644 --- a/docs/plugins/inspect/plugin-cairo.xml +++ b/docs/plugins/inspect/plugin-cairo.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org cairotextoverlay diff --git a/docs/plugins/inspect/plugin-cutter.xml b/docs/plugins/inspect/plugin-cutter.xml index 82832aebce..3983e9236e 100644 --- a/docs/plugins/inspect/plugin-cutter.xml +++ b/docs/plugins/inspect/plugin-cutter.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org cutter diff --git a/docs/plugins/inspect/plugin-debug.xml b/docs/plugins/inspect/plugin-debug.xml index c34b4482ec..cc7de2c8f6 100644 --- a/docs/plugins/inspect/plugin-debug.xml +++ b/docs/plugins/inspect/plugin-debug.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org breakmydata diff --git a/docs/plugins/inspect/plugin-dv.xml b/docs/plugins/inspect/plugin-dv.xml index 5159dbfba1..4bb8ce480d 100644 --- a/docs/plugins/inspect/plugin-dv.xml +++ b/docs/plugins/inspect/plugin-dv.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org dvdec diff --git a/docs/plugins/inspect/plugin-efence.xml b/docs/plugins/inspect/plugin-efence.xml index c56ea28880..c3551b4119 100644 --- a/docs/plugins/inspect/plugin-efence.xml +++ b/docs/plugins/inspect/plugin-efence.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org efence diff --git a/docs/plugins/inspect/plugin-effectv.xml b/docs/plugins/inspect/plugin-effectv.xml index 4088a63aae..53122b72ef 100644 --- a/docs/plugins/inspect/plugin-effectv.xml +++ b/docs/plugins/inspect/plugin-effectv.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org agingtv diff --git a/docs/plugins/inspect/plugin-equalizer.xml b/docs/plugins/inspect/plugin-equalizer.xml index 39abb147a4..b54f368509 100644 --- a/docs/plugins/inspect/plugin-equalizer.xml +++ b/docs/plugins/inspect/plugin-equalizer.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org equalizer-10bands diff --git a/docs/plugins/inspect/plugin-esdsink.xml b/docs/plugins/inspect/plugin-esdsink.xml index 609f586159..950dea4f0b 100644 --- a/docs/plugins/inspect/plugin-esdsink.xml +++ b/docs/plugins/inspect/plugin-esdsink.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org esdsink diff --git a/docs/plugins/inspect/plugin-flac.xml b/docs/plugins/inspect/plugin-flac.xml index 432d950cf6..8e1ba382df 100644 --- a/docs/plugins/inspect/plugin-flac.xml +++ b/docs/plugins/inspect/plugin-flac.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org flacdec diff --git a/docs/plugins/inspect/plugin-flxdec.xml b/docs/plugins/inspect/plugin-flxdec.xml index 056d9671dd..ddcd524925 100644 --- a/docs/plugins/inspect/plugin-flxdec.xml +++ b/docs/plugins/inspect/plugin-flxdec.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org flxdec diff --git a/docs/plugins/inspect/plugin-gamma.xml b/docs/plugins/inspect/plugin-gamma.xml index db928ab58a..6191fb528a 100644 --- a/docs/plugins/inspect/plugin-gamma.xml +++ b/docs/plugins/inspect/plugin-gamma.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org gamma diff --git a/docs/plugins/inspect/plugin-gconfelements.xml b/docs/plugins/inspect/plugin-gconfelements.xml index add1d2e62a..4de51fc546 100644 --- a/docs/plugins/inspect/plugin-gconfelements.xml +++ b/docs/plugins/inspect/plugin-gconfelements.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org gconfaudiosink diff --git a/docs/plugins/inspect/plugin-gdkpixbuf.xml b/docs/plugins/inspect/plugin-gdkpixbuf.xml index bd13fb1f28..4f57a2f39e 100644 --- a/docs/plugins/inspect/plugin-gdkpixbuf.xml +++ b/docs/plugins/inspect/plugin-gdkpixbuf.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org gdkpixbufdec diff --git a/docs/plugins/inspect/plugin-goom.xml b/docs/plugins/inspect/plugin-goom.xml index b38062a80b..51313fe4c8 100644 --- a/docs/plugins/inspect/plugin-goom.xml +++ b/docs/plugins/inspect/plugin-goom.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org goom diff --git a/docs/plugins/inspect/plugin-goom2k1.xml b/docs/plugins/inspect/plugin-goom2k1.xml index e27302357e..587f247c08 100644 --- a/docs/plugins/inspect/plugin-goom2k1.xml +++ b/docs/plugins/inspect/plugin-goom2k1.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org goom2k1 diff --git a/docs/plugins/inspect/plugin-halelements.xml b/docs/plugins/inspect/plugin-halelements.xml index 7ca53e9273..5bcae479f3 100644 --- a/docs/plugins/inspect/plugin-halelements.xml +++ b/docs/plugins/inspect/plugin-halelements.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org halaudiosink diff --git a/docs/plugins/inspect/plugin-icydemux.xml b/docs/plugins/inspect/plugin-icydemux.xml index d3cf7edb35..fa277bc84d 100644 --- a/docs/plugins/inspect/plugin-icydemux.xml +++ b/docs/plugins/inspect/plugin-icydemux.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org icydemux diff --git a/docs/plugins/inspect/plugin-id3demux.xml b/docs/plugins/inspect/plugin-id3demux.xml index 5a3a0fed1a..89bdbec3cd 100644 --- a/docs/plugins/inspect/plugin-id3demux.xml +++ b/docs/plugins/inspect/plugin-id3demux.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org id3demux diff --git a/docs/plugins/inspect/plugin-interleave.xml b/docs/plugins/inspect/plugin-interleave.xml index a620c5f0a1..0d57b82007 100644 --- a/docs/plugins/inspect/plugin-interleave.xml +++ b/docs/plugins/inspect/plugin-interleave.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org deinterleave diff --git a/docs/plugins/inspect/plugin-jpeg.xml b/docs/plugins/inspect/plugin-jpeg.xml index 66b60863f3..0167204a08 100644 --- a/docs/plugins/inspect/plugin-jpeg.xml +++ b/docs/plugins/inspect/plugin-jpeg.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org jpegdec diff --git a/docs/plugins/inspect/plugin-level.xml b/docs/plugins/inspect/plugin-level.xml index 7cb06742bf..8c14227ad0 100644 --- a/docs/plugins/inspect/plugin-level.xml +++ b/docs/plugins/inspect/plugin-level.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org level diff --git a/docs/plugins/inspect/plugin-matroska.xml b/docs/plugins/inspect/plugin-matroska.xml index ad15d23387..55adedb682 100644 --- a/docs/plugins/inspect/plugin-matroska.xml +++ b/docs/plugins/inspect/plugin-matroska.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org matroskademux diff --git a/docs/plugins/inspect/plugin-monoscope.xml b/docs/plugins/inspect/plugin-monoscope.xml index ba5b4d3099..9b030a4f9c 100644 --- a/docs/plugins/inspect/plugin-monoscope.xml +++ b/docs/plugins/inspect/plugin-monoscope.xml @@ -3,11 +3,11 @@ Monoscope visualization ../../gst/monoscope/.libs/libgstmonoscope.so libgstmonoscope.so - 0.10.11.1 + 0.10.13.1 LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org monoscope diff --git a/docs/plugins/inspect/plugin-mulaw.xml b/docs/plugins/inspect/plugin-mulaw.xml index c4996e4ffa..24ae082c26 100644 --- a/docs/plugins/inspect/plugin-mulaw.xml +++ b/docs/plugins/inspect/plugin-mulaw.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org mulawdec diff --git a/docs/plugins/inspect/plugin-multifile.xml b/docs/plugins/inspect/plugin-multifile.xml index 7585828b5c..0a2d347164 100644 --- a/docs/plugins/inspect/plugin-multifile.xml +++ b/docs/plugins/inspect/plugin-multifile.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org multifilesink diff --git a/docs/plugins/inspect/plugin-multipart.xml b/docs/plugins/inspect/plugin-multipart.xml index fa67663a36..62b5a48ec1 100644 --- a/docs/plugins/inspect/plugin-multipart.xml +++ b/docs/plugins/inspect/plugin-multipart.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org multipartdemux diff --git a/docs/plugins/inspect/plugin-navigationtest.xml b/docs/plugins/inspect/plugin-navigationtest.xml index a4087d2302..8eec3b4185 100644 --- a/docs/plugins/inspect/plugin-navigationtest.xml +++ b/docs/plugins/inspect/plugin-navigationtest.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org navigationtest diff --git a/docs/plugins/inspect/plugin-ossaudio.xml b/docs/plugins/inspect/plugin-ossaudio.xml index 63f2753ba3..0463701752 100644 --- a/docs/plugins/inspect/plugin-ossaudio.xml +++ b/docs/plugins/inspect/plugin-ossaudio.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org ossmixer diff --git a/docs/plugins/inspect/plugin-png.xml b/docs/plugins/inspect/plugin-png.xml index 3ec4f626e1..a02945b488 100644 --- a/docs/plugins/inspect/plugin-png.xml +++ b/docs/plugins/inspect/plugin-png.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org pngdec diff --git a/docs/plugins/inspect/plugin-pulseaudio.xml b/docs/plugins/inspect/plugin-pulseaudio.xml index b58dc999fd..f22ae6e9a1 100644 --- a/docs/plugins/inspect/plugin-pulseaudio.xml +++ b/docs/plugins/inspect/plugin-pulseaudio.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org pulsemixer diff --git a/docs/plugins/inspect/plugin-quicktime.xml b/docs/plugins/inspect/plugin-quicktime.xml index d53c7c7caa..f05c2b00e5 100644 --- a/docs/plugins/inspect/plugin-quicktime.xml +++ b/docs/plugins/inspect/plugin-quicktime.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org qtdemux diff --git a/docs/plugins/inspect/plugin-replaygain.xml b/docs/plugins/inspect/plugin-replaygain.xml index f12863e87c..237c82eed7 100644 --- a/docs/plugins/inspect/plugin-replaygain.xml +++ b/docs/plugins/inspect/plugin-replaygain.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org rganalysis diff --git a/docs/plugins/inspect/plugin-rtp.xml b/docs/plugins/inspect/plugin-rtp.xml index d14be264e2..29d613615a 100644 --- a/docs/plugins/inspect/plugin-rtp.xml +++ b/docs/plugins/inspect/plugin-rtp.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org asteriskh263 diff --git a/docs/plugins/inspect/plugin-rtsp.xml b/docs/plugins/inspect/plugin-rtsp.xml index aa04974720..12d7cfd1d0 100644 --- a/docs/plugins/inspect/plugin-rtsp.xml +++ b/docs/plugins/inspect/plugin-rtsp.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org rtpdec diff --git a/docs/plugins/inspect/plugin-smpte.xml b/docs/plugins/inspect/plugin-smpte.xml index 8e6448b4bf..f837eb399b 100644 --- a/docs/plugins/inspect/plugin-smpte.xml +++ b/docs/plugins/inspect/plugin-smpte.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org smpte diff --git a/docs/plugins/inspect/plugin-soup.xml b/docs/plugins/inspect/plugin-soup.xml index ff4c380d86..83fe341d56 100644 --- a/docs/plugins/inspect/plugin-soup.xml +++ b/docs/plugins/inspect/plugin-soup.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org souphttpsrc diff --git a/docs/plugins/inspect/plugin-spectrum.xml b/docs/plugins/inspect/plugin-spectrum.xml index 16356e7a46..c49c01434f 100644 --- a/docs/plugins/inspect/plugin-spectrum.xml +++ b/docs/plugins/inspect/plugin-spectrum.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org spectrum diff --git a/docs/plugins/inspect/plugin-speex.xml b/docs/plugins/inspect/plugin-speex.xml index 1671387d62..a53d37fa3d 100644 --- a/docs/plugins/inspect/plugin-speex.xml +++ b/docs/plugins/inspect/plugin-speex.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org speexdec diff --git a/docs/plugins/inspect/plugin-taglib.xml b/docs/plugins/inspect/plugin-taglib.xml index 0779f5130a..8623b9e177 100644 --- a/docs/plugins/inspect/plugin-taglib.xml +++ b/docs/plugins/inspect/plugin-taglib.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org apev2mux diff --git a/docs/plugins/inspect/plugin-udp.xml b/docs/plugins/inspect/plugin-udp.xml index 533bd84b5a..23eac4ef13 100644 --- a/docs/plugins/inspect/plugin-udp.xml +++ b/docs/plugins/inspect/plugin-udp.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org dynudpsink diff --git a/docs/plugins/inspect/plugin-video4linux2.xml b/docs/plugins/inspect/plugin-video4linux2.xml index 9ac8b54b12..d397686f7c 100644 --- a/docs/plugins/inspect/plugin-video4linux2.xml +++ b/docs/plugins/inspect/plugin-video4linux2.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org v4l2src diff --git a/docs/plugins/inspect/plugin-videobalance.xml b/docs/plugins/inspect/plugin-videobalance.xml index ad40bbc7ea..4e8e6734a7 100644 --- a/docs/plugins/inspect/plugin-videobalance.xml +++ b/docs/plugins/inspect/plugin-videobalance.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org videobalance diff --git a/docs/plugins/inspect/plugin-videobox.xml b/docs/plugins/inspect/plugin-videobox.xml index cc6e3f83cd..88c40df788 100644 --- a/docs/plugins/inspect/plugin-videobox.xml +++ b/docs/plugins/inspect/plugin-videobox.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org videobox diff --git a/docs/plugins/inspect/plugin-videocrop.xml b/docs/plugins/inspect/plugin-videocrop.xml index 42085b81af..1a0cbfb5be 100644 --- a/docs/plugins/inspect/plugin-videocrop.xml +++ b/docs/plugins/inspect/plugin-videocrop.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org aspectratiocrop diff --git a/docs/plugins/inspect/plugin-videoflip.xml b/docs/plugins/inspect/plugin-videoflip.xml index 0bfbd63890..adb7fbce5e 100644 --- a/docs/plugins/inspect/plugin-videoflip.xml +++ b/docs/plugins/inspect/plugin-videoflip.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org videoflip diff --git a/docs/plugins/inspect/plugin-videomixer.xml b/docs/plugins/inspect/plugin-videomixer.xml index f31a36ee4f..21a795f86b 100644 --- a/docs/plugins/inspect/plugin-videomixer.xml +++ b/docs/plugins/inspect/plugin-videomixer.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org videomixer diff --git a/docs/plugins/inspect/plugin-wavenc.xml b/docs/plugins/inspect/plugin-wavenc.xml index 4e0d0c2b00..86b877de5c 100644 --- a/docs/plugins/inspect/plugin-wavenc.xml +++ b/docs/plugins/inspect/plugin-wavenc.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org wavenc diff --git a/docs/plugins/inspect/plugin-wavpack.xml b/docs/plugins/inspect/plugin-wavpack.xml index 7ab8ebcdd0..a49622cdf4 100644 --- a/docs/plugins/inspect/plugin-wavpack.xml +++ b/docs/plugins/inspect/plugin-wavpack.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org wavpackdec diff --git a/docs/plugins/inspect/plugin-wavparse.xml b/docs/plugins/inspect/plugin-wavparse.xml index fa9c2d89cd..c2be822033 100644 --- a/docs/plugins/inspect/plugin-wavparse.xml +++ b/docs/plugins/inspect/plugin-wavparse.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org wavparse diff --git a/docs/plugins/inspect/plugin-ximagesrc.xml b/docs/plugins/inspect/plugin-ximagesrc.xml index 6fd3bcbca1..78b4640aab 100644 --- a/docs/plugins/inspect/plugin-ximagesrc.xml +++ b/docs/plugins/inspect/plugin-ximagesrc.xml @@ -7,7 +7,7 @@ LGPL gst-plugins-good GStreamer Good Plug-ins CVS/prerelease - Unknown package origin + http://gstreamer.freedesktop.org ximagesrc diff --git a/gst/alpha/gstalphacolor.c b/gst/alpha/gstalphacolor.c index 6e628781e6..26086ef656 100644 --- a/gst/alpha/gstalphacolor.c +++ b/gst/alpha/gstalphacolor.c @@ -20,12 +20,8 @@ /** * 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 diff --git a/gst/apetag/gstapedemux.c b/gst/apetag/gstapedemux.c index 7adc2ccdc2..fc9c3aae18 100644 --- a/gst/apetag/gstapedemux.c +++ b/gst/apetag/gstapedemux.c @@ -20,33 +20,26 @@ /** * SECTION:element-apedemux - * @short_description: reads tag information from APE tag data blocks and - * outputs them as GStreamer tag messages and events. * - * - * * apedemux accepts data streams with APE tags at the start or at the end * (or both). The mime type of the data between the tag blocks is detected * using typefind functions, and the appropriate output mime type set on - * outgoing buffers. - * - * + * outgoing buffers. + * * The element is only able to read APE tags at the end of a stream from * a seekable stream, ie. when get_range mode is supported by the upstream * elements. If get_range operation is available, apedemux makes it available * downstream. This means that elements which require get_range mode, such as * wavparse or musepackdec, can operate on files containing APE tag * information. - * + * + * * Example launch line - * - * + * |[ * gst-launch -t filesrc location=file.mpc ! apedemux ! fakesink - * - * This pipeline should read any available APE tag information and output it. + * ]| This pipeline should read any available APE tag information and output it. * The contents of the file inside the APE tag regions should be detected, and * the appropriate mime type set on buffers produced from apedemux. - * * */ #ifdef HAVE_CONFIG_H diff --git a/gst/audiofx/audioamplify.c b/gst/audiofx/audioamplify.c index ce4a0042bc..da5412a485 100644 --- a/gst/audiofx/audioamplify.c +++ b/gst/audiofx/audioamplify.c @@ -21,19 +21,16 @@ /** * SECTION:element-audioamplify - * @short_description: Amplifies an audio stream with selectable clipping mode * - * * Amplifies an audio stream by a given factor and allows the selection of different clipping modes. * The difference between the clipping modes is best evaluated by testing. * Example launch line - * - * + * + * |[ * gst-launch audiotestsrc wave=saw ! audioamplify amplification=1.5 ! alsasink * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audioamplify amplification=1.5 method=wrap-negative ! alsasink * gst-launch audiotestsrc wave=saw ! audioconvert ! audioamplify amplification=1.5 method=wrap-positive ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/gst/audiofx/audiochebband.c b/gst/audiofx/audiochebband.c index bf9c205efd..7ecb7956c0 100644 --- a/gst/audiofx/audiochebband.c +++ b/gst/audiofx/audiochebband.c @@ -34,42 +34,35 @@ /** * SECTION:element-audiochebband - * @short_description: Chebyshev band pass and band reject filter * - * - * * Attenuates all frequencies outside (bandpass) or inside (bandreject) of a frequency * band. The number of poles and the ripple parameter control the rolloff. - * - * + * * This element has the advantage over the windowed sinc bandpass and bandreject filter that it is * much faster and produces almost as good results. It's only disadvantages are the highly * non-linear phase and the slower rolloff compared to a windowed sinc filter with a large kernel. - * - * + * * For type 1 the ripple parameter specifies how much ripple in dB is allowed in the passband, i.e. * some frequencies in the passband will be amplified by that value. A higher ripple value will allow * a faster rolloff. - * - * + * * For type 2 the ripple parameter specifies the stopband attenuation. In the stopband the gain will * be at most this value. A lower ripple value will allow a faster rolloff. - * - * + * * As a special case, a Chebyshev type 1 filter with no ripple is a Butterworth filter. - * - * + * + * * Be warned that a too large number of poles can produce noise. The most poles are possible with * a cutoff frequency at a quarter of the sampling rate. - * + * + * + * * Example launch line - * - * + * |[ * gst-launch audiotestsrc freq=1500 ! audioconvert ! audiochebband mode=band-pass lower-frequency=1000 upper-frequenc=6000 poles=4 ! audioconvert ! alsasink * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audiochebband mode=band-reject lower-frequency=1000 upper-frequency=4000 ripple=0.2 ! audioconvert ! alsasink * gst-launch audiotestsrc wave=white-noise ! audioconvert ! audiochebband mode=band-pass lower-frequency=1000 upper-frequency=4000 type=2 ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/gst/audiofx/audiocheblimit.c b/gst/audiofx/audiocheblimit.c index b4efbb3afa..5d91909efc 100644 --- a/gst/audiofx/audiocheblimit.c +++ b/gst/audiofx/audiocheblimit.c @@ -30,42 +30,35 @@ /** * SECTION:element-audiocheblimit - * @short_description: Chebyshev low pass and high pass filter * - * - * * Attenuates all frequencies above the cutoff frequency (low-pass) or all frequencies below the * cutoff frequency (high-pass). The number of poles and the ripple parameter control the rolloff. - * - * + * * This element has the advantage over the windowed sinc lowpass and highpass filter that it is * much faster and produces almost as good results. It's only disadvantages are the highly * non-linear phase and the slower rolloff compared to a windowed sinc filter with a large kernel. - * - * + * * For type 1 the ripple parameter specifies how much ripple in dB is allowed in the passband, i.e. * some frequencies in the passband will be amplified by that value. A higher ripple value will allow * a faster rolloff. - * - * + * * For type 2 the ripple parameter specifies the stopband attenuation. In the stopband the gain will * be at most this value. A lower ripple value will allow a faster rolloff. - * - * + * * As a special case, a Chebyshev type 1 filter with no ripple is a Butterworth filter. * - * + * * Be warned that a too large number of poles can produce noise. The most poles are possible with * a cutoff frequency at a quarter of the sampling rate. - * - * Example launch line + * * - * + * + * Example launch line + * |[ * gst-launch audiotestsrc freq=1500 ! audioconvert ! audiocheblimit mode=low-pass cutoff=1000 poles=4 ! audioconvert ! alsasink * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audiocheblimit mode=high-pass cutoff=400 ripple=0.2 ! audioconvert ! alsasink * gst-launch audiotestsrc wave=white-noise ! audioconvert ! audiocheblimit mode=low-pass cutoff=800 type=2 ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/gst/audiofx/audiodynamic.c b/gst/audiofx/audiodynamic.c index 7a84fa8102..240c270e7c 100644 --- a/gst/audiofx/audiodynamic.c +++ b/gst/audiofx/audiodynamic.c @@ -20,21 +20,19 @@ /** * SECTION:element-audiodynamic - * @short_description: Compressor and Expander * - * * This element can act as a compressor or expander. A compressor changes the * amplitude of all samples above a specific threshold with a specific ratio, * a expander does the same for all samples below a specific threshold. If * soft-knee mode is selected the ratio is applied smoothly. + * + * * Example launch line - * - * + * |[ * gst-launch audiotestsrc wave=saw ! audiodynamic characteristics=soft-knee mode=compressor threshold=0.5 rate=0.5 ! alsasink * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audiodynamic characteristics=hard-knee mode=expander threshold=0.2 rate=4.0 ! alsasink * gst-launch audiotestsrc wave=saw ! audioconvert ! audiodynamic ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/gst/audiofx/audioecho.c b/gst/audiofx/audioecho.c index dd209a2354..6676d79191 100644 --- a/gst/audiofx/audioecho.c +++ b/gst/audiofx/audioecho.c @@ -20,24 +20,22 @@ /** * SECTION:element-audioecho + * @Since: 0.10.12 * - * * audioecho adds an echo or (simple) reverb effect to an audio stream. The echo * delay, intensity and the percentage of feedback can be configured. - * + * * For getting an echo effect you have to set the delay to a larger value, * for example 200ms and more. Everything below will result in a simple * reverb effect, which results in a slightly metallic sounding. - * - * - * + * + * + * Example launch line + * |[ * gst-launch filesrc location="melo1.ogg" ! audioconvert ! audioecho delay=500000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink * gst-launch filesrc location="melo1.ogg" ! decodebin ! audioconvert ! audioecho delay=50000000 intensity=0.6 feedback=0.4 ! audioconvert ! autoaudiosink - * - * + * ]| * - * - * Since: 0.10.12 */ #ifdef HAVE_CONFIG_H diff --git a/gst/audiofx/audiofirfilter.c b/gst/audiofx/audiofirfilter.c index 3ee4d832d2..df4e2dcb50 100644 --- a/gst/audiofx/audiofirfilter.c +++ b/gst/audiofx/audiofirfilter.c @@ -21,31 +21,27 @@ /** * SECTION:element-audiofirfilter - * @short_description: Generic audio FIR filter * - * - * * audiofirfilter implements a generic audio FIR filter. Before usage the * "kernel" property has to be set to the filter kernel that should be * used and the "latency" property has to be set to the latency (in samples) * that is introduced by the filter kernel. Setting a latency of n samples * will lead to the first n samples being dropped from the output and * n samples added to the end. - * - * + * * The filter kernel describes the impulse response of the filter. To * calculate the frequency response of the filter you have to calculate * the Fourier Transform of the impulse response. - * - * + * * To change the filter kernel whenever the sampling rate changes the * "rate-changed" signal can be used. This should be done for most * FIR filters as they're depending on the sampling rate. - * + * + * * Example application - * - * - * + * |[ + * + * ]| * */ diff --git a/gst/audiofx/audioiirfilter.c b/gst/audiofx/audioiirfilter.c index 76112c6f1a..1f06312200 100644 --- a/gst/audiofx/audioiirfilter.c +++ b/gst/audiofx/audioiirfilter.c @@ -21,27 +21,23 @@ /** * SECTION:element-audioiirfilter - * @short_description: Generic audio IIR filter * - * - * * audioiirfilter implements a generic audio IIR filter. Before usage the * "a" and "b" properties have to be set to the filter coefficients that * should be used. - * - * + * * The filter coefficients describe the numerator and denominator of the * transfer function. - * - * + * * To change the filter coefficients whenever the sampling rate changes the * "rate-changed" signal can be used. This should be done for most * IIR filters as they're depending on the sampling rate. - * + * + * * Example application - * - * - * + * |[ + * + * ]| * */ diff --git a/gst/audiofx/audioinvert.c b/gst/audiofx/audioinvert.c index 188793f502..a6911697fc 100644 --- a/gst/audiofx/audioinvert.c +++ b/gst/audiofx/audioinvert.c @@ -21,20 +21,18 @@ /** * SECTION:element-audioinvert - * @short_description: Swaps upper and lower half of audio samples * - * * Swaps upper and lower half of audio samples. Mixing an inverted sample on top of * the original with a slight delay can produce effects that sound like resonance. * Creating a stereo sample from a mono source, with one channel inverted produces wide-stereo sounds. + * + * * Example launch line - * - * + * |[ * gst-launch audiotestsrc wave=saw ! audioinvert invert=0.4 ! alsasink * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audioinvert invert=0.4 ! alsasink * gst-launch audiotestsrc wave=saw ! audioconvert ! audioinvert invert=0.4 ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/gst/audiofx/audiokaraoke.c b/gst/audiofx/audiokaraoke.c index ec50568101..fe34971e3f 100644 --- a/gst/audiofx/audiokaraoke.c +++ b/gst/audiofx/audiokaraoke.c @@ -20,17 +20,15 @@ /** * SECTION:element-audiokaraoke - * @short_description: Voice removal element * - * * Remove the voice from audio by filtering the center channel. * This plugin is useful for karaoke applications. + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=song.ogg ! oggdemux ! vorbisdec ! audiokaraoke ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/gst/audiofx/audiopanorama.c b/gst/audiofx/audiopanorama.c index e38f10d2a9..3f57648dd9 100644 --- a/gst/audiofx/audiopanorama.c +++ b/gst/audiofx/audiopanorama.c @@ -21,20 +21,18 @@ /** * SECTION:element-audiopanorama - * @short_description: audio stereo pan effect * - * * Stereo panorama effect with controllable pan position. One can choose between the default psychoacoustic panning method, * which keeps the same perceived loudness, and a simple panning method that just controls the volume on one channel. + * + * * Example launch line - * - * + * |[ * gst-launch audiotestsrc wave=saw ! audiopanorama panorama=-1.00 ! alsasink * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audiopanorama panorama=-1.00 ! alsasink * gst-launch audiotestsrc wave=saw ! audioconvert ! audiopanorama panorama=-1.00 ! audioconvert ! alsasink * gst-launch audiotestsrc wave=saw ! audioconvert ! audiopanorama method=simple panorama=-0.50 ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/gst/audiofx/audiowsincband.c b/gst/audiofx/audiowsincband.c index 69bf5c1955..70c85b480f 100644 --- a/gst/audiofx/audiowsincband.c +++ b/gst/audiofx/audiowsincband.c @@ -30,28 +30,23 @@ /** * SECTION:element-audiowsincband - * @short_description: Windowed Sinc band pass and band reject filter * - * - * * Attenuates all frequencies outside (bandpass) or inside (bandreject) of a frequency * band. The length parameter controls the rolloff, the window parameter * controls rolloff and stopband attenuation. The Hamming window provides a faster rolloff but a bit * worse stopband attenuation, the other way around for the Blackman window. - * - * + * * This element has the advantage over the Chebyshev bandpass and bandreject filter that it has * a much better rolloff when using a larger kernel size and almost linear phase. The only * disadvantage is the much slower execution time with larger kernels. - * + * + * * Example launch line - * - * + * |[ * gst-launch audiotestsrc freq=1500 ! audioconvert ! audiosincband mode=band-pass lower-frequency=3000 upper-frequency=10000 length=501 window=blackman ! audioconvert ! alsasink * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audiowsincband mode=band-reject lower-frequency=59 upper-frequency=61 length=10001 window=hamming ! audioconvert ! alsasink * gst-launch audiotestsrc wave=white-noise ! audioconvert ! audiowsincband mode=band-pass lower-frequency=1000 upper-frequency=2000 length=31 ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/gst/audiofx/audiowsinclimit.c b/gst/audiofx/audiowsinclimit.c index 1f33ad2dbf..73bdbe5051 100644 --- a/gst/audiofx/audiowsinclimit.c +++ b/gst/audiofx/audiowsinclimit.c @@ -30,28 +30,23 @@ /** * SECTION:element-audiowsinclimit - * @short_description: Windowed Sinc low pass and high pass filter * - * - * * Attenuates all frequencies above the cutoff frequency (low-pass) or all frequencies below the * cutoff frequency (high-pass). The length parameter controls the rolloff, the window parameter * controls rolloff and stopband attenuation. The Hamming window provides a faster rolloff but a bit * worse stopband attenuation, the other way around for the Blackman window. - * - * + * * This element has the advantage over the Chebyshev lowpass and highpass filter that it has * a much better rolloff when using a larger kernel size and almost linear phase. The only * disadvantage is the much slower execution time with larger kernels. - * + * + * * Example launch line - * - * + * |[ * gst-launch audiotestsrc freq=1500 ! audioconvert ! audiowsinclimit mode=low-pass frequency=1000 length=501 ! audioconvert ! alsasink * gst-launch filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audiowsinclimit mode=high-pass frequency=15000 length=501 ! audioconvert ! alsasink * gst-launch audiotestsrc wave=white-noise ! audioconvert ! audiowsinclimit mode=low-pass frequency=1000 length=10001 window=blackman ! audioconvert ! alsasink - * - * + * ]| * */ diff --git a/gst/auparse/gstauparse.c b/gst/auparse/gstauparse.c index 1f0dccc06a..14996ae193 100644 --- a/gst/auparse/gstauparse.c +++ b/gst/auparse/gstauparse.c @@ -20,13 +20,8 @@ /** * SECTION:element-auparse - * @short_description: .au file parser * - * - * - * Parses .au files. - * - * + * Parses .au files mostly originating from sun os based computers. */ #ifdef HAVE_CONFIG_H diff --git a/gst/avi/gstavidemux.c b/gst/avi/gstavidemux.c index 9170935dd1..cf7b0c1256 100644 --- a/gst/avi/gstavidemux.c +++ b/gst/avi/gstavidemux.c @@ -22,24 +22,19 @@ /** * SECTION:element-avidemux * - * - * * Demuxes an .avi file into raw or compressed audio and/or video streams. - * - * + * * This element supports both push and pull-based scheduling, depending on the * capabilities of the upstream elements. - * + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=test.avi ! avidemux name=demux demux.audio_00 ! decodebin ! audioconvert ! audioresample ! autoaudiosink demux.video_00 ! queue ! decodebin ! ffmpegcolorspace ! videoscale ! autovideosink - * - * Play (parse and decode) an .avi file and try to output it to + * ]| Play (parse and decode) an .avi file and try to output it to * an automatically detected soundcard and videosink. If the AVI file contains * compressed audio or video data, this will only work if you have the * right decoder elements/plugins installed. - * * * * Last reviewed on 2006-12-29 (0.10.6) diff --git a/gst/avi/gstavimux.c b/gst/avi/gstavimux.c index b432c6aa63..e648d3e43f 100644 --- a/gst/avi/gstavimux.c +++ b/gst/avi/gstavimux.c @@ -28,42 +28,32 @@ /** * SECTION:element-avimux * - * - * * Muxes raw or compressed audio and/or video streams into an AVI file. - * - * Example launch line - * - * (write everything in one line, without the backslash characters) - * + * + * + * Example launch lines + * (write everything in one line, without the backslash characters) + * |[ * gst-launch-0.10 videotestsrc num-buffers=250 \ * ! 'video/x-raw-yuv,format=(fourcc)I420,width=320,height=240,framerate=(fraction)25/1' \ * ! queue ! mux. \ * audiotestsrc num-buffers=440 ! audioconvert \ * ! 'audio/x-raw-int,rate=44100,channels=2' ! queue ! mux. \ * avimux name=mux ! filesink location=test.avi - * - * This will create an .AVI file containing an uncompressed video stream + * ]| This will create an .AVI file containing an uncompressed video stream * with a test picture and an uncompressed audio stream containing a * test sound. - * - * Another example launch line - * - * (write everything in one line, without the backslash characters) - * + * |[ * gst-launch-0.10 videotestsrc num-buffers=250 \ * ! 'video/x-raw-yuv,format=(fourcc)I420,width=320,height=240,framerate=(fraction)25/1' \ * ! xvidenc ! queue ! mux. \ * audiotestsrc num-buffers=440 ! audioconvert ! 'audio/x-raw-int,rate=44100,channels=2' \ * ! lame ! queue ! mux. \ * avimux name=mux ! filesink location=test.avi - * - * This will create an .AVI file containing the same test video and sound + * ]| This will create an .AVI file containing the same test video and sound * as above, only that both streams will be compressed this time. This will * only work if you have the necessary encoder elements installed of course. - * * - * */ #ifdef HAVE_CONFIG_H diff --git a/gst/cutter/gstcutter.c b/gst/cutter/gstcutter.c index 9ebf950088..60ce3703c0 100644 --- a/gst/cutter/gstcutter.c +++ b/gst/cutter/gstcutter.c @@ -18,6 +18,37 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-cutter + * + * Analyses the audio signal for periods of silence. The start and end of + * silence is signalled by bus messages named + * "cutter". + * The message's structure contains two fields: + * + * + * + * #GstClockTime + * "timestamp": + * the timestamp of the buffer that triggered the message. + * + * + * + * + * gboolean + * "above": + * %TRUE for begin of silence and %FALSE for end of silence. + * + * + * + * + * + * Example launch line + * |[ + * gst-launch -m filesrc location=foo.ogg ! decodebin ! audioconvert ! cutter ! autoaudiosink + * ]| Show cut messages. + * + */ #ifdef HAVE_CONFIG_H #include "config.h" @@ -82,7 +113,7 @@ static void gst_cutter_get_property (GObject * object, guint prop_id, static GstFlowReturn gst_cutter_chain (GstPad * pad, GstBuffer * buffer); -void gst_cutter_get_caps (GstPad * pad, GstCutter * filter); +static gboolean gst_cutter_get_caps (GstPad * pad, GstCutter * filter); static void gst_cutter_base_init (gpointer g_class) @@ -224,8 +255,10 @@ gst_cutter_chain (GstPad * pad, GstBuffer * buf) g_return_val_if_fail (filter != NULL, GST_FLOW_ERROR); g_return_val_if_fail (GST_IS_CUTTER (filter), GST_FLOW_ERROR); - if (!filter->have_caps) - gst_cutter_get_caps (pad, filter); + if (!filter->have_caps) { + if (!(gst_cutter_get_caps (pad, filter))) + return GST_FLOW_NOT_NEGOTIATED; + } in_data = (gint16 *) GST_BUFFER_DATA (buf); GST_LOG_OBJECT (filter, "length of prerec buffer: %" GST_TIME_FORMAT, @@ -257,12 +290,12 @@ gst_cutter_chain (GstPad * pad, GstBuffer * buf) */ GST_LOG_OBJECT (filter, "buffer stats: NMS %f, RMS %f, audio length %f", NMS, RMS, - gst_guint64_to_gdouble (gst_audio_duration_from_pad_buffer (filter-> - sinkpad, buf))); + gst_guint64_to_gdouble (gst_audio_duration_from_pad_buffer + (filter->sinkpad, buf))); if (RMS < filter->threshold_level) filter->silent_run_length += - gst_guint64_to_gdouble (gst_audio_duration_from_pad_buffer (filter-> - sinkpad, buf)); + gst_guint64_to_gdouble (gst_audio_duration_from_pad_buffer + (filter->sinkpad, buf)); else { filter->silent_run_length = 0 * GST_SECOND; filter->silent = FALSE; @@ -306,15 +339,15 @@ gst_cutter_chain (GstPad * pad, GstBuffer * buf) if (filter->silent) { filter->pre_buffer = g_list_append (filter->pre_buffer, buf); filter->pre_run_length += - gst_guint64_to_gdouble (gst_audio_duration_from_pad_buffer (filter-> - sinkpad, buf)); + gst_guint64_to_gdouble (gst_audio_duration_from_pad_buffer + (filter->sinkpad, buf)); while (filter->pre_run_length > filter->pre_length) { prebuf = (g_list_first (filter->pre_buffer))->data; g_assert (GST_IS_BUFFER (prebuf)); filter->pre_buffer = g_list_remove (filter->pre_buffer, prebuf); filter->pre_run_length -= - gst_guint64_to_gdouble (gst_audio_duration_from_pad_buffer (filter-> - sinkpad, prebuf)); + gst_guint64_to_gdouble (gst_audio_duration_from_pad_buffer + (filter->sinkpad, prebuf)); /* only pass buffers if we don't leak */ if (!filter->leaky) gst_pad_push (filter->srcpad, prebuf); @@ -327,6 +360,28 @@ gst_cutter_chain (GstPad * pad, GstBuffer * buf) return GST_FLOW_OK; } + +static gboolean +gst_cutter_get_caps (GstPad * pad, GstCutter * filter) +{ + GstCaps *caps; + GstStructure *structure; + + caps = gst_pad_get_caps (pad); + if (!caps) { + GST_INFO ("no caps on pad %s:%s", GST_DEBUG_PAD_NAME (pad)); + return FALSE; + } + structure = gst_caps_get_structure (caps, 0); + gst_structure_get_int (structure, "width", &filter->width); + filter->max_sample = 1 << (filter->width - 1); /* signed */ + filter->have_caps = TRUE; + + gst_caps_unref (caps); + return TRUE; +} + + static void gst_cutter_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec) @@ -414,21 +469,3 @@ GST_PLUGIN_DEFINE (GST_VERSION_MAJOR, "cutter", "Audio Cutter to split audio into non-silent bits", plugin_init, VERSION, "LGPL", GST_PACKAGE_NAME, GST_PACKAGE_ORIGIN); - - -void -gst_cutter_get_caps (GstPad * pad, GstCutter * filter) -{ - GstCaps *caps; - GstStructure *structure; - - caps = gst_pad_get_caps (pad); - /* FIXME : Please change this to a better warning method ! */ - g_assert (caps != NULL); - structure = gst_caps_get_structure (caps, 0); - gst_structure_get_int (structure, "width", &filter->width); - filter->max_sample = 1 << (filter->width - 1); /* signed */ - filter->have_caps = TRUE; - - gst_caps_unref (caps); -} diff --git a/gst/debug/gstpushfilesrc.c b/gst/debug/gstpushfilesrc.c index 7ef5259c17..47daa83e1b 100644 --- a/gst/debug/gstpushfilesrc.c +++ b/gst/debug/gstpushfilesrc.c @@ -19,26 +19,21 @@ /** * SECTION:element-pushfilesrc - * @short_description: Works like a filesrc, but only push-based (for debugging) * @see_also: filesrc * - * - * * This element is only useful for debugging purposes. It implements an URI * protocol handler for the 'pushfile' protocol and behaves like a file source * element that cannot be activated in pull-mode. This makes it very easy to * debug demuxers or decoders that can operate both pull and push-based in * connection with the playbin element (which creates a source based on the * URI passed). - * + * + * * Example launch line - * - * + * |[ * gst-launch -m playbin uri=pushfile:///home/you/some/file.ogg - * - * This plays back the given file using playbin, with the demuxer operating + * ]| This plays back the given file using playbin, with the demuxer operating * push-based. - * * */ @@ -156,6 +151,7 @@ gst_push_file_src_uri_get_type (void) { return GST_URI_SRC; } + static gchar ** gst_push_file_src_uri_get_protocols (void) { @@ -163,6 +159,7 @@ gst_push_file_src_uri_get_protocols (void) return protocols; } + static const gchar * gst_push_file_src_uri_get_uri (GstURIHandler * handler) { diff --git a/gst/debug/gsttaginject.c b/gst/debug/gsttaginject.c index 840aa2a402..3429fb147f 100644 --- a/gst/debug/gsttaginject.c +++ b/gst/debug/gsttaginject.c @@ -23,12 +23,16 @@ * * Element that injects new metadata tags, but passes incomming data through * unmodified. + * + * + * Example launch lines * |[ * gst-launch audiotestsrc num-buffers=100 ! taginject tags="title=testsrc,artist=gstreamer" ! vorbisenc ! oggmux ! filesink location=test.ogg * ]| set title and artist * |[ * gst-launch audiotestsrc num-buffers=100 ! taginject tags="keywords=\"testone,audio\",title=\"audio testtone\"" ! vorbisenc ! oggmux ! filesink location=test.ogg * ]| set keywords and title demonstrating quoting of special chars + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/debug/progressreport.c b/gst/debug/progressreport.c index e79f6fd939..8f2547b38d 100644 --- a/gst/debug/progressreport.c +++ b/gst/debug/progressreport.c @@ -22,32 +22,26 @@ /** * SECTION:element-progressreport - * @short_description: Reports progress - * @see_also: * - * - * * The progressreport element can be put into a pipeline to report progress, * which is done by doing upstream duration and position queries in regular * (real-time) intervals. Both the interval and the prefered query format - * can be specified via the "update-freq" and the "format" property. - * - * + * can be specified via the #GstProgressReport:update-freq and the + * #GstProgressReport:format property. + * * Element messages containing a "progress" structure are posted on the bus * whenever progress has been queried (since gst-plugins-good 0.10.6 only). - * - * + * * Since the element was originally designed for debugging purposes, it will * by default also print information about the current progress to the - * terminal. This can be prevented by setting the "silent" property to TRUE. - * - * + * terminal. This can be prevented by setting the #GstProgressReport:silent + * property to %TRUE. + * * This element is most useful in transcoding pipelines or other situations * where just querying the pipeline might not lead to the wanted result. For * progress in TIME format, the element is best placed in a 'raw stream' * section of the pipeline (or after any demuxers/decoders/parsers). - * - * + * * Three more things should be pointed out: firstly, the element will only * query progress when data flow happens. If data flow is stalled for some * reason, no progress messages will be posted. Secondly, there are other @@ -58,20 +52,15 @@ * take action when they receive an EOS message (since the progress reported * is in reference to an internal point of a pipeline and not the pipeline as * a whole). - * + * + * * Example launch line - * - * + * |[ * gst-launch -m filesrc location=foo.ogg ! decodebin ! progressreport update-freq=1 ! audioconvert ! audioresample ! autoaudiosink - * - * This shows a progress query where a duration is available. - * - * - * + * ]| This shows a progress query where a duration is available. + * |[ * gst-launch -m audiotestsrc ! progressreport update-freq=1 ! audioconvert ! autoaudiosink - * - * This shows a progress query where no duration is available. - * + * ]| This shows a progress query where no duration is available. * */ diff --git a/gst/equalizer/gstiirequalizer10bands.c b/gst/equalizer/gstiirequalizer10bands.c index 833c80699e..e56bf19eee 100644 --- a/gst/equalizer/gstiirequalizer10bands.c +++ b/gst/equalizer/gstiirequalizer10bands.c @@ -19,20 +19,15 @@ /** * SECTION:element-equalizer-10bands - * @short_description: 10-band equalizer * - * - * * The 10 band equalizer element allows to change the gain of 10 equally distributed * frequency bands between 30 Hz and 15 kHz. - * + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=song.ogg ! oggdemux ! vorbisdec ! audioconvert ! equalizer-10bands band2=3.0 ! alsasink - * - * This raises the volume of the 3rd band which is at 119 Hz by 3 db. - * + * ]| This raises the volume of the 3rd band which is at 119 Hz by 3 db. * */ diff --git a/gst/equalizer/gstiirequalizer3bands.c b/gst/equalizer/gstiirequalizer3bands.c index c550f78688..91129525ce 100644 --- a/gst/equalizer/gstiirequalizer3bands.c +++ b/gst/equalizer/gstiirequalizer3bands.c @@ -19,20 +19,15 @@ /** * SECTION:element-equalizer-3bands - * @short_description: 3-band equalizer * - * - * * The 3-band equalizer element allows to change the gain of a low frequency, * medium frequency and high frequency band. - * + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=song.ogg ! oggdemux ! vorbisdec ! audioconvert ! equalizer-3bands band1=6.0 ! alsasink - * - * This raises the volume of the 2nd band, which is at 1110 Hz, by 6 db. - * + * ]| This raises the volume of the 2nd band, which is at 1110 Hz, by 6 db. * */ diff --git a/gst/equalizer/gstiirequalizernbands.c b/gst/equalizer/gstiirequalizernbands.c index 316cd02977..e2af57efef 100644 --- a/gst/equalizer/gstiirequalizernbands.c +++ b/gst/equalizer/gstiirequalizernbands.c @@ -20,67 +20,59 @@ /** * SECTION:element-equalizer-nbands - * @short_description: Fully parametric N-band equalizer * - * - * * The n-band equalizer element is a fully parametric equalizer. It allows to * select between 1 and 64 bands and has properties on each band to change * the center frequency, band width and gain. - * + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=song.ogg ! oggdemux ! vorbisdec ! audioconvert ! equalizer-nbands num-bands=15 band5::gain=6.0 ! alsasink - * - * This make the equalizer use 15 bands and raises the volume of the 5th band by 6 db. - * + * ]| This make the equalizer use 15 bands and raises the volume of the 5th band by 6 db. + * + * * Example code - * - * - -#include <gst/gst.h> - -... -typedef struct { - gfloat freq; - gfloat width; - gfloat gain; -} GstEqualizerBandState; - -... - - GstElement *equalizer; - GstObject *band; - gint i; - GstEqualizerBandState state[] = { - { 120.0, 50.0, - 3.0}, - { 500.0, 20.0, 12.0}, - {1503.0, 2.0, -20.0}, - {6000.0, 1000.0, 6.0}, - {3000.0, 120.0, 2.0} - }; - -... - - - equalizer = gst_element_factory_make ("equalizer-nbands", "equalizer"); - g_object_set (G_OBJECT (equalizer), "num-bands", 5, NULL); - -... - - for (i = 0; i < 5; i++) { - band = gst_child_proxy_get_child_by_index (GST_CHILD_PROXY (equalizer), i); - g_object_set (G_OBJECT (band), "freq", state[i].freq, - "bandwidth", state[i].width, - "gain", state[i].gain); - g_object_unref (G_OBJECT (band)); - } - -... - - * - * + * |[ + * #include <gst/gst.h> + * + * ... + * typedef struct { + * gfloat freq; + * gfloat width; + * gfloat gain; + * } GstEqualizerBandState; + * + * ... + * + * GstElement *equalizer; + * GstObject *band; + * gint i; + * GstEqualizerBandState state[] = { + * { 120.0, 50.0, - 3.0}, + * { 500.0, 20.0, 12.0}, + * {1503.0, 2.0, -20.0}, + * {6000.0, 1000.0, 6.0}, + * {3000.0, 120.0, 2.0} + * }; + * + * ... + * + * equalizer = gst_element_factory_make ("equalizer-nbands", "equalizer"); + * g_object_set (G_OBJECT (equalizer), "num-bands", 5, NULL); + * + * ... + * + * for (i = 0; i < 5; i++) { + * band = gst_child_proxy_get_child_by_index (GST_CHILD_PROXY (equalizer), i); + * g_object_set (G_OBJECT (band), "freq", state[i].freq, + * "bandwidth", state[i].width, + * "gain", state[i].gain); + * g_object_unref (G_OBJECT (band)); + * } + * + * ... + * ]| * */ diff --git a/gst/flx/gstflxdec.c b/gst/flx/gstflxdec.c index 6f9cb7fee5..8e93e98cd9 100644 --- a/gst/flx/gstflxdec.c +++ b/gst/flx/gstflxdec.c @@ -19,10 +19,7 @@ /** * SECTION:element-flxdec * - * - * * This element decodes fli/flc/flx-video into raw video - * */ /* * http://www.coolutils.com/Formats/FLI diff --git a/gst/goom/gstgoom.c b/gst/goom/gstgoom.c index 287d177ac7..4c40c1b3d6 100644 --- a/gst/goom/gstgoom.c +++ b/gst/goom/gstgoom.c @@ -22,17 +22,14 @@ * SECTION:element-goom * @see_also: synaesthesia * - * - * * Goom is an audio visualisation element. It creates warping structures * based on the incoming audio signal. - * + * + * * Example launch line - * - * + * |[ * gst-launch -v audiotestsrc ! goom ! ffmpegcolorspace ! xvimagesink - * - * + * ]| * */ diff --git a/gst/goom2k1/gstgoom.c b/gst/goom2k1/gstgoom.c index bc6da3cebf..d01a88627a 100644 --- a/gst/goom2k1/gstgoom.c +++ b/gst/goom2k1/gstgoom.c @@ -22,18 +22,15 @@ * SECTION:element-goom2k1 * @see_also: goom, synaesthesia * - * - * * Goom2k1 is an audio visualisation element. It creates warping structures * based on the incomming audio signal. Goom2k1 is the older version of the * visualisation. Also available is goom2k4, with a different look. - * + * + * * Example launch line - * - * + * |[ * gst-launch -v audiotestsrc ! goom2k1 ! ffmpegcolorspace ! xvimagesink - * - * + * ]| * */ diff --git a/gst/icydemux/gsticydemux.c b/gst/icydemux/gsticydemux.c index 8ea4d1a5f7..234f3f8009 100644 --- a/gst/icydemux/gsticydemux.c +++ b/gst/icydemux/gsticydemux.c @@ -21,27 +21,21 @@ /** * SECTION:element-icydemux - * @short_description: reads tag information from an Icy (Icecast/Shoutcast) - * stream, outputting them as tag messages, and forwarding the enclosed data. * - * - * * icydemux accepts data streams with ICY metadata at known intervals, as * transmitted from an upstream element (usually read as response headers from * an HTTP stream). The mime type of the data between the tag blocks is * detected using typefind functions, and the appropriate output mime type set * on outgoing buffers. - * + * + * * Example launch line - * - * + * |[ * gst-launch souphttpsrc location=http://some.server/ iradio-mode=true ! icydemux ! fakesink -t - * - * This pipeline should read any available ICY tag information and output it. + * ]| This pipeline should read any available ICY tag information and output it. * The contents of the stream should be detected, and the appropriate mime * type set on buffers produced from icydemux. (Using gnomevfssrc, neonhttpsrc * or giosrc instead of souphttpsrc should also work.) - * * */ #ifdef HAVE_CONFIG_H diff --git a/gst/id3demux/gstid3demux.c b/gst/id3demux/gstid3demux.c index 14713756e7..3e7a2b735c 100644 --- a/gst/id3demux/gstid3demux.c +++ b/gst/id3demux/gstid3demux.c @@ -21,23 +21,28 @@ /** * SECTION:element-id3demux - * @short_description: reads tag information from ID3v1 and ID3v2 (<= 2.4.0) data blocks and outputs them as GStreamer tag messages and events. + * + * id3demux accepts data streams with either (or both) ID3v2 regions at the + * start, or ID3v1 at the end. The mime type of the data between the tag blocks + * is detected using typefind functions, and the appropriate output mime type + * set on outgoing buffers. + * + * The element is only able to read ID3v1 tags from a seekable stream, because + * they are at the end of the stream. That is, when get_range mode is supported + * by the upstream elements. If get_range operation is available, id3demux makes + * it available downstream. This means that elements which require get_range + * mode, such as wavparse, can operate on files containing ID3 tag information. + * + * This id3demux element replaced an older element with the same name which + * relied on libid3tag from the MAD project. * * - * - * id3demux accepts data streams with either (or both) ID3v2 regions at the start, or ID3v1 at the end. The mime type of the data between the tag blocks is detected using typefind functions, and the appropriate output mime type set on outgoing buffers. - * - * The element is only able to read ID3v1 tags from a seekable stream, because they are at the end of the stream. That is, when get_range mode is supported by the upstream elements. If get_range operation is available, id3demux makes it available downstream. This means that elements which require get_range mode, such as wavparse, can operate on files containing ID3 tag information. - * * Example launch line - * - * + * |[ * gst-launch filesrc location=file.mp3 ! id3demux ! fakesink -t - * - * This pipeline should read any available ID3 tag information and output it. The contents of the file inside the ID3 tag regions should be detected, and the appropriate mime type set on buffers produced from id3demux. - * - * This id3demux element replaced an older element with the same name which relied on libid3tag from the MAD project. - * + * ]| This pipeline should read any available ID3 tag information and output it. + * The contents of the file inside the ID3 tag regions should be detected, and + * the appropriate mime type set on buffers produced from id3demux. * */ #ifdef HAVE_CONFIG_H diff --git a/gst/law/alaw-decode.c b/gst/law/alaw-decode.c index 6db91cfd8b..9b990f7e1c 100644 --- a/gst/law/alaw-decode.c +++ b/gst/law/alaw-decode.c @@ -16,6 +16,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-alawdec + * + * This element decodes alaw audio. Alaw coding is also known as G.711. + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/law/alaw-encode.c b/gst/law/alaw-encode.c index 0a025fa292..ba8587a2d4 100644 --- a/gst/law/alaw-encode.c +++ b/gst/law/alaw-encode.c @@ -16,6 +16,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-alawenc + * + * This element encode alaw audio. Alaw coding is also known as G.711. + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/law/mulaw-decode.c b/gst/law/mulaw-decode.c index fb40f18bf1..42b208f613 100644 --- a/gst/law/mulaw-decode.c +++ b/gst/law/mulaw-decode.c @@ -16,6 +16,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-mulawdec + * + * This element decodes mulaw audio. Mulaw coding is also known as G.711. + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/law/mulaw-encode.c b/gst/law/mulaw-encode.c index c8c8c054ce..f60e0b2e09 100644 --- a/gst/law/mulaw-encode.c +++ b/gst/law/mulaw-encode.c @@ -16,6 +16,11 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ +/** + * SECTION:element-mulawenc + * + * This element encode mulaw audio. Mulaw coding is also known as G.711. + */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/law/mulaw.c b/gst/law/mulaw.c index 8945a1012f..3317e58fa2 100644 --- a/gst/law/mulaw.c +++ b/gst/law/mulaw.c @@ -1,3 +1,21 @@ +/* GStreamer PCM/A-Law conversions + * + * 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.1 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. + */ + #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/level/gstlevel.c b/gst/level/gstlevel.c index d4bdc4e0af..bf4d9628c8 100644 --- a/gst/level/gstlevel.c +++ b/gst/level/gstlevel.c @@ -21,10 +21,7 @@ /** * SECTION:element-level - * @short_description: audio level analyzer * - * - * * Level analyses incoming audio buffers and, if the #GstLevel:message property * is #TRUE, generates an element message named * "level": @@ -95,11 +92,12 @@ * * * - * + * + * * Example application - * - * - * + * |[ + * + * ]| * */ diff --git a/gst/monoscope/gstmonoscope.c b/gst/monoscope/gstmonoscope.c index 5612e6e113..9cefea895c 100644 --- a/gst/monoscope/gstmonoscope.c +++ b/gst/monoscope/gstmonoscope.c @@ -23,17 +23,14 @@ * SECTION:element-monoscope * @see_also: goom * - * - * * Monoscope is an audio visualisation element. It creates a coloured * curve of the audio signal like on an oscilloscope. - * + * + * * Example launch line - * - * + * |[ * gst-launch -v audiotestsrc ! audioconvert ! monoscope ! ffmpegcolorspace ! ximagesink - * - * + * ]| * */ diff --git a/gst/multifile/gstmultifilesink.c b/gst/multifile/gstmultifilesink.c index 583b989c59..5edb3cd7f0 100644 --- a/gst/multifile/gstmultifilesink.c +++ b/gst/multifile/gstmultifilesink.c @@ -23,13 +23,9 @@ */ /** * SECTION:element-multifilesink - * @short_description: Writes buffers to sequentially-named files * @see_also: #GstFileSrc * - * * Write incoming data to a series of sequentially-named files. - * - * */ #ifdef HAVE_CONFIG_H @@ -154,6 +150,7 @@ gst_multi_file_sink_set_location (GstMultiFileSink * sink, return TRUE; } + static void gst_multi_file_sink_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec) diff --git a/gst/multifile/gstmultifilesrc.c b/gst/multifile/gstmultifilesrc.c index ee39c56524..f6b55ac6b5 100644 --- a/gst/multifile/gstmultifilesrc.c +++ b/gst/multifile/gstmultifilesrc.c @@ -20,29 +20,23 @@ */ /** * SECTION:element-multifilesrc - * @short_description: Read buffers from sequentially-named files * @see_also: #GstFileSrc * - * - * * Reads buffers from sequentially named files. If used together with an image - * decoder, one needs to use the GstMultiFileSrc::caps property or a capsfilter + * decoder, one needs to use the #GstMultiFileSrc:caps property or a capsfilter * to force to caps containing a framerate. Otherwise image decoders send EOS * after the first picture. - * + * + * File names are created by replacing "%%d" with the index using printf(). + * + * * Example launch line - * - * + * |[ * gst-launch multifilesrc location="img.%04d.png" index=0 caps="image/png,framerate=\(fraction\)12/1" ! \ * pngdec ! ffmpegcolorspace ! theoraenc ! oggmux ! \ * filesink location="images.ogg" - * - * This pipeline creates a video file "images.ogg" by joining multiple PNG + * ]| This pipeline creates a video file "images.ogg" by joining multiple PNG * files named img.0000.png, img.0001.png, etc. - * - * - * File names are created by replacing "%%d" with the index using printf(). - * * */ @@ -232,6 +226,7 @@ gst_multi_file_src_set_location (GstMultiFileSrc * src, const gchar * location) return TRUE; } + static void gst_multi_file_src_set_property (GObject * object, guint prop_id, const GValue * value, GParamSpec * pspec) diff --git a/gst/multipart/multipartdemux.c b/gst/multipart/multipartdemux.c index 3d0cfd72de..8a6be44347 100644 --- a/gst/multipart/multipartdemux.c +++ b/gst/multipart/multipartdemux.c @@ -22,34 +22,27 @@ /** * SECTION:element-multipartdemux - * @short_description: Demuxer that takes a multipart digital stream as input - * and demuxes one or many digital streams from it. * @see_also: #GstMultipartMux * - * - * * MultipartDemux uses the Content-type field of incoming buffers to demux and * push data to dynamic source pads. Most of the time multipart streams are * sequential JPEG frames generated from a live source such as a network source * or a camera. - * + * + * The output buffers of the multipartdemux typically have no timestamps and are + * usually played as fast as possible (at the rate that the source provides the + * data). + * + * the content in multipart files is separated with a boundary string that can + * be configured specifically with the #GstMultipartDemux:boundary property + * otherwise it will be autodetected. + * + * * Sample pipelines - * - * Here is a simple pipeline to demux a multipart file muxed with - * #GstMultipartMux containing JPEG frames: - * + * |[ * gst-launch filesrc location=/tmp/test.multipart ! multipartdemux ! jpegdec ! ffmpegcolorspace ! ximagesink - * - * - * - * The output buffers of the multipartdemux typically have no timestamps and are usually - * played as fast as possible (at the rate that the source provides the data). - * - * - * the content in multipart files is separated with a boundary string that can be - * configured specifically with the "boundary" property otherwise it will be - * autodetected. - * + * ]| a simple pipeline to demux a multipart file muxed with #GstMultipartMux + * containing JPEG frames. * */ diff --git a/gst/multipart/multipartmux.c b/gst/multipart/multipartmux.c index 45bc4bd7e0..c1916a96db 100644 --- a/gst/multipart/multipartmux.c +++ b/gst/multipart/multipartmux.c @@ -19,23 +19,17 @@ /** * SECTION:element-multipartmux - * @short_description: Muxer that takes one or several digital streams - * and muxes them to a single multipart stream. * - * - * * MultipartMux uses the #GstCaps of the sink pad as the Content-type field for * incoming buffers when muxing them to a multipart stream. Most of the time * multipart streams are sequential JPEG frames. - * + * + * * Sample pipelines - * - * Here is a simple pipeline to mux 5 JPEG frames per second into a multipart - * stream stored to a file : - * + * |[ * gst-launch videotestsrc ! video/x-raw-yuv, framerate=(fraction)5/1 ! jpegenc ! multipartmux ! filesink location=/tmp/test.multipart - * - * + * ]| a simple pipeline to mux 5 JPEG frames per second into a multipart stream + * stored to a file. * */ diff --git a/gst/qtdemux/qtdemux.c b/gst/qtdemux/qtdemux.c index 3994b734d6..540168d9f8 100644 --- a/gst/qtdemux/qtdemux.c +++ b/gst/qtdemux/qtdemux.c @@ -23,24 +23,19 @@ /** * SECTION:element-qtdemux * - * - * * Demuxes a .mov file into raw or compressed audio and/or video streams. - * - * + * * This element supports both push and pull-based scheduling, depending on the * capabilities of the upstream elements. - * + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=test.mov ! qtdemux name=demux demux.audio_00 ! decodebin ! audioconvert ! audioresample ! autoaudiosink demux.video_00 ! queue ! decodebin ! ffmpegcolorspace ! videoscale ! autovideosink - * - * Play (parse and decode) a .mov file and try to output it to + * ]| Play (parse and decode) a .mov file and try to output it to * an automatically detected soundcard and videosink. If the MOV file contains * compressed audio or video data, this will only work if you have the * right decoder elements/plugins installed. - * * * * Last reviewed on 2006-12-29 (0.10.5) diff --git a/gst/rtp/gstrtpjpegpay.c b/gst/rtp/gstrtpjpegpay.c index 1810eff8d9..0de0ac0f9e 100644 --- a/gst/rtp/gstrtpjpegpay.c +++ b/gst/rtp/gstrtpjpegpay.c @@ -21,7 +21,6 @@ /** * SECTION:rtpjpegpay - * @short_description: RTP payloader for JPEG pictures * * Payload encode JPEG pictures into RTP packets according to RFC 2435. * For detailed information see: http://www.rfc-editor.org/rfc/rfc2435.txt @@ -31,7 +30,6 @@ * the actual JPEG entropy scan. * * The payloader assumes that correct width and height is found in the caps. - * */ #ifdef HAVE_CONFIG_H @@ -74,7 +72,7 @@ GST_STATIC_PAD_TEMPLATE ("src", GST_DEBUG_CATEGORY_STATIC (rtpjpegpay_debug); #define GST_CAT_DEFAULT (rtpjpegpay_debug) -/** +/* * QUANT_PREFIX_LEN: * * Prefix length in the header before the quantization tables: @@ -82,13 +80,13 @@ GST_DEBUG_CATEGORY_STATIC (rtpjpegpay_debug); */ #define QUANT_PREFIX_LEN 3 -/** +/* * DEFAULT_JPEG_QUALITY: * */ #define DEFAULT_JPEG_QUALITY 255 -/** +/* * DEFAULT_JPEG_TYPE: * */ @@ -96,7 +94,7 @@ GST_DEBUG_CATEGORY_STATIC (rtpjpegpay_debug); typedef enum _RtpJpegMarker RtpJpegMarker; -/** +/* * RtpJpegMarker: * @JPEG_MARKER: Prefix for JPEG marker * @JPEG_MARKER_SOI: Start of Image marker @@ -140,7 +138,7 @@ enum typedef struct _RtpJpegHeader RtpJpegHeader; typedef struct _RtpQuantHeader RtpQuantHeader; -/** +/* * RtpJpegHeader: * @type_spec: type specific * @offset: fragment offset @@ -172,7 +170,7 @@ struct _RtpJpegHeader guint8 height; }; -/** +/* * RtpQuantHeader * @mbz: must be zero * @precision: specify size of quantization tables diff --git a/gst/rtsp/gstrtpdec.c b/gst/rtsp/gstrtpdec.c index 0adfc7aa57..c6a942e4e8 100644 --- a/gst/rtsp/gstrtpdec.c +++ b/gst/rtsp/gstrtpdec.c @@ -44,11 +44,7 @@ /** * SECTION:element-rtpdec * - * - * * A simple RTP session manager used internally by rtspsrc. - * - * * * Last reviewed on 2006-06-20 (0.10.4) */ @@ -252,8 +248,8 @@ gst_rtp_dec_marshal_BOXED__UINT_UINT (GClosure * closure, data2 = closure->data; } callback = - (GMarshalFunc_BOXED__UINT_UINT) (marshal_data ? marshal_data : cc-> - callback); + (GMarshalFunc_BOXED__UINT_UINT) (marshal_data ? marshal_data : + cc->callback); v_return = callback (data1, g_marshal_value_peek_uint (param_values + 1), @@ -285,8 +281,8 @@ gst_rtp_dec_marshal_VOID__UINT_UINT (GClosure * closure, data2 = closure->data; } callback = - (GMarshalFunc_VOID__UINT_UINT) (marshal_data ? marshal_data : cc-> - callback); + (GMarshalFunc_VOID__UINT_UINT) (marshal_data ? marshal_data : + cc->callback); callback (data1, g_marshal_value_peek_uint (param_values + 1), diff --git a/gst/rtsp/gstrtspsrc.c b/gst/rtsp/gstrtspsrc.c index 79455cd178..e677c9918f 100644 --- a/gst/rtsp/gstrtspsrc.c +++ b/gst/rtsp/gstrtspsrc.c @@ -43,43 +43,36 @@ /** * SECTION:element-rtspsrc * - * - * * Makes a connection to an RTSP server and read the data. * rtspsrc strictly follows RFC 2326 and therefore does not (yet) support * RealMedia/Quicktime/Microsoft extensions. - * - * + * * RTSP supports transport over TCP or UDP in unicast or multicast mode. By * default rtspsrc will negotiate a connection in the following order: * UDP unicast/UDP multicast/TCP. The order cannot be changed but the allowed - * protocols can be controlled with the "protocols" property. - * - * + * protocols can be controlled with the #GstRTSPSrc:protocols property. + * * rtspsrc currently understands SDP as the format of the session description. * For each stream listed in the SDP a new rtp_stream%d pad will be created * with caps derived from the SDP media description. This is a caps of mime type * "application/x-rtp" that can be connected to any available RTP depayloader * element. - * - * + * * rtspsrc will internally instantiate an RTP session manager element * that will handle the RTCP messages to and from the server, jitter removal, * packet reordering along with providing a clock for the pipeline. * This feature is currently fully implemented with the gstrtpbin in the * gst-plugins-bad module. - * - * + * * rtspsrc acts like a live source and will therefore only generate data in the * PLAYING state. - * + * + * * Example launch line - * - * + * |[ * gst-launch rtspsrc location=rtsp://some.server/url ! fakesink - * - * Establish a connection to an RTSP server and send the raw RTP packets to a fakesink. - * + * ]| Establish a connection to an RTSP server and send the raw RTP packets to a + * fakesink. * * * Last reviewed on 2006-08-18 (0.10.5) diff --git a/gst/smpte/gstsmpte.c b/gst/smpte/gstsmpte.c index 91f6c2f8e9..5a1a0871b4 100644 --- a/gst/smpte/gstsmpte.c +++ b/gst/smpte/gstsmpte.c @@ -19,31 +19,23 @@ /** * SECTION:element-smpte - * @short_description: Takes to video frames and applies an SMPTE transition - * effect on them. * - * - * * smpte can accept I420 video streams with the same width, height and * framerate. The two incomming buffers are blended together using an effect * specific alpha mask. - * - * - * The depth property defines the presision in bits of the mask. A higher - * presision will create a mask with smoother gradients in order to avoid + * + * The #GstSmpte:depth property defines the presision in bits of the mask. A + * higher presision will create a mask with smoother gradients in order to avoid * banding. - * + * + * * Sample pipelines - * - * Here is a pipeline to demonstrate the smpte transition : - * - * gst-launch -v videotestsrc pattern=1 ! smpte name=s border=20000 type=234 - * duration=2000000000 ! ffmpegcolorspace ! ximagesink videotestsrc ! s. - * - * This shows a pinwheel transition a from a snow videotestsrc to an smpte + * |[ + * gst-launch -v videotestsrc pattern=1 ! smpte name=s border=20000 type=234 duration=2000000000 ! ffmpegcolorspace ! ximagesink videotestsrc ! s. + * ]| A pipeline to demonstrate the smpte transition. + * It shows a pinwheel transition a from a snow videotestsrc to an smpte * pattern videotestsrc. The transition will take 2 seconds to complete. The * edges of the transition are smoothed with a 20000 big border. - * * */ @@ -491,8 +483,8 @@ gst_smpte_collected (GstCollectPads * pads, GstSMPTE * smpte) GstCaps *caps; caps = - gst_caps_copy (gst_static_caps_get (&gst_smpte_src_template. - static_caps)); + gst_caps_copy (gst_static_caps_get + (&gst_smpte_src_template.static_caps)); gst_caps_set_simple (caps, "width", G_TYPE_INT, smpte->width, "height", G_TYPE_INT, smpte->height, "framerate", GST_TYPE_FRACTION, smpte->fps_num, smpte->fps_denom, NULL); diff --git a/gst/smpte/gstsmptealpha.c b/gst/smpte/gstsmptealpha.c index 95c8b24588..74f27ba29f 100644 --- a/gst/smpte/gstsmptealpha.c +++ b/gst/smpte/gstsmptealpha.c @@ -19,26 +19,21 @@ /** * SECTION:element-smptealpha - * @short_description: Takes a video frames and applies an SMPTE transition - * effect on it in the alpha channel. + * + * smptealpha can accept an I420 or AYUV video stream. An alpha channel is added + * using an effect specific SMPTE mask in the I420 input case. In the AYUV case, + * the alpha channel is modified using the effect specific SMPTE mask. + * + * The #GstSmpteAlpha:position property is a controllabe double between 0.0 and + * 1.0 that specifies the position in the transition. 0.0 is the start of the + * transition with the alpha channel to complete opaque where 1.0 has the alpha + * channel set to completely transparent. + * + * The #GstSmpteAlpha:depth property defines the precision in bits of the mask. + * A higher presision will create a mask with smoother gradients in order to + * avoid banding. * * - * - * smptealpha can accept an I420 or AYUV video stream. An alpha channel is added - * using an effect specific SMPTE mask in the I420 input case. In the AYUV case, the - * alpha channel is modified using the effect specific SMPTE mask. - * - * - * The "position" property is a controllabe double between 0.0 and 1.0 that - * specifies the position in the transition. 0.0 is the start of the transition - * with the alpha channel to complete opaque where 1.0 has the alpha channel set - * to completely transparent. - * - * - * The depth property defines the precision in bits of the mask. A higher - * presision will create a mask with smoother gradients in order to avoid - * banding. - * * Sample pipelines * * Here is a pipeline to demonstrate the smpte transition : @@ -432,6 +427,7 @@ gst_smpte_alpha_do_ayuv (GstSMPTEAlpha * smpte, guint8 * in, guint8 * out, } } } + static void gst_smpte_alpha_do_i420 (GstSMPTEAlpha * smpte, guint8 * in, guint8 * out, GstMask * mask, gint width, gint height, gint border, gint pos) diff --git a/gst/spectrum/gstspectrum.c b/gst/spectrum/gstspectrum.c index 15d3592e42..63675c1770 100644 --- a/gst/spectrum/gstspectrum.c +++ b/gst/spectrum/gstspectrum.c @@ -20,17 +20,13 @@ */ /** * SECTION:element-spectrum - * @short_description: audio spectrum analyzer * - * - * * The Spectrum element analyzes the frequency spectrum of an audio signal. * If the #GstSpectrum:message property is #TRUE, it sends analysis results as * application messages named * "spectrum" after each interval of time given * by the #GstSpectrum:interval property. - * - * + * * The message's structure contains some combination of these fields: * * @@ -87,19 +83,15 @@ * * * - * - * - * This element cannot be used with the gst-launch command in a sensible way. - * This sample code demonstrates how to use it in an application. - * + * + * * Example application - * - * - * - * - * Last reviewed on 2009-01-14 (0.10.12) - * + * |[ + * + * ]| * + * + * Last reviewed on 2009-01-14 (0.10.12) */ #ifdef HAVE_CONFIG_H diff --git a/gst/udp/gstmultiudpsink.c b/gst/udp/gstmultiudpsink.c index 9483483bad..a4821ffe39 100644 --- a/gst/udp/gstmultiudpsink.c +++ b/gst/udp/gstmultiudpsink.c @@ -21,13 +21,9 @@ * SECTION:element-multiupdsink * @see_also: udpsink, multifdsink * - * - * * multiudpsink is a network sink that sends UDP packets to multiple * clients. * It can be combined with rtp payload encoders to implement RTP streaming. - * - * */ #ifdef HAVE_CONFIG_H diff --git a/gst/udp/gstudpsink.c b/gst/udp/gstudpsink.c index f808c3b51b..a9666ed077 100644 --- a/gst/udp/gstudpsink.c +++ b/gst/udp/gstudpsink.c @@ -16,7 +16,20 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ - +/** + * SECTION:element-udpsink + * @see_also: udpsrc, multifdsink + * + * udpsink is a network sink that sends UDP packets to the network. + * It can be combined with RTP payloaders to implement RTP streaming. + * + * + * Examples + * |[ + * gst-launch -v audiotestsrc ! udpsink + * ]| + * + */ #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/udp/gstudpsrc.c b/gst/udp/gstudpsrc.c index b16a0521c6..0da694610a 100644 --- a/gst/udp/gstudpsrc.c +++ b/gst/udp/gstudpsrc.c @@ -22,72 +22,46 @@ * SECTION:element-udpsrc * @see_also: udpsink, multifdsink * - * - * * udpsrc is a network source that reads UDP packets from the network. * It can be combined with RTP depayloaders to implement RTP streaming. - * - * Examples - * - * Here is a simple pipeline to read from the default port and dump the udp packets. - * - * gst-launch -v udpsrc ! fakesink dump=1 - * - * To actually generate udp packets on the default port one can use the - * udpsink element. When running the following pipeline in another terminal, the - * above mentioned pipeline should dump data packets to the console. - * - * gst-launch -v audiotestsrc ! udpsink - * - * - * + * * The udpsrc element supports automatic port allocation by setting the - * "port" property to 0. the following pipeline reads UDP from a free port. - * - * gst-launch -v udpsrc port=0 ! fakesink - * - * After setting the udpsrc to PAUSED, the allocated port can be obtained by - * reading the port property. - * - * - * udpsrc can read from multicast groups by setting the multicast_group property - * to the IP address of the multicast group. - * - * - * Alternatively one can provide a custom socket to udpsrc with the "sockfd" property, - * udpsrc will then not allocate a socket itself but use the provided one. - * - * - * The "caps" property is mainly used to give a type to the UDP packet so that they - * can be autoplugged in GStreamer pipelines. This is very usefull for RTP - * implementations where the contents of the UDP packets is transfered out-of-bounds - * using SDP or other means. - * - * - * The "buffer" property is used to change the default kernel buffer sizes used for - * receiving packets. The buffer size may be increased for high-volume connections, - * or may be decreased to limit the possible backlog of incoming data. - * The system places an absolute limit on these values, on Linux, for example, the - * default buffer size is typically 50K and can be increased to maximally 100K. - * - * - * The "skip-first-bytes" property is used to strip off an arbitrary number of - * bytes from the start of the raw udp packet and can be used to strip off - * proprietary header, for example. - * - * - * The udpsrc is always a live source. It does however not provide a GstClock, this - * is left for upstream elements such as an RTP session manager or demuxer (such - * as an MPEG demuxer). As with all live sources, the captured buffers will have - * their timestamp set to the current running time of the pipeline. - * - * - * udpsrc implements a GstURIHandler interface that handles udp://host:port type - * URIs. - * - * - * If the timeout property is set to a - * value bigger than 0, udpsrc will generate an element message named + * #GstUDPSrc:port property to 0. After setting the udpsrc to PAUSED, the + * allocated port can be obtained by reading the port property. + * + * udpsrc can read from multicast groups by setting the #GstUDPSrc:multicast_group + * property to the IP address of the multicast group. + * + * Alternatively one can provide a custom socket to udpsrc with the #GstUDPSrc:sockfd + * property, udpsrc will then not allocate a socket itself but use the provided + * one. + * + * The #GstUDPSrc:caps property is mainly used to give a type to the UDP packet + * so that they can be autoplugged in GStreamer pipelines. This is very usefull + * for RTP implementations where the contents of the UDP packets is transfered + * out-of-bounds using SDP or other means. + * + * The #GstUDPSrc:buffer property is used to change the default kernel buffer + * sizes used for receiving packets. The buffer size may be increased for + * high-volume connections, or may be decreased to limit the possible backlog of + * incoming data. The system places an absolute limit on these values, on Linux, + * for example, the default buffer size is typically 50K and can be increased to + * maximally 100K. + * + * The #GstUDPSrc:skip-first-bytes property is used to strip off an arbitrary + * number of bytes from the start of the raw udp packet and can be used to strip + * off proprietary header, for example. + * + * The udpsrc is always a live source. It does however not provide a #GstClock, + * this is left for upstream elements such as an RTP session manager or demuxer + * (such as an MPEG demuxer). As with all live sources, the captured buffers + * will have their timestamp set to the current running time of the pipeline. + * + * udpsrc implements a #GstURIHandler interface that handles udp://host:port + * type URIs. + * + * If the #GstUDPSrc:timeout property is set to a value bigger than 0, udpsrc + * will generate an element message named * "GstUDPSrcTimeout" * if no data was recieved in the given timeout. * The message's structure contains one field: @@ -105,15 +79,28 @@ * * * A custom file descriptor can be configured with the - * sockfd property. The socket will be - * closed when setting the element to READY by default. This behaviour can be - * overriden with the closefd property, - * in which case the application is responsible for closing the file descriptor. - * - * - * Last reviewed on 2007-09-20 (0.10.7) - * + * #GstUDPSrc:sockfd property. The socket will be closed when setting the + * element to READY by default. This behaviour can be + * overriden with the #GstUDPSrc:closefd property, in which case the application + * is responsible for closing the file descriptor. + * + * + * Examples + * |[ + * gst-launch -v udpsrc ! fakesink dump=1 + * ]| A pipeline to read from the default port and dump the udp packets. + * To actually generate udp packets on the default port one can use the + * udpsink element. When running the following pipeline in another terminal, the + * above mentioned pipeline should dump data packets to the console. + * |[ + * gst-launch -v audiotestsrc ! udpsink + * ]| + * |[ + * gst-launch -v udpsrc port=0 ! fakesink + * ]| read udp packets from a free port. * + * + * Last reviewed on 2007-09-20 (0.10.7) */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/videobox/gstvideobox.c b/gst/videobox/gstvideobox.c index 0e6e112c26..c515634d6a 100644 --- a/gst/videobox/gstvideobox.c +++ b/gst/videobox/gstvideobox.c @@ -16,7 +16,25 @@ * Free Software Foundation, Inc., 59 Temple Place - Suite 330, * Boston, MA 02111-1307, USA. */ - +/** + * SECTION:element-videobox + * @see_also: #GstVideoCrop + * + * This plugin crops or enlarges the image. It takes 4 values as input, a + * top, bottom, left and right offset. Positive values will crop that much + * pixels from the respective border of the image, negative values will add + * that much pixels. When pixels are added, you can specify their color. + * Some predefined colors are usable with an enum property. + * + * The plugin is alpha channel aware and will try to negotiate with a format + * that supports alpha channels first. When alpha channel is active two + * other properties, alpha and border_alpha can be used to set the alpha + * values of the inner picture and the border respectively. an alpha value of + * 0.0 means total transparency, 1.0 is opaque. + * + * The videobox plugin has many uses such as doing a mosaic of pictures, + * letterboxing video, cutting out pieces of video, picture in picture, etc.. + */ #ifdef HAVE_CONFIG_H #include "config.h" #endif @@ -1147,6 +1165,7 @@ invalid_format: } } +/* FIXME: 0.11 merge with videocrop plugin */ static gboolean plugin_init (GstPlugin * plugin) { diff --git a/gst/videocrop/gstaspectratiocrop.c b/gst/videocrop/gstaspectratiocrop.c index 28ca397b44..cd59323ad5 100644 --- a/gst/videocrop/gstaspectratiocrop.c +++ b/gst/videocrop/gstaspectratiocrop.c @@ -21,14 +21,16 @@ * SECTION:element-aspectratiocrop * @see_also: #GstVideoCrop * - * This element crops video frames to a specified aspect-ratio. + * This element crops video frames to a specified #GstAspectRatioCrop:aspect-ratio. * - * If the aspect-ratio is already correct, the element will operate in pass-through mode. + * If the aspect-ratio is already correct, the element will operate + * in pass-through mode. * * * Example launch line - * |[gst-launch -v videotestsrc ! video/x-raw-rgb,height=640,width=480 ! aspectratiocrop aspect-ratio=16/9 ! ximagesink]| - * This pipeline generates a videostream in 4/3 and crops it to 16/9. + * |[ + * gst-launch -v videotestsrc ! video/x-raw-rgb,height=640,width=480 ! aspectratiocrop aspect-ratio=16/9 ! ximagesink + * ]| This pipeline generates a videostream in 4/3 and crops it to 16/9. * */ diff --git a/gst/videocrop/gstvideocrop.c b/gst/videocrop/gstvideocrop.c index 0d0ebfedb4..607d92483f 100644 --- a/gst/videocrop/gstvideocrop.c +++ b/gst/videocrop/gstvideocrop.c @@ -21,35 +21,29 @@ * SECTION:element-videocrop * @see_also: #GstVideoBox * - * - * * This element crops video frames, meaning it can remove parts of the * picture on the left, right, top or bottom of the picture and output * a smaller picture than the input picture, with the unwanted parts at the * border removed. - * - * + * * The videocrop element is similar to the videobox element, but its main * goal is to support a multitude of formats as efficiently as possible. * Unlike videbox, it cannot add borders to the picture and unlike videbox * it will always output images in exactly the same format as the input image. - * - * + * * If there is nothing to crop, the element will operate in pass-through mode. - * - * + * * Note that no special efforts are made to handle chroma-subsampled formats * in the case of odd-valued cropping and compensate for sub-unit chroma plane - * shifts for such formats in the case where the "left" or "top" property is - * set to an odd number. This doesn't matter for most use cases, but it might - * matter for yours. - * + * shifts for such formats in the case where the #GstVideoCrop:left or + * #GstVideoCrop:top property is set to an odd number. This doesn't matter for + * most use cases, but it might matter for yours. + * + * * Example launch line - * - * + * |[ * gst-launch -v videotestsrc ! videocrop top=42 left=1 right=4 bottom=0 ! ximagesink - * - * + * ]| * */ diff --git a/gst/videofilter/gstgamma.c b/gst/videofilter/gstgamma.c index b1342687fd..e94de1832a 100644 --- a/gst/videofilter/gstgamma.c +++ b/gst/videofilter/gstgamma.c @@ -30,17 +30,13 @@ /** * SECTION:element-gamma * - * - * * Performs gamma correction on a video stream. - * + * + * * Example launch line - * - * + * |[ * gst-launch videotestsrc ! gamma gamma=2.0 ! ffmpegcolorspace ! ximagesink - * - * This pipeline will make the image "brighter". - * + * ]| This pipeline will make the image "brighter". * */ diff --git a/gst/videofilter/gstvideobalance.c b/gst/videofilter/gstvideobalance.c index 2464ee055d..80b503df83 100644 --- a/gst/videofilter/gstvideobalance.c +++ b/gst/videofilter/gstvideobalance.c @@ -26,17 +26,14 @@ /** * SECTION:element-videobalance * - * - * * Adjusts brightness, contrast, hue, saturation on a video stream. - * + * + * * Example launch line - * - * + * |[ * gst-launch videotestsrc ! videobalance saturation=0.0 ! ffmpegcolorspace ! ximagesink - * - * This pipeline converts the image to black and white by setting the saturation to 0.0. - * + * ]| This pipeline converts the image to black and white by setting the + * saturation to 0.0. * * * Last reviewed on 2006-03-03 (0.10.3) diff --git a/gst/videofilter/gstvideoflip.c b/gst/videofilter/gstvideoflip.c index 336e053870..051805c5aa 100644 --- a/gst/videofilter/gstvideoflip.c +++ b/gst/videofilter/gstvideoflip.c @@ -25,17 +25,13 @@ /** * SECTION:element-videoflip * - * - * * Flips and rotates video. - * + * + * * Example launch line - * - * + * |[ * gst-launch videotestsrc ! videoflip method=clockwise ! ffmpegcolorspace ! ximagesink - * - * This pipeline flips the test image 90 degrees clockwise. - * + * ]| This pipeline flips the test image 90 degrees clockwise. * * * Last reviewed on 2006-03-03 (0.10.3) diff --git a/gst/videomixer/videomixer.c b/gst/videomixer/videomixer.c index 46dc582960..00572b23f6 100644 --- a/gst/videomixer/videomixer.c +++ b/gst/videomixer/videomixer.c @@ -19,33 +19,26 @@ /** * SECTION:element-videomixer - * @short_description: Takes several AYUV video streams as input and mixes them - * together. * - * - * * Videomixer can only accept AYUV video streams. For each of the requested * sink pads it will compare the incoming geometry and framerate to define the * output parameters. Indeed output video frames will have the geometry of the * biggest incoming video stream and the framerate of the fastest incoming one. - * - * + * * Individual parameters for each input stream can be configured on the * #GstVideoMixerPad. - * + * + * * Sample pipelines - * - * Here is a pipeline to demonstrate videomixer used together with videobox : - * + * |[ * gst-launch videotestsrc pattern=1 ! video/x-raw-yuv, framerate=\(fraction\)10/1, width=100, height=100 ! videobox border-alpha=0 alpha=0.5 top=-70 bottom=-70 right=-220 ! videomixer name=mix ! ffmpegcolorspace ! xvimagesink videotestsrc ! video/x-raw-yuv, framerate=\(fraction\)5/1, width=320, height=240 ! alpha alpha=0.7 ! mix. - * + * ]| A pipeline to demonstrate videomixer used together with videobox. * This should show a 320x240 pixels video test source with some transparency * showing the background checker pattern. Another video test source with just * the snow pattern of 100x100 pixels is overlayed on top of the first one on * the left vertically centered with a small transparency showing the first * video test source behind and the checker pattern under it. Note that the * framerate of the output video is 10 frames per second. - * * */ diff --git a/gst/wavenc/gstwavenc.c b/gst/wavenc/gstwavenc.c index d563b7b1af..aa988fd83e 100644 --- a/gst/wavenc/gstwavenc.c +++ b/gst/wavenc/gstwavenc.c @@ -19,7 +19,12 @@ * Boston, MA 02111-1307, USA. * */ - +/** + * SECTION:element-wavenc + * + * Format a audio stream into the wav format. + * + */ #ifdef HAVE_CONFIG_H #include "config.h" #endif diff --git a/gst/wavparse/gstwavparse.c b/gst/wavparse/gstwavparse.c index b2f4980717..266c430fac 100644 --- a/gst/wavparse/gstwavparse.c +++ b/gst/wavparse/gstwavparse.c @@ -22,28 +22,20 @@ /** * SECTION:element-wavparse * - * - * * Parse a .wav file into raw or compressed audio. - * - * + * * Wavparse supports both push and pull mode operations, making it possible to * stream from a network source. - * + * + * * Example launch line - * - * + * |[ * gst-launch filesrc location=sine.wav ! wavparse ! audioconvert ! alsasink - * - * Read a wav file and output to the soundcard using the ALSA element. The + * ]| Read a wav file and output to the soundcard using the ALSA element. The * wav file is assumed to contain raw uncompressed samples. - * - * - * + * |[ * gst-launch gnomevfssrc location=http://www.example.org/sine.wav ! queue ! wavparse ! audioconvert ! alsasink - * - * Stream data from a network url. - * + * ]| Stream data from a network url. * * * Last reviewed on 2007-02-14 (0.10.6) diff --git a/win32/common/config.h b/win32/common/config.h index cd8992ae7c..17299c9933 100644 --- a/win32/common/config.h +++ b/win32/common/config.h @@ -21,7 +21,7 @@ #undef ENABLE_NLS /* gettext package name */ -#define GETTEXT_PACKAGE "gst-plugins-good-0.10" +#define GETTEXT_PACKAGE "NULL" /* PREFIX - specifically added for Windows for easier moving */ #define PREFIX "C:\\gstreamer" @@ -39,7 +39,7 @@ #define GST_PACKAGE_NAME "GStreamer Good Plug-ins CVS/prerelease" /* package origin */ -#define GST_PACKAGE_ORIGIN "Unknown package origin" +#define GST_PACKAGE_ORIGIN "http://gstreamer.freedesktop.org" /* support for features: aasink */ #define HAVE_AALIB @@ -278,4 +278,4 @@ /* Define socklen_t as it seems to be not defined in default VS setup */ #ifndef socklen_t typedef int socklen_t; -#endif +#endif \ No newline at end of file