Menu
▾
▴
[gst-cvs] ensonic gstreamer: gstreamer/ gstreamer/docs/gst/ gstreamer/docs/gst/tmpl/ gstreamer/docs/libs/ gstreamer/docs/libs/tmpl/ gstreamer/docs/manual/ gstreamer/docs/random/ensonic/ gstreamer/gst/
CVS Root: /cvs/gstreamer
Module: gstreamer
Changes by: ensonic
Date: Tue Jan 18 2005 06:15:42 PST
Log message:
added docs for the TAG defines
Modified files:
. : ChangeLog
docs/gst : gstreamer-sections.txt
docs/gst/tmpl : gstplugin.sgml
docs/libs : gstreamer-libs-sections.txt
docs/libs/tmpl : gstcontrol.sgml
docs/manual : basics-plugins.xml
docs/random/ensonic: dparams.txt
gst : gstbuffer.h gsttag.h gstvalue.c
Links:
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/ChangeLog.diff?r1=1.930&r2=1.931
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/gst/gstreamer-sections.txt.diff?r1=1.126&r2=1.127
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/gst/tmpl/gstplugin.sgml.diff?r1=1.39&r2=1.40
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/libs/gstreamer-libs-sections.txt.diff?r1=1.11&r2=1.12
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/libs/tmpl/gstcontrol.sgml.diff?r1=1.4&r2=1.5
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/manual/basics-plugins.xml.diff?r1=1.9&r2=1.10
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/random/ensonic/dparams.txt.diff?r1=1.2&r2=1.3
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/gst/gstbuffer.h.diff?r1=1.78&r2=1.79
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/gst/gsttag.h.diff?r1=1.18&r2=1.19
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/gst/gstvalue.c.diff?r1=1.55&r2=1.56
====Begin Diffs====
Index: ChangeLog
===================================================================
RCS file: /cvs/gstreamer/gstreamer/ChangeLog,v
retrieving revision 1.930
retrieving revision 1.931
diff -u -d -r1.930 -r1.931
--- ChangeLog 18 Jan 2005 11:29:12 -0000 1.930
+++ ChangeLog 18 Jan 2005 14:15:29 -0000 1.931
@@ -1,3 +1,14 @@
+2005-01-18 Stefan Kost <en...@us...>
+
+ * docs/gst/gstreamer-sections.txt:
+ * docs/gst/tmpl/gstplugin.sgml:
+ * docs/libs/gstreamer-libs-sections.txt:
+ * docs/libs/tmpl/gstcontrol.sgml:
+ * gst/gstbuffer.h:
+ * gst/gsttag.h:
+ * gst/gstvalue.c:
+ added docs for the TAG defines
2005-01-18 Ronald S. Bultje <rb...@ro...>
* gst/schedulers/gstoptimalscheduler.c: (schedule_group):
Index: gstreamer-sections.txt
RCS file: /cvs/gstreamer/gstreamer/docs/gst/gstreamer-sections.txt,v
retrieving revision 1.126
retrieving revision 1.127
diff -u -d -r1.126 -r1.127
--- gstreamer-sections.txt 11 Jan 2005 11:25:22 -0000 1.126
+++ gstreamer-sections.txt 18 Jan 2005 14:15:30 -0000 1.127
@@ -20,6 +20,8 @@
gst_has_threads
gst_main
gst_main_quit
+<SUBSECTION Private>
+GstPoptOption
</SECTION>
<SECTION>
Index: gstplugin.sgml
RCS file: /cvs/gstreamer/gstreamer/docs/gst/tmpl/gstplugin.sgml,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -d -r1.39 -r1.40
--- gstplugin.sgml 4 Jan 2005 18:13:51 -0000 1.39
+++ gstplugin.sgml 18 Jan 2005 14:15:30 -0000 1.40
@@ -6,18 +6,19 @@
<!-- ##### SECTION Long_Description ##### -->
<para>
-GStreamer is extensible, so <classname>GstElements</classname> can be loaded at runtime. A plugin
-system can provide one or more of the basic <application>GStreamer</application>
+GStreamer is extensible, so <classname>GstElements</classname> can be loaded at runtime.
+A plugin system can provide one or more of the basic <application>GStreamer</application>
#GstPluginFeature subclasses.
</para>
-A plugin should export a symbol <symbol>plugin_desc</symbol> that is a struct of type #GstPluginDesc.
+A plugin should export a symbol <symbol>plugin_desc</symbol> that is a struct of type #GstPluginDesc.
the plugin loader will check the version of the core library the plugin was linked against
and will create a new #GstPlugin. It will then call the #GstPluginInitFunc function
that was provided in the plugin_desc.
-Once you have a handle to a #GstPlugin, you can add any object that subclasses #GstPluginFeature.
+Once you have a handle to a #GstPlugin (e.g. from the #GstRegistryPool), you can
+add any object that subclasses #GstPluginFeature.
Use gst_plugin_find_feature() and gst_plugin_get_feature_list() to find features in a plugin.
Index: gstreamer-libs-sections.txt
RCS file: /cvs/gstreamer/gstreamer/docs/libs/gstreamer-libs-sections.txt,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -d -r1.11 -r1.12
--- gstreamer-libs-sections.txt 28 Jul 2004 14:39:43 -0000 1.11
+++ gstreamer-libs-sections.txt 18 Jan 2005 14:15:30 -0000 1.12
@@ -127,6 +127,7 @@
<INCLUDE>libs/control/control.h</INCLUDE>
gst_control_init
<SUBSECTION Dynamic Parameter Manager>
+GstDParamManager
gst_dpman_new
gst_dpman_add_required_dparam_callback
gst_dpman_add_required_dparam_direct
@@ -145,6 +146,7 @@
gst_dpman_get_manager
gst_dpman_bypass_dparam
<SUBSECTION Dynamic Parameters>
+GstDParam
gst_dparam_new
gst_dparam_attach
gst_dparam_detach
Index: gstcontrol.sgml
RCS file: /cvs/gstreamer/gstreamer/docs/libs/tmpl/gstcontrol.sgml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- gstcontrol.sgml 28 Jul 2004 14:39:43 -0000 1.4
+++ gstcontrol.sgml 18 Jan 2005 14:15:30 -0000 1.5
@@ -42,6 +42,20 @@
@argv:
+<!-- ##### STRUCT GstDParamManager ##### -->
+<para>
+</para>
+<!-- ##### SIGNAL GstDParamManager::new-required-dparam ##### -->
+@gstdparammanager: the object which received the signal.
+@arg1:
<!-- ##### FUNCTION gst_dpman_new ##### -->
@@ -220,6 +234,39 @@
@dparam_name:
+<!-- ##### STRUCT GstDParam ##### -->
+<!-- ##### SIGNAL GstDParam::value-changed ##### -->
+@gstdparam: the object which received the signal.
+<!-- ##### ARG GstDParam:value-double ##### -->
+<!-- ##### ARG GstDParam:value-float ##### -->
+<!-- ##### ARG GstDParam:value-int ##### -->
+<!-- ##### ARG GstDParam:value-int64 ##### -->
<!-- ##### FUNCTION gst_dparam_new ##### -->
Index: basics-plugins.xml
RCS file: /cvs/gstreamer/gstreamer/docs/manual/basics-plugins.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- basics-plugins.xml 15 Dec 2004 17:32:49 -0000 1.9
+++ basics-plugins.xml 18 Jan 2005 14:15:30 -0000 1.10
@@ -66,12 +66,13 @@
<para>
You can query a <classname>GList</classname> of available plugins with the
- function <function>gst_plugin_get_list</function> as this example shows:
+ function <function>gst_registry_pool_plugin_list</function> as this example
+ shows:
</para>
<programlisting>
GList *plugins;
- plugins = gst_plugin_get_list ();
+ plugins = gst_registry_pool_plugin_list ();
while (plugins) {
GstPlugin *plugin = (GstPlugin *)plugins->data;
Index: dparams.txt
RCS file: /cvs/gstreamer/gstreamer/docs/random/ensonic/dparams.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- dparams.txt 21 Jul 2004 11:32:09 -0000 1.2
+++ dparams.txt 18 Jan 2005 14:15:30 -0000 1.3
@@ -18,4 +18,10 @@
* state of unitconvert
* state of sychronous params
-* concept for global, voice params
+* dparams ng
+ * concept for global, voice params
+ one plugin instance can repeate the processing for the same input, but with
+ different parameter sets (sound synthesizers, effects)
+ * based on gobject params, so that e.g. the GUI can connect to "notify:param"
+ events and update the GUI
Index: gstbuffer.h
RCS file: /cvs/gstreamer/gstreamer/gst/gstbuffer.h,v
retrieving revision 1.78
retrieving revision 1.79
diff -u -d -r1.78 -r1.79
--- gstbuffer.h 12 Aug 2004 10:56:40 -0000 1.78
+++ gstbuffer.h 18 Jan 2005 14:15:30 -0000 1.79
@@ -84,7 +84,8 @@
* @GST_BUFFER_KEY_UNIT: the buffer holds a key unit, a unit that can be
* decoded independently of other buffers.
* This flag has been deprecated, see #GST_BUFFER_DELTA_UNIT.
- * @GST_BUFFER_DONTKEEP:
+ * @GST_BUFFER_DONTKEEP: the buffer should not be ref()ed, but copied instead
+ * before doing anything with it (for specially allocated hw buffers and such)
* @GST_BUFFER_IN_CAPS: the buffer has been added as a field in a #GstCaps.
* @GST_BUFFER_DELTA_UNIT: this unit cannot be decoded independently.
* Since 0.8.5
@@ -98,7 +99,7 @@
GST_BUFFER_ORIGINAL,
GST_BUFFER_DONTFREE,
GST_BUFFER_KEY_UNIT, /* deprecated, use reverse DELTA_UNIT */
- GST_BUFFER_DONTKEEP,
+ GST_BUFFER_DONTKEEP, /* FIXME: is this deprecated ? there is no reference in gstreamer, gst-plugins */
GST_BUFFER_IN_CAPS,
GST_BUFFER_DELTA_UNIT, /* this unit depends on a previous unit */
GST_BUFFER_FLAG_LAST = GST_DATA_FLAG_LAST + 8
Index: gsttag.h
RCS file: /cvs/gstreamer/gstreamer/gst/gsttag.h,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -r1.18 -r1.19
--- gsttag.h 13 Apr 2004 02:22:02 -0000 1.18
+++ gsttag.h 18 Jan 2005 14:15:30 -0000 1.19
@@ -226,39 +226,209 @@
/* GStreamer core tags (need to be discussed) */
+/**
+ * GST_TAG_TITLE:
+ *
+ * commonly used title
+ */
#define GST_TAG_TITLE "title"
+ * GST_TAG_ARTIST:
+ * person(s) responsible for the recording
#define GST_TAG_ARTIST "artist"
+ * GST_TAG_ALBUM:
+ * album containing this data
#define GST_TAG_ALBUM "album"
+ * GST_TAG_DATE:
+ * date the data was created (in Julian calendar days)
#define GST_TAG_DATE "date"
+ * GST_TAG_GENRE:
+ * genre this data belongs to
#define GST_TAG_GENRE "genre"
+ * GST_TAG_COMMENT:
+ * free text commenting the data
#define GST_TAG_COMMENT "comment"
+ * GST_TAG_TRACK_NUMBER:
+ * track number inside a collection
#define GST_TAG_TRACK_NUMBER "track-number"
+ * GST_TAG_TRACK_COUNT:
+ * count of tracks inside collection this track belongs to
#define GST_TAG_TRACK_COUNT "track-count"
+ * GST_TAG_ALBUM_VOLUME_NUMBER:
+ * disc number inside a collection
#define GST_TAG_ALBUM_VOLUME_NUMBER "album-disc-number"
+ * GST_TAG_ALBUM_VOLUME_COUNT:
+ * count of discs inside collection this disc belongs to
#define GST_TAG_ALBUM_VOLUME_COUNT "album-disc-count"
+ * GST_TAG_LOCATION:
+ * original location of file as a URI
#define GST_TAG_LOCATION "location"
+ * GST_TAG_DESCRIPTION:
+ * short text describing the content of the data
#define GST_TAG_DESCRIPTION "description"
+ * GST_TAG_VERSION:
+ * version of this data
#define GST_TAG_VERSION "version"
+ * GST_TAG_ISRC:
+ * International Standard Recording Code - see http://www.ifpi.org/isrc/
#define GST_TAG_ISRC "isrc"
+ * GST_TAG_ORGANIZATION:
+ * organization
#define GST_TAG_ORGANIZATION "organization"
+ * GST_TAG_COPYRIGHT:
+ * copyright notice of the data
#define GST_TAG_COPYRIGHT "copyright"
+ * GST_TAG_CONTACT:
+ * contact information
#define GST_TAG_CONTACT "contact"
+ * GST_TAG_LICENSE:
+ * license of data
#define GST_TAG_LICENSE "license"
+ * GST_TAG_PERFORMER:
+ * person(s) performing
#define GST_TAG_PERFORMER "performer"
+ * GST_TAG_DURATION:
+ * length in GStreamer time units (nanoseconds)
#define GST_TAG_DURATION "duration"
+ * GST_TAG_CODEC:
+ * codec the data is stored in
#define GST_TAG_CODEC "codec"
+ * GST_TAG_VIDEO_CODEC:
+ * codec the video data is stored in
#define GST_TAG_VIDEO_CODEC "video-codec"
+ * GST_TAG_AUDIO_CODEC:
+ * codec the audio data is stored in
#define GST_TAG_AUDIO_CODEC "audio-codec"
+ * GST_TAG_BITRATE:
+ * exact or average bitrate in bits/s
#define GST_TAG_BITRATE "bitrate"
+ * GST_TAG_NOMINAL_BITRATE:
+ * nominal bitrate in bits/s
#define GST_TAG_NOMINAL_BITRATE "nominal-bitrate"
+ * GST_TAG_MINIMUM_BITRATE:
+ * minimum bitrate in bits/s
#define GST_TAG_MINIMUM_BITRATE "minimum-bitrate"
+ * GST_TAG_MAXIMUM_BITRATE:
+ * maximum bitrate in bits/s
#define GST_TAG_MAXIMUM_BITRATE "maximum-bitrate"
+ * GST_TAG_SERIAL:
+ * serial number of track
#define GST_TAG_SERIAL "serial"
+ * GST_TAG_ENCODER:
+ * encoder used to encode this stream
#define GST_TAG_ENCODER "encoder"
+ * GST_TAG_ENCODER_VERSION:
+ * version of the encoder used to encode this stream
#define GST_TAG_ENCODER_VERSION "encoder-version"
+ * GST_TAG_TRACK_GAIN:
+ * track gain in db
#define GST_TAG_TRACK_GAIN "replaygain-track-gain"
+ * GST_TAG_TRACK_PEAK:
+ * peak of the track
#define GST_TAG_TRACK_PEAK "replaygain-track-peak"
+ * GST_TAG_ALBUM_GAIN:
+ * album gain in db
#define GST_TAG_ALBUM_GAIN "replaygain-album-gain"
+ * GST_TAG_ALBUM_PEAK:
+ * peak of the album
#define GST_TAG_ALBUM_PEAK "replaygain-album-peak"
G_END_DECLS
Index: gstvalue.c
RCS file: /cvs/gstreamer/gstreamer/gst/gstvalue.c,v
retrieving revision 1.55
retrieving revision 1.56
diff -u -d -r1.55 -r1.56
--- gstvalue.c 6 Jan 2005 00:45:04 -0000 1.55
+++ gstvalue.c 18 Jan 2005 14:15:30 -0000 1.56
@@ -2037,7 +2037,7 @@
* type, or if there is a method (registered by
* #gst_value_register_intersection_func) to calculate the intersection.
*
- * Returns:
+ * Returns: TRUE if the values can intersect
*/
gboolean
gst_value_can_intersect (const GValue * value1, const GValue * value2)
|