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