Update the examples in the gst-launch-1.0 manpage
[platform/upstream/gstreamer.git] / tools / gst-launch.1.in
index 156fd9f..5034f29 100644 (file)
@@ -72,8 +72,14 @@ section \fIenvironment variables\fR below for further information).
 .TP 8
 .B  \-\-gst\-debug=STRING
 A comma separated list of category_name:level pairs to specify debugging levels
-for each category. Level is in the range 0-5 where 0 will show no messages, and
-5 will show all messages. The wildcard * can be used to match category names.
+for each category. Level is in the range 0-9 where 0 will show no messages, and
+9 will show all messages. The wildcard * can be used to match category names.
+Note that the order of categories and levels is important, wildcards at the
+end may override levels set earlier. The log levels are: 1=ERROR, 2=WARNING,
+3=FIXME, 4=INFO, 5=DEBUG, 6=LOG, 7=TRACE, 9=MEMDUMP. Since GStreamer 1.2 one
+can also use the debug level names, e.g. \-\-gst\-debug=*sink:LOG. A full
+description of the various debug levels can be found in the GStreamer core
+library API documentation, in the "Running GStreamer Applications" section.
 
 Use \-\-gst\-debug\-help to show category names
 
@@ -83,8 +89,10 @@ GST_CAT:5,GST_ELEMENT_*:3,oggdemux:5
 .TP 8
 .B  \-\-gst\-debug\-level=LEVEL
 Sets the threshold for printing debugging messages.  A higher level
-will print more messages.  The useful range is 0-5, with the default
-being 0.
+will print more messages.  The useful range is 0-9, with the default
+being 0. Level 6 (LOG level) will show all information that is usually
+required for debugging purposes. Higher levels are only useful in very
+specific cases. See above for the full list of levels.
 .TP 8
 .B  \-\-gst\-debug\-no\-color
 \fIGStreamer\fP normally prints debugging messages so that the
@@ -93,6 +101,16 @@ ANSI escape sequences.  Using this option causes \fIGStreamer\fP
 to print messages without color. Setting the \fBGST_DEBUG_NO_COLOR\fR
 environment variable will achieve the same thing.
 .TP 8
+.B  \-\-gst\-debug\-color\-mode
+\fIGStreamer\fP normally prints debugging messages so that the
+messages are color-coded when printed to a terminal that handles
+ANSI escape sequences (on *nix), or uses W32 console API to color the
+messages printed into a console (on W32). Using this option causes
+\fIGStreamer\fP to print messages without color ('off' or 'disable'),
+print messages with default colors ('on' or 'auto'), or print messages
+using ANSI escape sequences for coloring ('unix'). Setting the
+\fBGST_DEBUG_COLOR_MODE\fR environment variable will achieve the same thing.
+.TP 8
 .B  \-\-gst\-debug\-disable
 Disables debugging.
 .TP 8
@@ -163,10 +181,10 @@ the left of it to the element right of it.
 
 .B Caps
 
-MIMETYPE \fI[, PROPERTY[, PROPERTY ...]]]\fR \fI[; CAPS[; CAPS ...]]\fR
+MEDIATYPE \fI[, PROPERTY[, PROPERTY ...]]]\fR \fI[; CAPS[; CAPS ...]]\fR
 
-Creates a capability with the given mimetype and optionally with given
-properties. The mimetype can be escaped using " or '.
+Creates a capability with the given media type and optionally with given
+properties. The media type can be escaped using " or '.
 If you want to chain caps, you can add more caps in the same format afterwards.
 
 .B Properties
@@ -182,8 +200,6 @@ and the type can have the following case-insensitive values:
 .br
 - \fBf\fR or \fBfloat\fR for float values or ranges
 .br
-- \fB4\fR or \fBfourcc\fR for FOURCC values
-.br
 - \fBb\fR, \fBbool\fR or \fBboolean\fR for boolean values
 .br
 - \fBs\fR, \fBstr\fR or \fBstring\fR for strings
@@ -201,62 +217,62 @@ either be integers or strings. Boolean values are (case insensitive) \fIyes\fR,
 .br
 Ranges are in this format:  [ VALUE, VALUE ]
 .br
-Lists use this format:      ( VALUE \fI[, VALUE ...]\fR )
+Lists use this format:      { VALUE \fI[, VALUE ...]\fR }
 
 .SH "PIPELINE EXAMPLES"
 
 The examples below assume that you have the correct plug-ins available.
