tools/gst-launch.1.in

   1 .TH "GStreamer" "1" "May 2007"
   2 .SH "NAME"
   3 gst\-launch \- build and run a GStreamer pipeline
   4 .SH "SYNOPSIS"
   5 \fBgst\-launch\fR \fI[OPTION...]\fR PIPELINE\-DESCRIPTION
   6 .SH "DESCRIPTION"
   7 .LP
   8 \fIgst\-launch\fP is a tool that builds and runs basic
   9 \fIGStreamer\fP pipelines.
  10
  11 In simple form, a PIPELINE\-DESCRIPTION is a list of
  12 elements separated by exclamation marks (!). Properties may be appended to
  13 elements, in the form \fIproperty=value\fR.
  14
  15 For a complete description of possible PIPELINE-DESCRIPTIONS see the section
  16 \fIpipeline description\fR below or consult the GStreamer documentation.
  17
  18 Please note that \fIgst\-launch\fP is primarily a debugging tool for
  19 developers and users. You should not build applications on top of it. For
  20 applications, use the gst_parse_launch() function of the GStreamer API as an
  21 easy way to construct pipelines from pipeline descriptions.
  22 .
  23 .SH "OPTIONS"
  24 .l
  25 \fIgst\-launch\fP accepts the following options:
  26 .TP 8
  27 .B  \-\-help
  28 Print help synopsis and available FLAGS
  29 .TP 8
  30 .B  \-v, \-\-verbose
  31 Output status information
  32 .TP 8
  33 .B  \-m, \-\-messages
  34 Output messages posted on the pipeline's bus
  35 .TP 8
  36 .B  \-t, \-\-tags
  37 Output tags (also known as metadata)
  38 .TP 8
  39 .B  \-o FILE, \-\-output=FILE
  40 Save XML representation of pipeline to FILE and exit
  41 .TP 8
  42 .B  \-f, \-\-no_fault
  43 Do not install a fault handler
  44 .TP 8
  45 .B  \-T, \-\-trace
  46 Print memory allocation traces. The feature must be enabled at compile time to
  47 work.
  48 .TP 8
  49
  50 .
  51 .SH "GSTREAMER OPTIONS"
  52 .l
  53 \fIgst\-launch\fP also accepts the following options that are common
  54 to all GStreamer applications:
  55 .TP 8
  56 .B  \-\-gst\-version
  57 Prints the version string of the \fIGStreamer\fP core library.
  58 .TP 8
  59 .B  \-\-gst\-fatal\-warnings
  60 Causes \fIGStreamer\fP to abort if a warning message occurs. This is equivalent
  61 to setting the environment variable G_DEBUG to 'fatal_warnings' (see the
  62 section \fIenvironment variables\fR below for further information).
  63 .TP 8
  64 .B  \-\-gst\-debug=STRING
  65 A comma separated list of category_name:level pairs to specify debugging levels
  66 for each category. Level is in the range 0-5 where 0 will show no messages, and
  67 5 will show all messages. The wildcard * can be used to match category names.
  68
  69 Use \-\-gst\-debug\-help to show category names
  70
  71 Example:
  72 GST_CAT:5,GST_ELEMENT_*:3,oggdemux:5
  73
  74 .TP 8
  75 .B  \-\-gst\-debug\-level=LEVEL
  76 Sets the threshold for printing debugging messages.  A higher level
  77 will print more messages.  The useful range is 0-5, with the default
  78 being 0.
  79 .TP 8
  80 .B  \-\-gst\-debug\-no\-color
  81 \fIGStreamer\fP normally prints debugging messages so that the
  82 messages are color-coded when printed to a terminal that handles
  83 ANSI escape sequences.  Using this option causes \fIGStreamer\fP
  84 to print messages without color. Setting the \fBGST_DEBUG_NO_COLOR\fR
  85 environment variable will achieve the same thing.
  86 .TP 8
  87 .B  \-\-gst\-disable\-debug
  88 Disables debugging.
  89 .TP 8
  90 .B  \-\-gst\-debug\-help
  91 Prints a list of available debug categories and their default debugging level.
  92 .TP 8
  93 .B  \-\-gst\-plugin\-spew
  94 \fIGStreamer\fP info flags to set
  95 Enable printout of errors while loading \fIGStreamer\fP plugins
  96 .TP 8
  97 .B  \-\-gst\-plugin\-path=PATH
  98 Add directories separated with ':' to the plugin search path
  99 .TP 8
 100 .B  \-\-gst\-plugin\-load=PLUGINS
 101 Preload plugins specified in a comma-separated list. Another way to specify
 102 plugins to preload is to use the environment variable GST_PLUGIN_PATH
 103
 104 .SH "PIPELINE DESCRIPTION"
 105
 106 A pipeline consists \fIelements\fR and \fIlinks\fR. \fIElements\fR can be put
 107 into \fIbins\fR of different sorts. \fIElements\fR, \fIlinks\fR and \fIbins\fR
 108 can be specified in a pipeline description in any order.
 109
 110 .B Elements
 111
 112 ELEMENTTYPE \fI[PROPERTY1 ...]\fR
 113
 114 Creates an element of type ELEMENTTYPE and sets the PROPERTIES.
 115
 116 .B Properties
 117
 118 PROPERTY=VALUE ...
 119
 120 Sets the property to the specified value. You can use \fBgst\-inspect\fR(1) to
 121 find out about properties and allowed values of different elements.
 122 .br
 123 Enumeration properties can be set by name, nick or value.
 124
 125 .B Bins
 126
 127 \fI[BINTYPE.]\fR ( \fI[PROPERTY1 ...]\fR PIPELINE-DESCRIPTION )
 128 .br
 129
 130 Specifies that a bin of type BINTYPE is created and the given properties are
 131 set. Every element between the braces is put into the bin. Please note the dot
 132 that has to be used after the BINTYPE. You will almost never need this
 133 functionality, it is only really useful for applications using the
 134 gst_launch_parse() API with 'bin' as bintype. That way it is possible to build
 135 partial pipelines instead of a full-fledged top-level pipeline.
 136
 137 .B Links
 138
 139 \fI[[SRCELEMENT].[PAD1,...]]\fR ! \fI[[SINKELEMENT].[PAD1,...]]\fR
 140 \fI[[SRCELEMENT].[PAD1,...]]\fR ! CAPS ! \fI[[SINKELEMENT].[PAD1,...]]\fR
 141
 142 Links the element with name SRCELEMENT to the element with name SINKELEMENT,
 143 using the caps specified in CAPS as a filter.
 144 Names can be set on elements with the name property. If the name is omitted, the
 145 element that was specified directly in front of or after the link is used. This
 146 works across bins. If a padname is given, the link is done with these pads. If
 147 no pad names are given all possibilities are tried and a matching pad is used.
 148 If multiple padnames are given, both sides must have the same number of pads
 149 specified and multiple links are done in the given order.
 150 .br
 151 So the simplest link is a simple exclamation mark, that links the element to
 152 the left of it to the element right of it.
 153 .br
 154
 155 .B Caps
 156
 157 MIMETYPE \fI[, PROPERTY[, PROPERTY ...]]]\fR \fI[; CAPS[; CAPS ...]]\fR
 158
 159 Creates a capability with the given mimetype and optionally with given
 160 properties. The mimetype can be escaped using " or '.
 161 If you want to chain caps, you can add more caps in the same format afterwards.
 162
 163 .B Properties
 164
 165 NAME=\fI[(TYPE)]\fRVALUE
 166 .br
 167 in lists and ranges: \fI[(TYPE)]\fRVALUE
 168
 169 Sets the requested property in capabilities. The name is an alphanumeric value
 170 and the type can have the following case-insensitive values:
 171 .br
 172 - \fBi\fR or \fBint\fR for integer values or ranges
 173 .br
 174 - \fBf\fR or \fBfloat\fR for float values or ranges
 175 .br
 176 - \fB4\fR or \fBfourcc\fR for FOURCC values
 177 .br
 178 - \fBb\fR, \fBbool\fR or \fBboolean\fR for boolean values
 179 .br
 180 - \fBs\fR, \fBstr\fR or \fBstring\fR for strings
 181 .br
 182 - \fBfraction\fR for fractions (framerate, pixel-aspect-ratio)
 183 .br
 184 - \fBl\fR or \fBlist\fR for lists
 185 .br
 186 If no type was given, the following order is tried: integer, float, boolean,
 187 string.
 188 .br
 189 Integer values must be parsable by \fBstrtol()\fP, floats by \fBstrtod()\fP. FOURCC values may
 190 either be integers or strings. Boolean values are (case insensitive) \fIyes\fR,
 191 \fIno\fR, \fItrue\fR or \fIfalse\fR and may like strings be escaped with " or '.
 192 .br
 193 Ranges are in this format:  [ VALUE, VALUE ]
 194 .br
 195 Lists use this format:      ( VALUE \fI[, VALUE ...]\fR )
 196
 197 .SH "PIPELINE CONTROL"
 198
 199 A pipeline can be controlled by signals. SIGUSR2 will stop the pipeline
 200 (GST_STATE_NULL); SIGUSR1 will put it back to play (GST_STATE_PLAYING).
 201 By default, the pipeline will start in the playing state.
 202 .br
 203 There are currently no signals defined to go into the ready or pause
 204 (GST_STATE_READY and GST_STATE_PAUSED) state explicitely.
 205
 206 .SH "PIPELINE EXAMPLES"
 207
 208 The examples below assume that you have the correct plug-ins available.
 209 In general, "osssink" can be substituted with another audio output
 210 plug-in such as "esdsink", "alsasink", "osxaudiosink", or "artsdsink".
 211 Likewise, "xvimagesink" can be substituted with "ximagesink", "sdlvideosink",
 212 "osxvideosink", or "aasink". Keep in mind though that different sinks might
 213 accept different formats and even the same sink might accept different formats
 214 on different machines, so you might need to add converter elements like
 215 audioconvert and audioresample (for audio) or ffmpegcolorspace (for video)
 216 in front of the sink to make things work.
 217
 218 .B Audio playback
 219
 220 .B
 221         gst\-launch filesrc location=music.mp3 ! mad ! audioconvert ! audioresample ! osssink
 222 .br
 223 Play the mp3 music file "music.mp3" using a libmad-based plug-in and
 224 output to an OSS device
 225
 226 .B
 227         gst\-launch filesrc location=music.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! osssink
 228 .br
 229 Play an Ogg Vorbis format file
 230
 231 .B
 232         gst\-launch gnomevfssrc location=music.mp3 ! mad ! osssink
 233 .br
 234 .B
 235         gst\-launch gnomevfssrc location=http://domain.com/music.mp3 ! mad ! audioconvert ! audioresample ! osssink
 236 .br
 237 Play an mp3 file or an http stream using GNOME\-VFS
 238
 239 .B
 240         gst\-launch gnomevfssrc location=smb://computer/music.mp3 ! mad ! audioconvert ! audioresample ! osssink
 241 .br
 242 Use GNOME\-VFS to play an mp3 file located on an SMB server
 243
 244 .B Format conversion
 245
 246 .B
 247         gst\-launch filesrc location=music.mp3 ! mad ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg
 248 .br
 249 Convert an mp3 music file to an Ogg Vorbis file
 250
 251 .B
 252         gst\-launch filesrc location=music.mp3 ! mad ! audioconvert ! flacenc ! filesink location=test.flac
 253 .br
 254 Convert to the FLAC format
 255
 256 .B Other
 257
 258 .B
 259         gst\-launch filesrc location=music.wav ! wavparse ! audioconvert ! audioresample ! osssink
 260 .br
 261 Plays a .WAV file that contains raw audio data (PCM).
 262
 263 .B
 264         gst\-launch filesrc location=music.wav ! wavparse ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg
 265 .br
 266 .B
 267         gst\-launch filesrc location=music.wav ! wavparse ! audioconvert ! lame ! filesink location=music.mp3
 268 .br
 269 Convert a .WAV file containing raw audio data into an Ogg Vorbis or mp3 file
 270
 271 .B
 272         gst\-launch cdparanoia ! lame ! filesink location=cd.mp3
 273 .br
 274 rips all tracks from compact disc and convert them into a single mp3 file
 275
 276 Using \fBgst\-inspect\fR(1), it is possible to discover settings for cdparanoia
 277 that will tell it to rip individual tracks. Alternatively, you can use an URI
 278 and gst-launch will find an element (such as cdparanoia) that supports that
 279 protocol for you, e.g.:
 280 .B
 281        gst\-launch cdda://5 ! lame vbr=new vbr-quality=6 ! filesink location=track5.mp3
 282
 283 .B
 284         gst\-launch osssrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=input.ogg
 285 .br
 286 records sound from your audio input and encodes it into an ogg file
 287
 288 .B Video
 289
 290 .B
 291         gst\-launch filesrc location=JB_FF9_TheGravityOfLove.mpg ! dvddemux ! mpeg2dec ! xvimagesink
 292 .br
 293 Display only the video portion of an MPEG-1 video file, outputting to
 294 an X display window
 295
 296 .B
 297         gst\-launch filesrc location=/flflfj.vob ! dvddemux ! mpeg2dec ! sdlvideosink
 298 .br
 299 Display the video portion of a .vob file (used on DVDs), outputting to
 300 an SDL window
 301
 302 .B
 303         gst\-launch filesrc location=movie.mpg ! dvddemux name=demuxer  demuxer. ! queue ! mpeg2dec ! sdlvideosink  demuxer. ! queue ! mad ! audioconvert ! audioresample ! osssink
 304 .br
 305 Play both video and audio portions of an MPEG movie
 306
 307 .B
 308         gst\-launch filesrc location=movie.mpg ! mpegdemux name=demuxer  demuxer. ! queue ! mpeg2dec ! ffmpegcolorspace ! sdlvideosink   demuxer. ! queue ! mad ! audioconvert ! audioresample ! osssink
 309 .br
 310 Play an AVI movie
 311
 312 .B Network streaming
 313
 314 Stream video using RTP and network elements.
 315
 316 .B
 317         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
 318 .br
 319 Use this command on the receiver
 320
 321 .B
 322         gst\-launch udpsrc port=5000 ! application/x-rtp, clock-rate=90000,payload=96 ! rtph263pdepay queue-delay=0 ! ffdec_h263 ! xvimagesink
 323 .br
 324 This command would be run on the transmitter
 325
 326 .B Diagnostic
 327
 328 .B
 329         gst\-launch -v fakesrc num-buffers=16 ! fakesink
 330 .br
 331 Generate a null stream and ignore it (and print out details).
 332
 333 .B
 334         gst\-launch audiotestsrc ! audioconvert ! audioresample ! osssink
 335 .br
 336 Generate a pure sine tone to test the audio output
 337
 338 .B
 339         gst\-launch videotestsrc ! xvimagesink
 340 .br
 341 .B
 342         gst\-launch videotestsrc ! ximagesink
 343 .br
 344 Generate a familiar test pattern to test the video output
 345
 346 .B Automatic linking
 347
 348 You can use the decodebin element to automatically select the right elements
 349 to get a working pipeline.
 350
 351 .B
 352         gst\-launch filesrc location=musicfile ! decodebin ! audioconvert ! audioresample ! osssink
 353 .br
 354 Play any supported audio format
 355
 356 .B
 357         gst\-launch filesrc location=videofile ! decodebin name=decoder  decoder. ! queue ! audioconvert ! audioresample ! osssink   decoder. ! ffmpegcolorspace ! xvimagesink
 358 .br
 359 Play any supported video format with video and audio output. Threads are used
 360 automatically. To make this even easier, you can use the playbin element:
 361
 362 .B
 363         gst\-launch playbin uri=file:///home/joe/foo.avi
 364 .br
 365
 366
 367 .B Filtered connections
 368
 369 These examples show you how to use filtered caps.
 370
 371 .B
 372         gst\-launch videotestsrc ! 'video/x-raw-yuv,format=(fourcc)YUY2;video/x-raw-yuv,format=(fourcc)YV12' ! xvimagesink
 373 .br
 374 Show a test image and use the YUY2 or YV12 video format for this.
 375
 376 .B
 377         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
 378 .br
 379 record audio and write it to a .wav file. Force usage of signed 16 to 32 bit
 380 samples and a sample rate between 32kHz and 64KHz.
 381
 382
 383 .SH "ENVIRONMENT VARIABLES"
 384 .TP
 385 \fBGST_DEBUG\fR
 386 Comma-separated list of debug categories and levels, e.g.
 387 GST_DEBUG=totem:4,typefind:5
 388 .TP
 389 \fBGST_DEBUG_NO_COLOR\fR
 390 When this environment variable is set, coloured debug output is disabled.
 391 .TP
 392 \fBGST_DEBUG_DUMP_DOT_DIR\fR
 393 When set to a filesystem path, store dot files of pipeline graphs there.
 394 .TP
 395 \fBGST_REGISTRY\fR
 396 Path of the plugin registry file. Default is
 397 ~/.gstreamer-GST_MAJORMINOR/registry-CPU.xml where CPU is the machine/cpu type
 398 GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64', 'ppc', etc. (check
 399 the output of "uname -i" and "uname -m" for details).
 400 .TP
 401 \fBGST_REGISTRY_UPDATE\fR
 402 Set to "no" to force GStreamer to assume that no plugins have changed,
 403 been added or been removed. This will make GStreamer skip the initial check
 404 whether a rebuild of the registry cache is required or not. This may be useful
 405 in embedded environments where the installed plugins never change. Do not
 406 use this option in any other setup.
 407 .TP
 408 \fBGST_PLUGIN_PATH\fR
 409 Specifies a list of directories to scan for additional plugins.
 410 These take precedence over the system plugins.
 411 .TP
 412 \fBGST_PLUGIN_SYSTEM_PATH\fR
 413 Specifies a list of plugins that are always loaded by default.  If not set,
 414 this defaults to the system-installed path, and the plugins installed in the
 415 user's home directory
 416 .TP
 417 \fBOIL_CPU_FLAGS\fR
 418 Useful liboil environment variable. Set OIL_CPU_FLAGS=0 when valgrind or
 419 other debugging tools trip over liboil's CPU detection (quite a few important
 420 GStreamer plugins like videotestsrc, audioconvert or audioresample use liboil).
 421 .TP
 422 \fBG_DEBUG\fR
 423 Useful GLib environment variable. Set G_DEBUG=fatal_warnings to make
 424 GStreamer programs abort when a critical warning such as an assertion failure
 425 occurs. This is useful if you want to find out which part of the code caused
 426 that warning to be triggered and under what circumstances. Simply set G_DEBUG
 427 as mentioned above and run the program in gdb (or let it core dump). Then get
 428 a stack trace in the usual way.
 429 .
 430 .SH FILES
 431 .TP 8
 432 ~/.gstreamer-GST_MAJORMINOR/registry-*.xml
 433 The xml plugin database; can be deleted at any time, will be re-created
 434 automatically when it does not exist yet or plugins change.
 435 .
 436 .SH "SEE ALSO"
 437 .BR gst\-feedback (1),
 438 .BR gst\-inspect (1),
 439 .BR gst\-typefind (1)
 440 .SH "AUTHOR"
 441 The GStreamer team at http://gstreamer.freedesktop.org/