ensonic gstreamer: gstreamer/ gstreamer/gst/

CVS Root:       /cvs/gstreamer
Module:         gstreamer
Changes by:     ensonic
Date:           Tue Dec 16 2008  07:07:50 UTC

Log message:
	* gst/gsttaglist.h:
	* gst/gsttagsetter.c:
	  Update GstTagSetter and GstTagMergeMode documentation. Mention
	  that tags can come from events and from application. Fix example.

Modified files:
    .               : ChangeLog
    gst             : gsttaglist.h gsttagsetter.c

Links:
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/ChangeLog.diff?r1=1.4193&r2=1.4194
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/gst/gsttaglist.h.diff?r1=1.52&r2=1.53
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/gst/gsttagsetter.c.diff?r1=1.24&r2=1.25

====Begin Diffs====
Index: ChangeLog
===================================================================
RCS file: /cvs/gstreamer/gstreamer/ChangeLog,v
retrieving revision 1.4193
retrieving revision 1.4194
diff -u -d -r1.4193 -r1.4194
--- ChangeLog	15 Dec 2008 15:27:03 -0000	1.4193
+++ ChangeLog	16 Dec 2008 07:07:33 -0000	1.4194
@@ -1,3 +1,10 @@
+2008-12-15  Stefan Kost  <[email protected]>
+
+	* gst/gsttaglist.h:
+	* gst/gsttagsetter.c:
+	  Update GstTagSetter and GstTagMergeMode documentation. Mention
+	  that tags can come from events and from application. Fix example.
 2008-12-15  Wim Taymans  <[email protected]>
 
 	* docs/design/part-TODO.txt:
Index: gsttaglist.h
RCS file: /cvs/gstreamer/gstreamer/gst/gsttaglist.h,v
retrieving revision 1.52
retrieving revision 1.53
diff -u -d -r1.52 -r1.53
--- gsttaglist.h	3 Sep 2008 05:52:40 -0000	1.52
+++ gsttaglist.h	16 Dec 2008 07:07:36 -0000	1.53
@@ -40,11 +40,12 @@
  * @GST_TAG_MERGE_COUNT: the number of merge modes
  *
  * The different tag merging modes are basically replace, overwrite and append,
- * but they can be seen from two directions.  Given two taglists: (A) the tags
- * already in the element and (B) the ones that are supplied to
- * gst_tag_setter_merge_tags() or gst_tag_setter_add_tags(), how are these tags
- * merged? In the table below this is shown for the cases that a tag exists in
- * the list (A) or does not exists (!A) and combinations thereof.
+ * but they can be seen from two directions. Given two taglists: (A) the tags
+ * already in the element and (B) the ones that are supplied to the element (
+ * e.g. via gst_tag_setter_merge_tags() / gst_tag_setter_add_tags() or a
+ * %GST_EVENT_TAG), how are these tags merged?
+ * In the table below this is shown for the cases that a tag exists in the list
+ * (A) or does not exists (!A) and combinations thereof.
  * <table frame="all" colsep="1" rowsep="1">
  *   <title>merge mode</title>
Index: gsttagsetter.c
RCS file: /cvs/gstreamer/gstreamer/gst/gsttagsetter.c,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -d -r1.24 -r1.25
--- gsttagsetter.c	13 Apr 2008 19:58:43 -0000	1.24
+++ gsttagsetter.c	16 Dec 2008 07:07:36 -0000	1.25
@@ -24,30 +24,26 @@
  * @short_description: Element interface that allows setting and retrieval
  *                     of media metadata
- * <refsect2>
- * <para>
  * Element interface that allows setting of media metadata.
- * </para>
+ *
  * Elements that support changing a stream's metadata will implement this
  * interface. Examples of such elements are 'vorbisenc', 'theoraenc' and
  * 'id3v2mux'.
+ * 
  * If you just want to retrieve metadata in your application then all you
  * need to do is watch for tag messages on your pipeline's bus. This
  * interface is only for setting metadata, not for extracting it. To set tags
  * from the application, find tagsetter elements and set tags using e.g.
- * gst_tag_setter_merge_tags() or gst_tag_setter_add_tags(). The application
- * should do that before the element goes to %GST_STATE_PAUSED.
+ * gst_tag_setter_merge_tags() or gst_tag_setter_add_tags(). Also consider
+ * setting the #GstTagMergeMode that is used for tag events that arrive at the
+ * tagsetter element (default mode is to keep existing tags).
+ * The application should do that before the element goes to %GST_STATE_PAUSED.
  * Elements implementing the #GstTagSetter interface often have to merge
  * any tags received from upstream and the tags set by the application via
  * the interface. This can be done like this:
- * <programlisting>
+ * |[
  * GstTagMergeMode merge_mode;
  * const GstTagList *application_tags;
  * const GstTagList *event_tags;
@@ -57,7 +53,7 @@
  * tagsetter = GST_TAG_SETTER (element);
  *  
  * merge_mode = gst_tag_setter_get_tag_merge_mode (tagsetter);
- * tagsetter_tags = gst_tag_setter_get_tag_list (tagsetter);
+ * application_tags = gst_tag_setter_get_tag_list (tagsetter);
  * event_tags = (const GstTagList *) element->event_tags;
  * GST_LOG_OBJECT (tagsetter, "merging tags, merge mode = %d", merge_mode);
@@ -67,12 +63,9 @@
  * result = gst_tag_list_merge (application_tags, event_tags, merge_mode);
  * GST_LOG_OBJECT (tagsetter, "final tags: %" GST_PTR_FORMAT, result);
- * </programlisting>
+ * ]|
  * Last reviewed on 2006-05-18 (0.10.6)
- * </refsect2>
  */
 #ifdef HAVE_CONFIG_H

------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you.  Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/