docs: update FAQ

Change versions.
Use tools with version prefix.
This commit is contained in:
Wim Taymans 2012-09-24 16:25:36 +02:00
parent 23ac4ecbcf
commit b2071f2355
3 changed files with 35 additions and 45 deletions

View file

@ -24,41 +24,39 @@ git</link></para></listitem>
<qandaentry> <qandaentry>
<question id="gstreamer-versions-explained"> <question id="gstreamer-versions-explained">
<para>There seem to be different GStreamer versions, like 0.8 and 0.10? <para>There seem to be different GStreamer versions, like 0.10 and 1.0?
What's up with that?</para> What's up with that?</para>
</question> </question>
<answer> <answer>
<para> <para>
GStreamer-0.8 and GStreamer-0.10 are the main version GStreamer-0.10 and GStreamer-1.0 are the main version
&apos;series&apos; currently in use. For all practical purposes &apos;series&apos; currently in use. For all practical purposes
you should think of them as two completely different libraries you should think of them as two completely different libraries
which just happen to have a similar name. They can be installed which just happen to have a similar name. They can be installed
in parallel and are completely independent. in parallel and are completely independent.
</para> </para>
<para> <para>
For the 0.8 version you will need the 0.8 plugins and bindings For the 0.10 version you will need the 0.10 plugins and bindings
(gst-plugins 0.8.x, gst-ffmpeg 0.8.x, gst-python 0.8.x etc.), while (gst-plugins 0.10.x, gst-ffmpeg 0.10.x, gst-python 0.10.x etc.), while
for the 0.10 version you will need the 0.10 plugins and bindings for the 1.0 version you will need the 1.0 plugins and bindings
(ie. gst-plugins-base 0.10.x, gst-plugins-good 0.10.x, (ie. gst-plugins-base 1.0.x, gst-plugins-good 1.0.x,
gst-plugins-ugly 0.10.x, gst-plugins-bad 0.10.x, gst-ffmpeg 0.10.x, gst-plugins-ugly 1.0.x, gst-plugins-bad 1.0.x, gst-ffmpeg 1.0.x,
gst-python 0.10.x). The micro version for each main version does gst-python 1.0.x). The micro version for each main version does
not have to match exactly, only the major versions needs to be the not have to match exactly, only the major versions needs to be the
same (ie. it may be that the current gst-plugins-good version is same (ie. it may be that the current gst-plugins-good version is
0.10.6 and the current GStreamer core version is 0.10.13). 1.0.6 and the current GStreamer core version is 1.0.13).
GStreamer-0.10 will not see or use any of the GStreamer-0.8 plugins GStreamer-1.0 will not see or use any of the GStreamer-0.10 plugins
and vice versa. and vice versa.
</para> </para>
<para> <para>
All GStreamer command line tools are suffixed with their main All GStreamer command line tools are suffixed with their main
version, e.g. gst-launch-0.8 and gst-launch-0.10, or gst-inspect-0.8 version, e.g. gst-launch-0.10 and gst-launch-1.0, or gst-inspect-0.10
and gst-inspect-0.10. The corresponding GStreamer command line and gst-inspect-1.0.
tools without a suffix (e.g. gst-launch) will default to the highest
major version.
</para> </para>
<para> <para>
Applications will use either GStreamer-0.8 or GStreamer-0.10, since Applications will use either GStreamer-0.10 or GStreamer-1.0, since
the 0.8 and 0.10 API/ABI are not compatible. the 0.10 and 1.0 API/ABI are not compatible.
</para> </para>
<para> <para>
Odd-numbered versions such as 0.9.x, 0.11.x, etc. are unstable Odd-numbered versions such as 0.9.x, 0.11.x, etc. are unstable
@ -74,10 +72,7 @@ git</link></para></listitem>
<answer> <answer>
<para> <para>
You should download GStreamer-0.10. GStreamer-0.8 is not developed You should download GStreamer-1.0. GStreamer-0.10 is end-of-life.
any longer and has not been maintained for almost two years (you
may still find it packaged for your disto though, but that's most
likely for legacy applications).
</para> </para>
</answer> </answer>
</qandaentry> </qandaentry>

View file

