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