Menu
▾
▴
[gst-cvs] thomasvs gstreamer: gstreamer/ gstreamer/docs/manual/ gstreamer/docs/pwg/ gstreamer/examples/plugins/
|
From: <tho...@fr...> - 2005-05-17 17:22:45
|
CVS Root: /cvs/gstreamer
Module: gstreamer
Changes by: thomasvs
Date: Tue May 17 2005 10:22:43 PDT
Log message:
small doc fixes
Modified files:
. : ChangeLog
docs/manual : advanced-schedulers.xml appendix-checklist.xml
docs/pwg : advanced-clock.xml advanced-interfaces.xml
advanced-request.xml advanced-types.xml
intro-preface.xml
examples/plugins: example.c example.h
Links:
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/ChangeLog.diff?r1=1.1079&r2=1.1080
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/manual/advanced-schedulers.xml.diff?r1=1.10&r2=1.11
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/manual/appendix-checklist.xml.diff?r1=1.8&r2=1.9
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/pwg/advanced-clock.xml.diff?r1=1.5&r2=1.6
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/pwg/advanced-interfaces.xml.diff?r1=1.11&r2=1.12
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/pwg/advanced-request.xml.diff?r1=1.4&r2=1.5
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/pwg/advanced-types.xml.diff?r1=1.15&r2=1.16
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/pwg/intro-preface.xml.diff?r1=1.10&r2=1.11
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/examples/plugins/example.c.diff?r1=1.29&r2=1.30
http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/examples/plugins/example.h.diff?r1=1.11&r2=1.12
====Begin Diffs====
Index: ChangeLog
===================================================================
RCS file: /cvs/gstreamer/gstreamer/ChangeLog,v
retrieving revision 1.1079
retrieving revision 1.1080
diff -u -d -r1.1079 -r1.1080
--- ChangeLog 17 May 2005 14:11:32 -0000 1.1079
+++ ChangeLog 17 May 2005 17:22:30 -0000 1.1080
@@ -1,3 +1,19 @@
+2005-05-17 Thomas Vander Stichele <thomas at apestaart dot org>
+
+ * docs/manual/advanced-schedulers.xml:
+ * docs/manual/appendix-checklist.xml:
+ * docs/pwg/advanced-clock.xml:
+ * docs/pwg/advanced-interfaces.xml:
+ * docs/pwg/advanced-request.xml:
+ * docs/pwg/advanced-types.xml:
+ * docs/pwg/intro-preface.xml:
+ * examples/plugins/example.c: (gst_example_get_type),
+ (gst_example_class_init), (gst_example_chain),
+ (gst_example_set_property), (gst_example_get_property),
+ (gst_example_change_state), (plugin_init):
+ * examples/plugins/example.h:
+ small doc fixes
2005-05-17 Wim Taymans <wi...@fl...>
* gst/gstpad.c: (gst_pad_accept_caps), (gst_pad_set_caps),
Index: advanced-schedulers.xml
RCS file: /cvs/gstreamer/gstreamer/docs/manual/advanced-schedulers.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- advanced-schedulers.xml 19 Dec 2004 22:54:11 -0000 1.10
+++ advanced-schedulers.xml 17 May 2005 17:22:31 -0000 1.11
@@ -119,7 +119,7 @@
</para>
<para>
The default &GStreamer; scheduler, <quote>opt</quote>, uses a concept
- of chains and groups. A group is a series of elements that can that
+ of chains and groups. A group is a series of elements that
do not require any context switches or intermediate data stores to
be executed. In practice, this implies zero or one loop-based elements,
one get-based element (at the beginning) and an infinite amount of
Index: appendix-checklist.xml
RCS file: /cvs/gstreamer/gstreamer/docs/manual/appendix-checklist.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- appendix-checklist.xml 23 Dec 2004 14:26:14 -0000 1.8
+++ appendix-checklist.xml 17 May 2005 17:22:31 -0000 1.9
@@ -152,7 +152,7 @@
<para>
<command>gst-inspect</command> can be used to inspect all properties,
signals, dynamic parameters and the object hierarchy of an element.
- This acn be very useful to see which <classname>GObject</classname>
+ This can be very useful to see which <classname>GObject</classname>
properties or which signals (and using what arguments) an element
supports. Run <command>gst-inspect fakesrc</command> to get an idea
of what it does. See the manual page of <command>gst-inspect</command>
Index: advanced-clock.xml
RCS file: /cvs/gstreamer/gstreamer/docs/pwg/advanced-clock.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- advanced-clock.xml 28 Aug 2004 14:13:42 -0000 1.5
+++ advanced-clock.xml 17 May 2005 17:22:31 -0000 1.6
@@ -11,7 +11,7 @@
<title> Types of time </title>
- There are kinds of time in GStreamer. <emphasis
+ There are two kinds of time in GStreamer. <emphasis
role="strong">Clock time</emphasis> is an absolute time. By contrast,
<emphasis role="strong">element time</emphasis> is the relative time,
usually to the start of the current media stream. The element time
@@ -99,10 +99,11 @@
<title>Source elements </title>
Source elements (or parsers of formats that provide notion of time, such
- as MPEG, as explained above). must place a timestamp in each buffer that
- they deliver. The origin of the time used is arbitrary, but it must match
- the time delivered in the discontinous event (see bellow). However, it is
- expected that the origin is the origin of the media stream.
+ as MPEG, as explained above) must place a timestamp in each buffer that
+ they deliver. The origin of the time used is arbitrary, but it must
+ match the time delivered in the discontinous event (see below).
+ However, it is expected that the origin is the origin of the media
+ stream.
</para>
In order to initialize the element time of the rest of the pipeline, a
Index: advanced-interfaces.xml
RCS file: /cvs/gstreamer/gstreamer/docs/pwg/advanced-interfaces.xml,v
retrieving revision 1.12
diff -u -d -r1.11 -r1.12
--- advanced-interfaces.xml 14 Dec 2004 23:35:09 -0000 1.11
+++ advanced-interfaces.xml 17 May 2005 17:22:31 -0000 1.12
@@ -457,7 +457,7 @@
enumeration lists and probing. Firstly, enumerations only allow strings
as values; property probing works for any value type. Secondly, the
contents of a probed list of allowed values may change during the life
- of an element. The contents of a enumeraiton list are static. Crrently,
+ of an element. The contents of an enumeration list are static. Currently,
property probing is being used for detection of devices (e.g. for OSS
elements, Video4linux elements, etc.). It could - in theory - be used
for any property, though.
Index: advanced-request.xml
RCS file: /cvs/gstreamer/gstreamer/docs/pwg/advanced-request.xml,v
retrieving revision 1.4
diff -u -d -r1.4 -r1.5
--- advanced-request.xml 29 Jan 2004 17:25:18 -0000 1.4
+++ advanced-request.xml 17 May 2005 17:22:31 -0000 1.5
@@ -6,7 +6,7 @@
the application requests the pad. The first is called a
<emphasis>sometimes</emphasis>; the second is called a
<emphasis>request</emphasis> pad. The availability of a pad (always,
- sometimes or request) can be seen in a pad's template. This chapted will
+ sometimes or request) can be seen in a pad's template. This chapter will
discuss when each of the two is useful, how they are created and when
they should be disposed.
</para>
Index: advanced-types.xml
RCS file: /cvs/gstreamer/gstreamer/docs/pwg/advanced-types.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- advanced-types.xml 31 Jan 2005 15:51:17 -0000 1.15
+++ advanced-types.xml 17 May 2005 17:22:31 -0000 1.16
@@ -158,7 +158,7 @@
types, for the sake of readability. Below each table might follow a
list of notes that apply to that table. In the definition of each type,
we try to follow the types and rules as defined by <ulink type="http"
- url="http://www.isi.edu/in-notes/iana/assignments/media-types/media-types">
+ url="http://www.iana.org/assignmentsmedia-types">
IANA</ulink> for as far as possible.
Index: intro-preface.xml
RCS file: /cvs/gstreamer/gstreamer/docs/pwg/intro-preface.xml,v
--- intro-preface.xml 6 Nov 2004 11:25:35 -0000 1.10
+++ intro-preface.xml 17 May 2005 17:22:31 -0000 1.11
@@ -180,7 +180,7 @@
The last chapter, <xref linkend="chapter-advanced-events"/>, will
discuss the concept of events in &GStreamer;. Events are, on the
one hand, another way of doing application-element interaction. It
- atkes care of seeking, for example. On the other hand, it is also
+ takes care of seeking, for example. On the other hand, it is also
a way in which elements interact with each other, such as letting
each other know about media stream discontinuities, forwarding tags
inside a pipeline and so on.
Index: example.c
RCS file: /cvs/gstreamer/gstreamer/examples/plugins/example.c,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -d -r1.29 -r1.30
--- example.c 15 Mar 2004 19:27:09 -0000 1.29
+++ example.c 17 May 2005 17:22:31 -0000 1.30
@@ -76,7 +76,7 @@
);
-/* A number of functon prototypes are given so we can refer to them later. */
+/* A number of function prototypes are given so we can refer to them later. */
static void gst_example_class_init (GstExampleClass * klass);
static void gst_example_init (GstExample * example);
@@ -120,7 +120,6 @@
0,
(GInstanceInitFunc) gst_example_init,
};
-
example_type =
g_type_register_static (GST_TYPE_ELEMENT, "GstExample", &example_info,
0);
@@ -155,7 +154,7 @@
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_ACTIVE, g_param_spec_int ("active", "active", "active", G_MININT, G_MAXINT, 0, G_PARAM_READWRITE)); /* CHECKME */
- /* Here we add a signal to the object. This is avery useless signal
+ /* Here we add a signal to the object. This is a very useless signal
* called asdf. The signal will also pass a pointer to the listeners
* which happens to be the example element itself */
gst_example_signals[ASDF] =
@@ -238,7 +237,7 @@
g_return_if_fail (GST_IS_PAD (pad));
g_return_if_fail (buf != NULL);
- /* We need to get a pointer to the element this pad belogs to. */
+ /* We need to get a pointer to the element this pad belongs to. */
example = GST_EXAMPLE (gst_pad_get_parent (pad));
/* A few more sanity checks to make sure that the element that owns
@@ -249,7 +248,7 @@
/* If we are supposed to be doing something, here's where it happens. */
if (example->active) {
- /* In this example we're going to copy the buffer to another one,
+ /* In this example we're going to copy the buffer to another one,
* so we need to allocate a new buffer first. */
outbuf = gst_buffer_new ();
@@ -283,8 +282,8 @@
}
}
-/* Arguments are part of the Gtk+ object system, and these functions
- * enable the element to respond to various arguments.
+/* Properties are part of the GLib+ object system, and these functions
+ * enable the element to respond to various properties.
*/
static void
gst_example_set_property (GObject * object, guint prop_id, const GValue * value,
@@ -292,7 +291,6 @@
{
GstExample *example;
- /* It's not null if we got it, but it might not be ours */
g_return_if_fail (GST_IS_EXAMPLE (object));
/* Get a pointer of the right type. */
@@ -321,8 +319,8 @@
example = GST_EXAMPLE (object);
switch (prop_id) {
@@ -352,11 +350,9 @@
* of the element */
switch (GST_STATE_TRANSITION (element)) {
/* The NULL to READY transition is used to
- * create threads (if any) */
+ * create threads (if any), and/or open devices */
case GST_STATE_NULL_TO_READY:
break;
- /* In the READY to PAUSED state, the element should
- * open devices (if any) */
case GST_STATE_READY_TO_PAUSED:
/* In the PAUSED to PLAYING state, the element should
@@ -388,8 +384,8 @@
static gboolean
plugin_init (GstPlugin * plugin)
- /* We need to register each element we provide with the plugin. This consists
- * of the name of the element, a rank that gives the importance of the element
+ /* We need to register each element we provide with the plugin. This consists
+ * of the name of the element, a rank that gives the importance of the element
* when compared to similar plugins and the GType identifier.
if (!gst_element_register (plugin, "example", GST_RANK_MARGINAL,
@@ -419,7 +415,7 @@
"an example plugin", /* a short description of the plugin in English */
plugin_init, /* Pointer to the initialisation function for the plugin. */
"0.1", /* The version number of the plugin */
- "LGPL", /* ieffective license the plugin can be shipped with. Must be
+ "LGPL", /* effective license the plugin can be shipped with. Must be
* valid for all libraries it links to, too. */
"my nifty plugin package",
/* package this plugin belongs to. */
Index: example.h
RCS file: /cvs/gstreamer/gstreamer/examples/plugins/example.h,v
--- example.h 15 Mar 2004 14:43:21 -0000 1.11
+++ example.h 17 May 2005 17:22:31 -0000 1.12
@@ -56,7 +56,7 @@
void (*asdf) (GstElement *element, GstExample *example);
};
-/* Five standard preprocessing macros are used in the Gtk+ object system.
+/* Five standard preprocessing macros are used in the GLib object system.
* The first uses the object's _get_type function to return the GType
* of the object.
|