@ -13,7 +13,7 @@ Some application is telling me that I am missing a plug-in. What do I do ?
<para> <para>
Well, start by checking if you really are missing the plug-in. Well, start by checking if you really are missing the plug-in.
<programlisting> <programlisting>
gst-inspect (plug-in) gst-inspect-1.0 (plug-in)
</programlisting> </programlisting>
and replace (plug-in) with the plug-in you think is missing. and replace (plug-in) with the plug-in you think is missing.
If this doesn't return any result, then you either don't have it or your If this doesn't return any result, then you either don't have it or your
@ -156,12 +156,12 @@ On my system there is no gst-register command.
<answer> <answer>
<para> <para>
GStreamer version 0.10 does not need this anymore. The registry will Since GStreamer version 0.10 this is not needed anymore. The registry will
be rebuilt automatically. If you suspect the registry is broken, just delete the be rebuilt automatically. If you suspect the registry is broken, just delete the
<filename>registry.*.xml</filename> files under <filename>$HOME/.gstreamer-0.X/</filename> <filename>registry.*.xml</filename> files under <filename>$HOME/.gstreamer-1.X/</filename>
and run and run
<programlisting> <programlisting>
gst-inspect gst-inspect-1.0
</programlisting> </programlisting>
to rebuild the registry. to rebuild the registry.
</para> </para>

View file