-In general, "osssink" can be substituted with another audio output
-plug-in such as "esdsink", "alsasink", "osxaudiosink", or "artsdsink".
-Likewise, "xvimagesink" can be substituted with "ximagesink", "sdlvideosink",
-"osxvideosink", or "aasink". Keep in mind though that different sinks might
+In general, "pulsesink" can be substituted with another audio output
+plug-in such as "alsasink" or "osxaudiosink"
+Likewise, "xvimagesink" can be substituted with "ximagesink", "glimagesink",
+or "osxvideosink". Keep in mind though that different sinks might
 accept different formats and even the same sink might accept different formats
 on different machines, so you might need to add converter elements like
-audioconvert and audioresample (for audio) or ffmpegcolorspace (for video)
+audioconvert and audioresample (for audio) or videoconvert (for video)
 in front of the sink to make things work.
 
 .B Audio playback
 
 .B
-        gst\-launch filesrc location=music.mp3 ! mad ! audioconvert ! audioresample ! osssink
+        gst\-launch filesrc location=music.mp3 ! mad ! audioconvert ! audioresample ! pulsesink
 .br
 Play the mp3 music file "music.mp3" using a libmad-based plug-in and
-output to an OSS device
+output to an Pulseaudio device
 
 .B
-        gst\-launch filesrc location=music.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! osssink
+        gst\-launch filesrc location=music.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! pulsesink
 .br
 Play an Ogg Vorbis format file
 
 .B
-        gst\-launch gnomevfssrc location=music.mp3 ! mad ! osssink
+        gst\-launch giosrc location=music.mp3 ! mpegaudioparse ! mad ! pulsesink
 .br
 .B
-        gst\-launch gnomevfssrc location=http://domain.com/music.mp3 ! mad ! audioconvert ! audioresample ! osssink
+        gst\-launch giosrc location=http://domain.com/music.mp3 ! mpegaudioparse ! mad ! audioconvert ! audioresample ! pulsesink
 .br
-Play an mp3 file or an http stream using GNOME\-VFS
+Play an mp3 file or an http stream using GIO
 
 .B
-        gst\-launch gnomevfssrc location=smb://computer/music.mp3 ! mad ! audioconvert ! audioresample ! osssink
+        gst\-launch giosrc location=smb://computer/music.mp3 ! mpegaudioparse ! mad ! audioconvert ! audioresample ! pulsesink
 .br
-Use GNOME\-VFS to play an mp3 file located on an SMB server
+Use GIO to play an mp3 file located on an SMB server
 
 .B Format conversion
 
 .B
-        gst\-launch filesrc location=music.mp3 ! mad ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg
+        gst\-launch filesrc location=music.mp3 ! mpegaudioparse ! mad ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg
 .br
 Convert an mp3 music file to an Ogg Vorbis file
 
 .B
-        gst\-launch filesrc location=music.mp3 ! mad ! audioconvert ! flacenc ! filesink location=test.flac
+        gst\-launch filesrc location=music.mp3 ! mpegaudioparse ! mad ! audioconvert ! flacenc ! filesink location=test.flac
 .br
 Convert to the FLAC format
 
 .B Other
 
 .B
-        gst\-launch filesrc location=music.wav ! wavparse ! audioconvert ! audioresample ! osssink
+        gst\-launch filesrc location=music.wav ! wavparse ! audioconvert ! audioresample ! pulsesink
 .br
 Plays a .WAV file that contains raw audio data (PCM).
 
@@ -269,12 +285,12 @@ Plays a .WAV file that contains raw audio data (PCM).
 Convert a .WAV file containing raw audio data into an Ogg Vorbis or mp3 file
 
 .B
-        gst\-launch cdparanoiasrc mode=continuous ! audioconvert ! lame ! id3v2mux ! filesink location=cd.mp3
+        gst\-launch cdparanoiasrc mode=continuous ! audioconvert ! lame ! mpegaudioparse ! id3v2mux ! filesink location=cd.mp3
 .br
 rips all tracks from compact disc and convert them into a single mp3 file
 
 .B
-        gst\-launch cdparanoiasrc track=5 ! audioconvert ! lame ! id3v2mux ! filesink location=track5.mp3
+        gst\-launch cdparanoiasrc track=5 ! audioconvert ! lame ! mpegaudioparse ! id3v2mux ! filesink location=track5.mp3
 .br
 rips track 5 from the CD and converts it into a single mp3 file
 
@@ -286,31 +302,31 @@ cdparanoia) that supports that protocol for you, e.g.:
        gst\-launch cdda://5 ! lame vbr=new vbr-quality=6 ! filesink location=track5.mp3
 
 .B
-        gst\-launch osssrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=input.ogg
+        gst\-launch pulsesrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=input.ogg
 .br
 records sound from your audio input and encodes it into an ogg file
 
 .B Video
 
 .B
-        gst\-launch filesrc location=JB_FF9_TheGravityOfLove.mpg ! dvddemux ! mpeg2dec ! xvimagesink
+        gst\-launch filesrc location=JB_FF9_TheGravityOfLove.mpg ! dvddemux ! mpegvideoparse ! mpeg2dec ! xvimagesink
 .br
 Display only the video portion of an MPEG-1 video file, outputting to
 an X display window
 
 .B
