pwg: several typo fixes

Fixes #609286.
This commit is contained in:
Arun Raghavan 2010-02-08 09:12:01 +05:30 committed by Tim-Philipp Müller
parent 5998e902a3
commit 8d1c45f513
15 changed files with 47 additions and 47 deletions

View file

@ -33,7 +33,7 @@
<para> <para>
As clocks return an absolute measure of time, they are not usually used As clocks return an absolute measure of time, they are not usually used
directly. Instead, a reference to a clock is stored in any element that needs directly. Instead, a reference to a clock is stored in any element that needs
it, and it is used internaly by GStreamer to calculate the element time. it, and it is used internally by GStreamer to calculate the element time.
</para> </para>
</sect1> </sect1>
@ -59,7 +59,7 @@
element will be regarded as the source element for this discussion. element will be regarded as the source element for this discussion.
</para> </para>
</footnote> </footnote>
First, the source element sends a discontinous event. This event carries information First, the source element sends a discontinuous event. This event carries information
about the current relative time of the next sample. This relative time is about the current relative time of the next sample. This relative time is
arbitrary, but it must be consistent with the timestamp that will be arbitrary, but it must be consistent with the timestamp that will be
placed in buffers. It is expected to be the relative time to the start placed in buffers. It is expected to be the relative time to the start
@ -71,7 +71,7 @@
<para> <para>
Then the source element sends media samples in buffers. This element places a Then the source element sends media samples in buffers. This element places a
timestamp in each buffer saying when the sample should be played. When the timestamp in each buffer saying when the sample should be played. When the
buffer reachs the sink pad of the last element, this element compares the buffer reaches the sink pad of the last element, this element compares the
current element time with the timestamp of the buffer. If the timestamp is current element time with the timestamp of the buffer. If the timestamp is
higher or equal it plays the buffer, otherwise it waits until the time to higher or equal it plays the buffer, otherwise it waits until the time to
place the buffer arrives with <function>gst_element_wait()</function>. place the buffer arrives with <function>gst_element_wait()</function>.
@ -81,7 +81,7 @@
<para> <para>
If the stream is seeked, the next samples sent will have a timestamp that If the stream is seeked, the next samples sent will have a timestamp that
is not adjusted with the element time. Therefore, the source element must is not adjusted with the element time. Therefore, the source element must
send a discontinous event. send a discontinuous event.
</para> </para>
</sect1> </sect1>
<sect1 id="section-clock-obligations-of-each-element" xreflabel="Obligations <sect1 id="section-clock-obligations-of-each-element" xreflabel="Obligations
@ -101,14 +101,14 @@
Source elements (or parsers of formats that provide notion of time, such 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 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 they deliver. The origin of the time used is arbitrary, but it must
match the time delivered in the discontinous event (see below). match the time delivered in the discontinuous event (see below).
However, it is expected that the origin is the origin of the media However, it is expected that the origin is the origin of the media
stream. stream.
</para> </para>
<para> <para>
In order to initialize the element time of the rest of the pipeline, a In order to initialize the element time of the rest of the pipeline, a
source element must send a discontinous event before starting to play. source element must send a discontinuous event before starting to play.
In addition, after seeking, a discontinious event must be sent, because In addition, after seeking, a discontinuous event must be sent, because
the timestamp of the next element does not match the element time of the the timestamp of the next element does not match the element time of the
rest of the pipeline. rest of the pipeline.
</para> </para>

View file

@ -6,8 +6,8 @@
<para> <para>
Sometimes object properties are not powerful enough to control the Sometimes object properties are not powerful enough to control the
parameters that affect the behaviour of your element. parameters that affect the behaviour of your element.
When this is the case you can mark these parameters as beeing Controllable. When this is the case you can mark these parameters as being Controllable.
Aware appliations can use the controller subsystem to dynamically adjust Aware applications can use the controller subsystem to dynamically adjust
the property values over time. the property values over time.
</para> </para>
@ -77,7 +77,7 @@
<sect2 id="chapter-dparam-loop-video"> <sect2 id="chapter-dparam-loop-video">
<title>The Data Processing Loop for Video Elements</title> <title>The Data Processing Loop for Video Elements</title>
<para> <para>
For video processing elements it is the best to synchonise for every frame. For video processing elements it is the best to synchronise for every frame.
That means one would add the <function>gst_object_sync_values()</function> That means one would add the <function>gst_object_sync_values()</function>
call described in the previous section to the data processing function of call described in the previous section to the data processing function of
the element. the element.
@ -93,7 +93,7 @@
standard audio it will be 44100 samples. standard audio it will be 44100 samples.
It is rarely useful to synchronise controllable parameters that often. It is rarely useful to synchronise controllable parameters that often.
The easiest solution is also to have just one synchronisation call per The easiest solution is also to have just one synchronisation call per
buffer processing. This makes the control-rate dependend on the buffer buffer processing. This makes the control-rate depend on the buffer
size. size.
</para> </para>
<para> <para>

View file

@ -53,7 +53,7 @@
<sect1 id="section-iface-general" xreflabel="How to Implement Interfaces"> <sect1 id="section-iface-general" xreflabel="How to Implement Interfaces">
<title>How to Implement Interfaces</title> <title>How to Implement Interfaces</title>
<para> <para>
Implementing interfaces is intiated in the <function>_get_type ()</function> Implementing interfaces is initiated in the <function>_get_type ()</function>
of your element. You can register one or more interfaces after having of your element. You can register one or more interfaces after having
registered the type itself. Some interfaces have dependencies on other registered the type itself. Some interfaces have dependencies on other
interfaces or can only be registered by certain types of elements. You interfaces or can only be registered by certain types of elements. You
@ -325,7 +325,7 @@ gst_my_filter_mixer_interface_init (GstMixerClass *iface)
<para> <para>
This interface requires the <ulink type="http" This interface requires the <ulink type="http"
url="../../gstreamer/html/GstImplementsInterface.html"><classname> url="../../gstreamer/html/GstImplementsInterface.html"><classname>
GstImplemensInterface</classname></ulink> GstImplementsInterface</classname></ulink>
interface to work correctly. interface to work correctly.
</para> </para>
<para> <para>
@ -365,7 +365,7 @@ gst_my_filter_get_type (void)
&amp;implements_interface_info); &amp;implements_interface_info);
g_type_add_interface_static (my_filter_type, g_type_add_interface_static (my_filter_type,
GST_TYPE_TUNER, GST_TYPE_TUNER,
&amp;tunerr_interface_info); &amp;tuner_interface_info);
[..] [..]
} }
@ -477,7 +477,7 @@ gst_my_filter_tuner_interface_init (GstTunerClass *iface)
the property to create a <classname>GValueArray</classname>, and one to the property to create a <classname>GValueArray</classname>, and one to
retrieve the current <classname>GValueArray</classname>. Those two are retrieve the current <classname>GValueArray</classname>. Those two are
separated because probing might take a long time (several seconds). Also, separated because probing might take a long time (several seconds). Also,
this simpliies interface implementation in elements. For the application, this simplifies interface implementation in elements. For the application,
there are functions that wrap those two. For more information on this, there are functions that wrap those two. For more information on this,
have a look at the API reference for the have a look at the API reference for the
<!-- FIXME: add link, but this is in ./gst-plugins/gst-libs/gst/propertyprobe/propertyprobe.c--> <!-- FIXME: add link, but this is in ./gst-plugins/gst-libs/gst/propertyprobe/propertyprobe.c-->
@ -624,7 +624,7 @@ gst_my_filter_probe_interface_init (GstPropertyProbeInterface *iface)
An X Overlay is basically a video output in a XFree86 drawable. Elements An X Overlay is basically a video output in a XFree86 drawable. Elements
implementing this interface will draw video in a X11 window. Through this implementing this interface will draw video in a X11 window. Through this
interface, applications will be proposed 2 different modes to work with interface, applications will be proposed 2 different modes to work with
a plugin implemeting it. The first mode is a passive mode where the plugin a plugin implementing it. The first mode is a passive mode where the plugin
owns, creates and destroys the X11 window. The second mode is an active owns, creates and destroys the X11 window. The second mode is an active
mode where the application handles the X11 window creation and then tell mode where the application handles the X11 window creation and then tell
the plugin where it should output video. Let's get a bit deeper in those the plugin where it should output video. Let's get a bit deeper in those