@ -12,7 +12,7 @@
First of all, verify that you have a working registry and that you can First of all, verify that you have a working registry and that you can
inspect them by typing inspect them by typing
<programlisting> <programlisting>
$ gst-inspect fakesrc $ gst-inspect-1.0 fakesrc
</programlisting> </programlisting>
This should print out a bunch of information about this particular element. This should print out a bunch of information about this particular element.
If this tells you that there is "no such element or plugin", you haven't If this tells you that there is "no such element or plugin", you haven't
@ -26,7 +26,7 @@ It's time to try out a few things. Start with gst-launch and two plug-ins
that you really should have : fakesrc and fakesink. They do nothing except that you really should have : fakesrc and fakesink. They do nothing except
pass empty buffers. Type this at the command-line : pass empty buffers. Type this at the command-line :
<programlisting> <programlisting>
$ gst-launch -v fakesrc num-buffers=3 ! fakesink $ gst-launch-1.0 -v fakesrc silent=0 num-buffers=3 ! fakesink silent=0
</programlisting> </programlisting>
This will print out output that looks similar to this : This will print out output that looks similar to this :
<programlisting> <programlisting>
@ -56,24 +56,24 @@ You can test this by trying to play a sine tone. For this, you need to
link the audiotestsrc element to an output element that matches your hardware. link the audiotestsrc element to an output element that matches your hardware.
A (non-complete) list of output plug-ins for audio is A (non-complete) list of output plug-ins for audio is
<itemizedlist> <itemizedlist>
<listitem><para>pulsesink for Pulseaudio output</para></listitem>
<listitem><para>osssink for OSS output</para></listitem> <listitem><para>osssink for OSS output</para></listitem>
<listitem><para>esdsink for ESound output</para></listitem> <listitem><para>esdsink for ESound output</para></listitem>
<listitem><para>artsdsink for aRTs output (not ported to 0.10 yet)</para></listitem>
<listitem><para>alsasink for ALSA output</para></listitem> <listitem><para>alsasink for ALSA output</para></listitem>
<listitem><para>alsaspdifsink for ALSA S/PDIF output</para></listitem> <listitem><para>alsaspdifsink for ALSA S/PDIF output</para></listitem>
<listitem><para>jackaudiosink for JACK output</para></listitem> <listitem><para>jackaudiosink for JACK output</para></listitem>
</itemizedlist> </itemizedlist>
First of all, run gst-inspect on the output plug-in you want to use to First of all, run gst-inspect-1.0 on the output plug-in you want to use to
make sure you have it installed. For example, if you use OSS, run make sure you have it installed. For example, if you use Pulseaudio, run
<programlisting> <programlisting>
$ gst-inspect osssink $ gst-inspect-1.0 pulsesink
</programlisting> </programlisting>
and see if that prints out a bunch of properties for the plug-in. and see if that prints out a bunch of properties for the plug-in.
</para> </para>
<para> <para>
Then try to play the sine tone by running Then try to play the sine tone by running
<programlisting> <programlisting>
$ gst-launch audiotestsrc ! audioconvert ! audioresample ! osssink $ gst-launch-1.0 audiotestsrc ! audioconvert ! audioresample ! pulsesink
</programlisting> </programlisting>
and see if you hear something. Make sure your volume is turned up, and see if you hear something. Make sure your volume is turned up,
but also make sure it is not too loud and you are not wearing your headphones. but also make sure it is not too loud and you are not wearing your headphones.
@ -102,20 +102,16 @@ To do this you use the gst-inspect
command-line tool, which comes standard with GStreamer. command-line tool, which comes standard with GStreamer.
Invoked without any arguments, Invoked without any arguments,
<programlisting> <programlisting>
$ gst-inspect $ gst-inspect-1.0
</programlisting> </programlisting>
will print out a listing of installed plugins. will print out a listing of installed plugins.
To learn more about a particular plugin, pass its name on the command line. To learn more about a particular plugin, pass its name on the command line.
For example, For example,
<programlisting> <programlisting>
$ gst-inspect volume $ gst-inspect-1.0 volume
</programlisting> </programlisting>
will give you information about the volume plugin. will give you information about the volume plugin.
</para> </para>
<para>
Also, if you install the gst-editor package, you will have a graphical
plugin browser available, gst-inspect-gui.
</para>
</answer> </answer>
</qandaentry> </qandaentry>
@ -168,27 +164,26 @@ provide us with the necessary gdb output. See
<answer> <answer>
<para> <para>
You access the GStreamer command line interface using the command gst-launch. You access the GStreamer command line interface using the command gst-launch.
To decode an mp3 and play it through OSS, you could use To decode an mp3 and play it through Pulseaudio, you could use
<programlisting> <programlisting>
gst-launch filesrc location=thesong.mp3 ! mad ! audioconvert ! gst-launch-1.0 filesrc location=thesong.mp3 ! mad ! pulsesink
audioresample ! osssink
</programlisting>. </programlisting>.
More examples can be found in the gst-launch man page. More examples can be found in the gst-launch man page.
</para> </para>
<para> <para>
To automatically detect the right codec in a pipeline, try To automatically detect the right codec in a pipeline, try
<programlisting> <programlisting>
gst-launch filesrc location=my-random-media-file.mpeg ! decodebin ! gst-launch-1.0 filesrc location=my-random-media-file.mpeg ! decodebin !
audioconvert ! pulsesink pulsesink
</programlisting>. </programlisting>.
or or
<programlisting> <programlisting>
gst-launch filesrc location=my-random-media-file.mpeg ! decodebin ! gst-launch-1.0 filesrc location=my-random-media-file.mpeg ! decodebin !
videoconvert ! xvimagesink videoconvert ! xvimagesink
</programlisting> </programlisting>
Something more complicated: Something more complicated:
<programlisting> <programlisting>
gst-launch filesrc location=my-random-media-file.mpeg ! decodebin name=decoder gst-launch-1.0 filesrc location=my-random-media-file.mpeg ! decodebin name=decoder
decoder. ! videoconvert ! xvimagesink decoder. ! videoconvert ! xvimagesink
decoder. ! audioconvert ! pulsesink decoder. ! audioconvert ! pulsesink
</programlisting> </programlisting>
@ -197,7 +192,7 @@ gst-launch filesrc location=my-random-media-file.mpeg ! decodebin name=decoder
We also have a basic media playing plugin that will take care of most things We also have a basic media playing plugin that will take care of most things
for you. This plugin is called playbin. Try this: for you. This plugin is called playbin. Try this:
<programlisting> <programlisting>
gst-launch playbin uri=file:///home/joe/my-random-media-file.mpeg gst-launch-1.0 playbin uri=file:///home/joe/my-random-media-file.mpeg
</programlisting> </programlisting>
This should play the file if the format is supported, ie. you have all the This should play the file if the format is supported, ie. you have all the
necessary demuxing and decoding and some output plugins installed. necessary demuxing and decoding and some output plugins installed.