-        gst\-launch filesrc location=/flflfj.vob ! dvddemux ! mpeg2dec ! sdlvideosink
+        gst\-launch filesrc location=/flflfj.vob ! dvddemux ! mpegvideoparse ! mpeg2dec ! sdlvideosink
 .br
 Display the video portion of a .vob file (used on DVDs), outputting to
 an SDL window
 
 .B
-        gst\-launch filesrc location=movie.mpg ! dvddemux name=demuxer  demuxer. ! queue ! mpeg2dec ! sdlvideosink  demuxer. ! queue ! mad ! audioconvert ! audioresample ! osssink
+        gst\-launch filesrc location=movie.mpg ! dvddemux name=demuxer  demuxer. ! queue ! mpegvideoparse ! mpeg2dec ! sdlvideosink  demuxer. ! queue ! mpegaudioparse ! mad ! audioconvert ! audioresample ! pulsesink
 .br
 Play both video and audio portions of an MPEG movie
 
 .B
-        gst\-launch filesrc location=movie.mpg ! mpegdemux name=demuxer  demuxer. ! queue ! mpeg2dec ! ffmpegcolorspace ! sdlvideosink   demuxer. ! queue ! mad ! audioconvert ! audioresample ! osssink
+        gst\-launch filesrc location=movie.mpg ! mpegdemux name=demuxer demuxer. ! queue ! mpegvideoparse ! mpeg2dec ! videoconvert ! sdlvideosink   demuxer. ! queue ! mpegaudioparse ! mad ! audioconvert ! audioresample ! pulsesink
 .br
 Play an AVI movie with an external text subtitle stream
 
@@ -318,20 +334,20 @@ This example also shows how to refer to specific pads by name if an element
 (here: textoverlay) has multiple sink or source pads.
 
 .B
-        gst\-launch textoverlay name=overlay ! ffmpegcolorspace ! videoscale ! autovideosink   filesrc location=movie.avi ! decodebin2 ! ffmpegcolorspace ! overlay.video_sink   filesrc location=movie.srt ! subparse ! overlay.text_sink
+        gst\-launch textoverlay name=overlay ! videoconvert ! videoscale !  autovideosink   filesrc location=movie.avi ! decodebin ! videoconvert ! overlay.video_sink   filesrc location=movie.srt ! subparse ! overlay.text_sink
 
 .br
-Play an AVI movie with an external text subtitle stream using playbin2
+Play an AVI movie with an external text subtitle stream using playbin
 
 .B
-        gst\-launch playbin2 uri=file:///path/to/movie.avi suburi=file:///path/to/movie.srt
+        gst\-launch playbin uri=file:///path/to/movie.avi suburi=file:///path/to/movie.srt
 
 .B Network streaming
 
 Stream video using RTP and network elements.
 
 .B
-        gst\-launch v4l2src ! video/x-raw-yuv,width=128,height=96,format='(fourcc)'UYVY ! ffmpegcolorspace ! ffenc_h263 ! video/x-h263 ! rtph263ppay pt=96 ! udpsink host=192.168.1.1 port=5000 sync=false
+        gst\-launch v4l2src ! video/x-raw,width=128,height=96,format=UYVY ! videoconvert ! ffenc_h263 ! video/x-h263 ! rtph263ppay pt=96 ! udpsink host=192.168.1.1 port=5000
 .br
 This command would be run on the transmitter
 
@@ -348,7 +364,7 @@ Use this command on the receiver
 Generate a null stream and ignore it (and print out details).
 
 .B
-        gst\-launch audiotestsrc ! audioconvert ! audioresample ! osssink
+        gst\-launch audiotestsrc ! audioconvert ! audioresample ! pulsesink
 .br
 Generate a pure sine tone to test the audio output
 
@@ -366,12 +382,12 @@ You can use the decodebin element to automatically select the right elements
 to get a working pipeline.
 
 .B
-        gst\-launch filesrc location=musicfile ! decodebin ! audioconvert ! audioresample ! osssink
+        gst\-launch filesrc location=musicfile ! decodebin ! audioconvert ! audioresample ! pulsesink
 .br
 Play any supported audio format
 
 .B
-        gst\-launch filesrc location=videofile ! decodebin name=decoder  decoder. ! queue ! audioconvert ! audioresample ! osssink   decoder. ! ffmpegcolorspace ! xvimagesink
+        gst\-launch filesrc location=videofile ! decodebin name=decoder decoder. ! queue ! audioconvert ! audioresample ! pulsesink   decoder. !  videoconvert ! xvimagesink
 .br
 Play any supported video format with video and audio output. Threads are used
 automatically. To make this even easier, you can use the playbin element:
@@ -386,12 +402,12 @@ automatically. To make this even easier, you can use the playbin element:
 These examples show you how to use filtered caps.
 
 .B
-        gst\-launch videotestsrc ! 'video/x-raw-yuv,format=(fourcc)YUY2;video/x-raw-yuv,format=(fourcc)YV12' ! xvimagesink
+        gst\-launch videotestsrc ! 'video/x-raw,format=YUY2;video/x-raw,format=YV12' ! xvimagesink
 .br
 Show a test image and use the YUY2 or YV12 video format for this.
 
 .B
-        gst\-launch osssrc ! 'audio/x-raw-int,rate=[32000,64000],width=[16,32],depth={16,24,32},signed=(boolean)true' ! wavenc ! filesink location=recording.wav
+        gst\-launch pulsesrc !  'audio/x-raw,rate=[32000,64000],format={S16LE,S24LE,S32LE}' ! wavenc ! filesink location=recording.wav
 .br
 record audio and write it to a .wav file. Force usage of signed 16 to 32 bit
 samples and a sample rate between 32kHz and 64KHz.
@@ -400,20 +416,27 @@ samples and a sample rate between 32kHz and 64KHz.
 .SH "ENVIRONMENT VARIABLES"
 .TP
 \fBGST_DEBUG\fR
-Comma-separated list of debug categories and levels, e.g.
-GST_DEBUG=totem:4,typefind:5
+Comma-separated list of debug categories and levels (e.g.
+GST_DEBUG=totem:4,typefind:5). '*' is allowed as a wildcard as part of
+debug category names (e.g. GST_DEBUG=*sink:6,*audio*:6). Since 1.2.0 it is
+also possible to specify the log level by name (1=ERROR, 2=WARN, 3=FIXME,
+4=INFO, 5=DEBUG, 6=LOG, 7=TRACE, 9=MEMDUMP) (e.g. GST_DEBUG=*audio*:LOG)
 .TP
 \fBGST_DEBUG_NO_COLOR\fR
 When this environment variable is set, coloured debug output is disabled.
 .TP
 \fBGST_DEBUG_DUMP_DOT_DIR\fR
-When set to a filesystem path, store dot files of pipeline graphs there.
+When set to a filesystem path, store 'dot' files of pipeline graphs there.
+These can then later be converted into an image using the 'dot' utility from
+the graphviz set of tools, like this: dot foo.dot -Tsvg -o foo.svg (png or jpg
+are also possible as output format). There is also a utility called 'xdot'
+which allows you to view the .dot file directly without converting it first.
 .TP
 \fBGST_REGISTRY\fR
 Path of the plugin registry file. Default is
-~/.gstreamer-GST_API_VERSION/registry-CPU.bin where CPU is the machine/cpu type
-GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64', 'ppc', etc. (check
-the output of "uname -i" and "uname -m" for details).
+~/.cache/gstreamer-GST_API_VERSION/registry-CPU.bin where CPU is the
+machine/cpu type GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64',
+'ppc', etc. (check the output of "uname -i" and "uname -m" for details).
 .TP
 \fBGST_REGISTRY_UPDATE\fR
 Set to "no" to force GStreamer to assume that no plugins have changed,
@@ -431,6 +454,11 @@ Specifies a list of plugins that are always loaded by default.  If not set,
 this defaults to the system-installed path, and the plugins installed in the
 user's home directory
 .TP
+\fBGST_DEBUG_FILE\fR
+Set this variable to a file path to redirect all GStreamer debug
+messages to this file. If left unset, debug messages with be output
+unto the standard error.
+.TP
 \fBORC_CODE\fR
 Useful Orc environment variable. Set ORC_CODE=debug to enable debuggers
 such as gdb to create useful backtraces from Orc-generated code.  Set
@@ -448,13 +476,13 @@ a stack trace in the usual way.
 .
 .SH FILES
 .TP 8
-~/.gstreamer-GST_API_VERSION/registry-*.bin
+~/.cache/gstreamer-GST_API_VERSION/registry-*.bin
 The plugin cache; can be deleted at any time, will be re-created
-automatically when it does not exist yet or plugins change.
+automatically when it does not exist yet or plugins change. Based on
+XDG_CACHE_DIR, so may be in a different location than the one suggested.
 .
 .SH "SEE ALSO"
-.BR gst\-feedback (1),
-.BR gst\-inspect (1),
-.BR gst\-typefind (1)
+.BR gst\-inspect\-GST_API_VERSION (1),
+.BR gst\-launch\-GST_API_VERSION (1),
 .SH "AUTHOR"
 The GStreamer team at http://gstreamer.freedesktop.org/