View file

@ -25,7 +25,7 @@
create an output pad for the Vorbis elementary stream and set a create an output pad for the Vorbis elementary stream and set a
Vorbis-caps on it. Lastly, it adds the pad. As of this point, the pad Vorbis-caps on it. Lastly, it adds the pad. As of this point, the pad
is ready to be used to stream data, and so the Ogg demuxer is now done. is ready to be used to stream data, and so the Ogg demuxer is now done.
This pad is <emphasis>not</emphasis> re-negotiatable, since the type of This pad is <emphasis>not</emphasis> re-negotiable, since the type of
the data stream is embedded within the data. the data stream is embedded within the data.
</para> </para>
<para> <para>
@ -58,7 +58,7 @@
<para> <para>
In order for caps negotiation on non-fixed links to work correctly, In order for caps negotiation on non-fixed links to work correctly,
pads can optionally implement a function that tells peer elements what pads can optionally implement a function that tells peer elements what
formats it supports and/or preferes. When upstream renegotiation is formats it supports and/or prefers. When upstream renegotiation is
triggered, this becomes important. triggered, this becomes important.
</para> </para>
<para> <para>
@ -112,7 +112,7 @@
</programlisting> </programlisting>
<para> <para>
Elements that could implement fixed caps (on their source pads) are, Elements that could implement fixed caps (on their source pads) are,
in general, all elements that are not renegotiatable. Examples include: in general, all elements that are not renegotiable. Examples include:
</para> </para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -125,14 +125,14 @@
<para> <para>
Pretty much all demuxers, since the contained elementary data Pretty much all demuxers, since the contained elementary data
streams are defined in the file headers, and thus not streams are defined in the file headers, and thus not
renegotiatable. renegotiable.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Some decoders, where the format is embedded in the data stream Some decoders, where the format is embedded in the data stream
and not part of the peercaps <emphasis>and</emphasis> where the and not part of the peercaps <emphasis>and</emphasis> where the
decoder itself is not reconfigureable, too. decoder itself is not reconfigurable, too.
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -316,7 +316,7 @@ gst_my_filter_chain (GstPad *pad,
does not contain the information required to know the output format does not contain the information required to know the output format
yet; rather, the data headers need to be parsed, too. In many cases, yet; rather, the data headers need to be parsed, too. In many cases,
fixed-caps will be enough, but in some cases, particularly in cases fixed-caps will be enough, but in some cases, particularly in cases
where such decoders are renegotiatable, it is also possible to use where such decoders are renegotiable, it is also possible to use
full caps negotiation. full caps negotiation.
</para> </para>
<para> <para>
@ -370,7 +370,7 @@ gst_my_filter_chain (GstPad *pad,
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Elements that are renegotiatable should implement a Elements that are renegotiable should implement a
<quote>setcaps</quote>-function on their sourcepad as well. <quote>setcaps</quote>-function on their sourcepad as well.
</para> </para>
</listitem> </listitem>

View file

@ -190,7 +190,7 @@ gst_my_filter_loopfunc (GstElement *element)
<para> <para>
Note that we use a lot of checks everywhere to make sure that the content Note that we use a lot of checks everywhere to make sure that the content
in the file is valid. This has two purposes: first, the file could be in the file is valid. This has two purposes: first, the file could be
erronous, in which case we prevent a crash. The second and most important erroneous, in which case we prevent a crash. The second and most important
reason is that - in extreme cases - the file could be used maliciously to reason is that - in extreme cases - the file could be used maliciously to
cause undefined behaviour in the plugin, which might lead to security cause undefined behaviour in the plugin, which might lead to security
issues. <emphasis>Always</emphasis> assume that the file could be used to issues. <emphasis>Always</emphasis> assume that the file could be used to

View file

@ -83,7 +83,7 @@
start a task on their own. Rather, it means that they are pull start a task on their own. Rather, it means that they are pull
slave for the downstream element, and have to provide random data slave for the downstream element, and have to provide random data
access to it from their <function>_get_range ()</function>-function. access to it from their <function>_get_range ()</function>-function.
Requiremenents are that the a <function>_get_range Requirements are that the a <function>_get_range
()</function>-function was set on this pad using the function ()</function>-function was set on this pad using the function
<function>gst_pad_set_getrange_function ()</function>. Also, if <function>gst_pad_set_getrange_function ()</function>. Also, if
the element has any sinkpads, all those pads (and thereby their the element has any sinkpads, all those pads (and thereby their

View file

@ -486,7 +486,7 @@ plugin_init (GstPlugin *plugin)
<row> <row>
<entry morerows="3">audio/mpeg</entry> <entry morerows="3">audio/mpeg</entry>
<entry morerows="3"> <entry morerows="3">
Audio data compressed using the MPEG audio encoding scehem. Audio data compressed using the MPEG audio encoding scheme.
</entry> </entry>
<entry>mpegversion</entry> <entry>mpegversion</entry>
<entry>integer</entry> <entry>integer</entry>

View file

@ -39,7 +39,7 @@
Most functions returning an object or an object property have Most functions returning an object or an object property have
been changed to return its own reference rather than a constant been changed to return its own reference rather than a constant
reference of the one owned by the object itself. The reason for reference of the one owned by the object itself. The reason for
this change is primarily threadsafety. This means effectively this change is primarily thread-safety. This means effectively
that return values of functions such as that return values of functions such as
<function>gst_element_get_pad ()</function>, <function>gst_element_get_pad ()</function>,
<function>gst_pad_get_name ()</function>, <function>gst_pad_get_name ()</function>,
@ -123,7 +123,7 @@
<symbol>GST_STATE_PLAYING</symbol> have changed for elements that <symbol>GST_STATE_PLAYING</symbol> have changed for elements that
are not sink elements. Non-sink elements need to be able to accept are not sink elements. Non-sink elements need to be able to accept
and process data already in the <symbol>GST_STATE_PAUSED</symbol> and process data already in the <symbol>GST_STATE_PAUSED</symbol>
state now (ie. when prerolling the pipeline). More details can be state now (i.e. when prerolling the pipeline). More details can be
found in <xref linkend="chapter-statemanage-states"/>. found in <xref linkend="chapter-statemanage-states"/>.
</para> </para>
</listitem> </listitem>

View file

@ -199,7 +199,7 @@ GST_BOILERPLATE (GstMyFilter, gst_my_filter, GstElement, GST_TYPE_ELEMENT);
</para> </para>
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para>
A long, english, name for the element. A long, English, name for the element.
</para></listitem><listitem><para> </para></listitem><listitem><para>
The type of the element, see the docs/design/draft-klass.txt document The type of the element, see the docs/design/draft-klass.txt document
in the GStreamer core source tree for details and examples. in the GStreamer core source tree for details and examples.

View file

@ -44,7 +44,7 @@ gst_my_filter_change_state (GstElement * element, GstStateChange transition)
<para> <para>
Obviously, the above doesn't do much useful. Instead of printing that the Obviously, the above doesn't do much useful. Instead of printing that the
data is in, you would normally process the data there. Remember, however, data is in, you would normally process the data there. Remember, however,
that buffers are not always writable. In more advanced elements (the ones that buffers are not always writeable. In more advanced elements (the ones
that do event processing), you may want to additionally specify an event that do event processing), you may want to additionally specify an event
handling function, which will be called when stream-events are sent (such handling function, which will be called when stream-events are sent (such
as end-of-stream, discontinuities, tags, etc.). as end-of-stream, discontinuities, tags, etc.).

View file

@ -19,7 +19,7 @@
you have to set a <function>_setcaps ()</function> function pointer and you have to set a <function>_setcaps ()</function> function pointer and
optionally a <function>_getcaps ()</function> function pointer. Also, you optionally a <function>_getcaps ()</function> function pointer. Also, you
have to set a <function>_chain ()</function> function pointer. have to set a <function>_chain ()</function> function pointer.
Alternatively, pads can also operate in looping mode, which mans that they Alternatively, pads can also operate in looping mode, which means that they
can pull data themselves. More on this topic later. After that, you have can pull data themselves. More on this topic later. After that, you have
to register the pad with the element. This happens like this: to register the pad with the element. This happens like this:
</para> </para>

View file

@ -101,7 +101,7 @@ gst_my_filter_get_property (GObject *object,
<para> <para>
The above is a very simple example of how arguments are used. Graphical The above is a very simple example of how arguments are used. Graphical
applications - for example GStreamer Editor - will use these properties applications - for example GStreamer Editor - will use these properties
and will display a user-controlleable widget with which these properties and will display a user-controllable widget with which these properties
can be changed. This means that - for the property to be as user-friendly can be changed. This means that - for the property to be as user-friendly
as possible - you should be as exact as possible in the definition of the as possible - you should be as exact as possible in the definition of the
property. Not only in defining ranges in between which valid properties property. Not only in defining ranges in between which valid properties

View file

@ -28,7 +28,7 @@
calling <function>gst_init ()</function>. You can alternatively call calling <function>gst_init ()</function>. You can alternatively call
<function>gst_init_with_popt_tables ()</function>, which will return <function>gst_init_with_popt_tables ()</function>, which will return
a pointer to popt tables. You can then use libpopt to handle the a pointer to popt tables. You can then use libpopt to handle the
given argument table, and this will finish the &GStreamer; intialization. given argument table, and this will finish the &GStreamer; initialization.
</para> </para>
<para> <para>
@ -97,7 +97,7 @@ bus_call (GstBus *bus,
g_error_free (err); g_error_free (err);
if (debug) { if (debug) {
g_print ("Debug deails: %s\n", debug); g_print ("Debug details: %s\n", debug);
g_free (debug); g_free (debug);
} }

View file

@ -43,7 +43,7 @@
contain so that data flows smoothly. Another type of bin, called contain so that data flows smoothly. Another type of bin, called
<emphasis>autoplugger</emphasis> elements, automatically add other <emphasis>autoplugger</emphasis> elements, automatically add other
elements to the bin and links them together so that they act as a elements to the bin and links them together so that they act as a
filter between two arbitary stream types. filter between two arbitrary stream types.
</para> </para>
<para> <para>
The plugin mechanism is used everywhere in &GStreamer;, even if only the The plugin mechanism is used everywhere in &GStreamer;, even if only the
@ -165,7 +165,7 @@
<para> <para>
Events Events
contain information on the state of the stream flowing between the two contain information on the state of the stream flowing between the two
linked pads. Events will only be sent if the element explicitely supports linked pads. Events will only be sent if the element explicitly supports
them, else the core will (try to) handle the events automatically. Events them, else the core will (try to) handle the events automatically. Events
are used to indicate, for example, a clock discontinuity, the end of a are used to indicate, for example, a clock discontinuity, the end of a
media stream or that the cache should be flushed. media stream or that the cache should be flushed.
@ -215,7 +215,7 @@
buffers created by filesrc act exactly like generic buffers, except buffers created by filesrc act exactly like generic buffers, except
that they are read-only. The buffer freeing code automatically that they are read-only. The buffer freeing code automatically
determines the correct method of freeing the underlying memory. determines the correct method of freeing the underlying memory.
Downstream elements that recieve these kinds of buffers do not Downstream elements that receive these kinds of buffers do not
need to do anything special to handle or unreference it. need to do anything special to handle or unreference it.
</para> </para>
<para> <para>