tools/gst-launch.1.in

   1 .TH "GStreamer" "1" "April 2003"
   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 above under
  16 \fIpipeline description\fR or the GStreamer documentation.
  17
  18 .
  19 .SH "OPTIONS"
  20 .l
  21 \fIgst\-launch\fP accepts the following options:
  22 .TP 8
  23 .B  \-\-help
  24 Print help synopsis and available FLAGS
  25 .TP 8
  26 .B  \-v, \-\-silent
  27 Output status information
  28 .TP 8
  29 .B  \-XTYPE, \-\-exclude=TYPE,
  30 Do not output status information of TYPE
  31 .TP 8
  32 .B  \-oFILE, \-\-output=FILE
  33 Save XML representation of pipeline to FILE and exit
  34 .TP 8
  35 .B  \-f, \-\-no_fault
  36 Do not install a fault handler
  37 .TP 8
  38 .B  \-t, \-\-trace
  39 Print memory allocation traces. The feature must be enabled at compile time to
  40 work.
  41 .TP 8
  42 .B  \-i, \-\-iterations=N
  43 Stop processing after N iterations.
  44
  45 .
  46 .SH "GSTREAMER OPTIONS"
  47 .l
  48 \fIgst\-launch\fP also accepts the following options that are common
  49 to all GStreamer applications:
  50 .TP 8
  51 .B  \-\-gst\-version
  52 Prints the version string of the \fIGStreamer\fP core library.
  53 .TP 8
  54 .B  \-\-gst\-fatal\-warnings
  55 Causes \fIGStreamer\fP to abort if a warning message occurs.
  56 .TP 8
  57 .B  \-\-gst\-debug=STRING
  58 \fIGStreamer\fP debugging flags to set (list with \-\-gst\-mask\-help)
  59 .TP 8
  60 .B  \-\-gst\-debug\-level=LEVEL
  61 Sets the threshold for printing debugging messages.  A higher level
  62 will print more messages.  The useful range is 0-5, with the default
  63 being 0.
  64 .TP 8
  65 .B  \-\-gst\-debug\-no\-color
  66 \fIGStreamer\fP normally prints debugging messages so that the
  67 messages are color-coded when printed to a terminal that handles
  68 ANSI escape sequences.  Using this option causes \fIGstreamer\fP
  69 to print messages without color.
  70 .TP 8
  71 .B  \-\-gst\-disable\-debug
  72 Disables debugging.
  73 .TP 8
  74 .B  \-\-gst\-debug\-help
  75 Prints a list of available debug categories and their default debugging level.
  76 .TP 8
  77 .B  \-\-gst\-disable\-cpu\-opt
  78 \fIGStreamer\fP normally automatically detects the capabilities of the
  79 current CPU and selects the optimal implementation for some functions.
  80 Using this flag disables detection, which is useful for debugging.
  81 .TP 8
  82 .B  \-\-gst\-plugin\-spew
  83 \fIGStreamer\fP info flags to set
  84 Enable printout of errors while loading \fIGStreamer\fP plugins
  85 .TP 8
  86 .B  \-\-gst\-plugin\-path=PATH
  87 Add directories separated with ':' to the plugin search path
  88 .TP 8
  89 .B  \-\-gst\-plugin\-load=PLUGINS
  90 Preload plugins specified in a comma-separated list. Another way to specify
  91 plugins to preload is to use the environment variable GST_PLUGIN_PATH
  92 .TP 8
  93 .B  \-\-gst\-scheduler=SCHEDULER
  94 Use SCHEDULER as the default scheduler
  95 .TP 8
  96 .B  \-\-gst\-registry=REGISTRY
  97 Use the file REGISTRY as registry instead of the default
  98
  99 .SH "PIPELINE DESCRIPTION"
 100
 101 A pipeline consists \fIelements\fR and \fIlinks\fR. \fIElements\fR can be put
 102 into \fIbins\fR of different sorts. \fIElements\fR, \fIlinks\fR and \fIbins\fR
 103 can be specified in a pipeline description in any order.
 104
 105 .B Elements
 106
 107 ELEMENTTYPE \fI[PROPERTY1 ...]\fR
 108
 109 Creates an element of type ELEMENTTYPE and sets the PROPERTIES.
 110
 111 .B Properties
 112
 113 PROPERTY=VALUE ...
 114
 115 Sets the property to the specified value. You can use \fBgst\-inspect\fR(1) to
 116 find out about properties and allowed values of different elements.
 117 .br
 118 Enumeration properties can be set by name, nick or value.
 119
 120 .B Bins
 121
 122 \fI[BINTYPE.]\fR ( \fI[PROPERTY1 ...]\fR PIPELINE-DESCRIPTION )
 123 .br
 124 { \fI[PROPERTY1 ...]\fR PIPELINE-DESCRIPTION }
 125
 126 Specifies that a bin of type BINTYPE is created and the given properties are
 127 set. Every element between the braces is put into the bin. Using curly braces
 128 (second line) is a short cut for using the first line and "thread" as the
 129 BINTYPE.
 130 .br
 131 Please not the dot that has to be used after the BINTYPE.
 132
 133 .B Links
 134
 135 \fI[[SRCELEMENT].[PAD1,...]]\fR ! \fI[[SINKELEMENT].[PAD1,...]]\fR
 136 \fI[[SRCELEMENT].[PAD1,...]]\fR ! CAPS ! \fI[[SINKELEMENT].[PAD1,...]]\fR
 137
 138 Links the element with name SRCELEMENT to the element with name SINKELEMENT,
 139 using the caps specified in CAPS as a filter.
 140 Names can be set on elements with the name property. If the name is omitted, the
 141 element that was specified directly in front of or after the link is used. This
 142 works across bins. If a padname is given, the link is done with these pads. If
 143 no pad names are given all possibilities are tried and a matching pad is used.
 144 If multiple padnames are given, both sides must have the same number of pads
 145 specified and multiple links are done in the given order.
 146 .br
 147 So the simplest link is a simple exclamation mark, that links the element to
 148 the left of it to the element right of it.
 149 .br
 150 Note that when specifying either pads or element names you have to include the
 151 dot or your syntax will be misinterpreted. This is a change to the old syntax
 152 used up to version 0.6 that allowed omitting the dot when only specifying a
 153 padname.
 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]\fR=VALUE
 166 .br
 167 in lists and ranges: [TYPE=]VALUE
 168
 169 Sets the requested property in capabilites. 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 - \fBl\fR or \fBlist\fR for lists
 183 .br
 184 If no type was given, the following order is tried: integer, float, boolean,
 185 string.
 186 .br
 187 Integer values must be parsable by \fBstrtol()\fP, floats by \fBstrtod()\fP. FOURCC values may
 188 either be integers or strings. Boolean values are (case insensitive) \fIyes\fR,
 189 \fIno\fR, \fItrue\fR or \fIfalse\fR and may like strings be escaped with " or '.
 190 .br
 191 Ranges are in this format:  [ PROPERTY, PROPERTY ]
 192 .br
 193 Lists use this format:      ( PROPERTY \fI[, PROPERTY ...]\fR )
 194
 195 .SH "PIPELINE EXAMPLES"
 196
 197 The examples below assume that you have the correct plug-ins available.
 198 In general, "osssink" can be substituted with another audio output
 199 plug-in such as "esdsink", "alsasink", or "artsdsink".  Likewise,
 200 "xvideosink" can be substituted with "sdlvideosink" or "aasink".
 201
 202 .B Audio playback
 203
 204 .B
 205         gst\-launch filesrc location=music.mp3 ! mad ! osssink
 206 .br
 207 Play the mp3 music file "music.mp3" using a libmad-based plug-in and
 208 output to an OSS device
 209
 210 .B
 211         gst\-launch filesrc location=music.ogg ! vorbisfile ! osssink
 212 .br
 213 Play an Ogg Vorbis format file
 214
 215 .B
 216         gst\-launch gnomevfssrc location=music.mp3 ! mad ! osssink
 217 .br
 218 .B
 219         gst\-launch gnomevfssrc location=http://domain.com/music.mp3 ! mad ! osssink
 220 .br
 221 Play an mp3 file or an http stream using GNOME\-VFS
 222
 223 .B
 224         gst\-launch gnomevfssrc location=smb://computer/music.mp3 ! mad ! osssink
 225 .br
 226 Use GNOME\-VFS to play an mp3 file located on an SMB server
 227
 228 .B Format conversion
 229
 230 .B
 231         gst\-launch filesrc location=music.mp3 ! mad ! vorbisenc ! filesink location=music.ogg
 232 .br
 233 Convert an mp3 music file to an Ogg Vorbis file
 234
 235 .B
 236         gst\-launch filesrc location=music.mp3 ! mad ! flacenc ! filesink location=test.flac
 237 .br
 238 Convert to the FLAC format
 239
 240 .B Other
 241
 242 .B
 243         gst\-launch filesrc location=music.wav ! wavparse ! osssink
 244 .br
 245 Plays a .WAV file
 246
 247 .B
 248         gst\-launch filesrc location=music.wav ! wavparse ! vorbisenc ! filesink location=music.ogg
 249 .br
 250 .B
 251         gst\-launch filesrc location=music.wav ! wavparse ! mpegaudio ! filesink location=music.mp3
 252 .br
 253 Convert a .WAV file into Ogg Vorbis (or mp3) file
 254
 255 Alternatively, if you have lame installed (and have the lame plug-in),
 256 you can substitute lame for mpegaudio in the previous example.  It gives
 257 better results than mpegaudio.
 258
 259 .B
 260         gst\-launch cdparanoia ! mpegaudio ! filesink location=cd.mp3
 261 .br
 262 Rip all tracks from compact disc and convert them into a single mp3 file
 263
 264 Using \fBgst\-inspect\fR(1), it is possible to discover settings for cdparanoia
 265 that will tell it to rip individual tracks.
 266
 267 .B
 268         gst\-launch osssrc ! vorbisenc ! filesink location=input.ogg
 269 .br
 270 Record sound from your audio input and encode it into an ogg file
 271
 272 .B Video
 273
 274 .B
 275         gst\-launch filesrc location=JB_FF9_TheGravityOfLove.mpg ! mpegdemux ! mpeg2dec ! xvideosink
 276 .br
 277 Display only the video portion of an MPEG-1 video file, outputting to
 278 an X display window
 279
 280 .B
 281         gst\-launch filesrc location=/flflfj.vob ! mpegdemux ! mpeg2dec ! sdlvideosink
 282 .br
 283 Display the video portion of a .vob file (used on DVDs), outputting to
 284 an SDL window
 285
 286 .B
 287         gst\-launch filesrc location=movie.mpg ! mpegdemux name=demuxer ! mpeg2dec ! sdlvideosink demuxer. ! mad ! osssink
 288 .br
 289 Play both video and audio portions of an MPEG movie
 290
 291 .B
 292         gst\-launch filesrc location=movie.mpg ! mpegdemux name=demuxer ! { queue ! mpeg2dec ! sdlvideosink } { demuxer. ! queue ! mad ! osssink }
 293 .br
 294 Use threaded output to improve synchronization and smoothness. Threads require
 295 queues for buffering on thread boundaries
 296
 297 .B
 298         gst\-launch filesrc location=movie.avi ! avidemux name=demuxer ! { queue ! ffdecall ! sdlvideosink } { demuxer. ! queue ! mad ! osssink }
 299 .br
 300 Play an AVI movie
 301
 302 .B Network streaming
 303
 304 An MPEG\-1 system stream can be streamed via RTP from one machine to
 305 another.
 306
 307 .B
 308         gst\-launch rtprecv media_type=mpeg1_sys ! mpegdemux name=demuxer ! { queue ! mpeg2dec ! xvideosink } { demuxer. ! queue ! mad ! osssink }
 309 .br
 310 Use this command on the receiver
 311
 312 .B
 313         gst\-launch filesrc location=mpeg1system.mpeg ! mpegparse ! rtpsend ip=IPorHostname
 314 .br
 315 This command would be run on the transmitter
 316
 317 .B Diagnostic
 318
 319 .B
 320         gst\-launch fakesrc ! fakesink
 321 .br
 322 Generate a null stream and ignore it
 323
 324 .B
 325         gst\-launch sinesrc ! osssink
 326 .br
 327 Generate a pure tone to test the audio output
 328
 329 .B
 330         gst\-launch videotestsrc ! xvideosink
 331 .br
 332 Generate a familiar test pattern to test the video output
 333
 334 .B Automatic linking
 335
 336 You can use the spider element to automatically select the right elements to get
 337 a working pipeline.
 338
 339 .B
 340         gst\-launch filesrc location=musicfile ! spider ! osssink
 341 .br
 342 Play any supported audio format
 343
 344 .B
 345         gst\-launch filesrc location=videofile ! spider name=spider ! osssink spider. ! xvideosink
 346 .br
 347 .B
 348         gst\-launch filesrc location=videofile ! spider name=spider ! { queue ! osssink } { spider. ! queue ! xvideosink }
 349 .br
 350 Play any supported video format with video and audio output. The second pipeline
 351 uses threaded output.
 352
 353 .B Filtered connections
 354
 355 These examples show you how to use filtered caps.
 356
 357 .B
 358         gst\-launch videotestsrc ! video/raw, format:fourcc=YUY2; video/raw, format:fourcc=YV12 ! xvideosink
 359 .br
 360 Show a test image and use the YUY2 or YV12 video format for this.
 361
 362 .B
 363         gst\-launch osssrc ! "audio/raw", format=int, width=[16, 32], depth=(16, 24, 32), signed=TRUE ! osssink
 364 .br
 365 Playback currently recorded audio. Force usage of signed 16 to 32 bit samples.
 366
 367
 368
 369
 370 .
 371 .SH "SEE ALSO"
 372 .BR gst\-complete (1),
 373 .BR gst\-register (1),
 374 .BR gst\-inspect (1)
 375 .SH "AUTHOR"
 376 The GStreamer team at http://gstreamer.net/