other versions
- jessie 1.4.4-2+deb8u1
- stretch 1.10.4-1
- testing 1.14.4-1
- unstable 1.14.4-1
- experimental 1.15.2-1
GStreamer(1) | General Commands Manual | GStreamer(1) |
NAME¶
gst-launch - build and run a GStreamer pipelineSYNOPSIS¶
gst-launch [OPTION...] PIPELINE-DESCRIPTIONDESCRIPTION¶
gst-launch is a tool that builds and runs basic GStreamer pipelines. In simple form, a PIPELINE-DESCRIPTION is a list of elements separated by exclamation marks (!). Properties may be appended to elements, in the form property=value. For a complete description of possible PIPELINE-DESCRIPTIONS see the section pipeline description below or consult the GStreamer documentation. Please note that gst-launch is primarily a debugging tool for developers and users. You should not build applications on top of it. For applications, use the gst_parse_launch() function of the GStreamer API as an easy way to construct pipelines from pipeline descriptions.OPTIONS¶
gst-launch accepts the following options:- --help
- Print help synopsis and available FLAGS
- -v, --verbose
- Output status information and property notifications
- -q, --quiet
- Do not print any progress information
- -m, --messages
- Output messages posted on the pipeline's bus
- -t, --tags
- Output tags (also known as metadata)
- -e, --eos-on-shutdown
- Force an EOS event on sources before shutting the pipeline down. This is useful to make sure muxers create readable files when a muxing pipeline is shut down forcefully via Control-C.
- -i, --index
- Gather and print index statistics. This is mostly useful for playback or recording pipelines.
- -f, --no-fault
- Do not install a fault handler
- -T, --trace
- Print memory allocation traces. The feature must be enabled at compile time to work.
GSTREAMER OPTIONS¶
gst-launch also accepts the following options that are common to all GStreamer applications:- --gst-version
- Prints the version string of the GStreamer core library.
- --gst-fatal-warnings
- Causes GStreamer to abort if a warning message occurs. This is equivalent to setting the environment variable G_DEBUG to 'fatal_warnings' (see the section environment variables below for further information).
- --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-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 Example: GST_CAT:5,GST_ELEMENT_*:3,oggdemux:5
- --gst-debug-level=LEVEL
- Sets the threshold for printing debugging messages. A higher level 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.
- --gst-debug-no-color
- GStreamer normally prints debugging messages so that the messages are color-coded when printed to a terminal that handles ANSI escape sequences. Using this option causes GStreamer to print messages without color. Setting the GST_DEBUG_NO_COLOR environment variable will achieve the same thing.
- --gst-debug-color-mode
- GStreamer 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 GStreamer 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 GST_DEBUG_COLOR_MODE environment variable will achieve the same thing.
- --gst-debug-disable
- Disables debugging.
- --gst-debug-help
- Prints a list of available debug categories and their default debugging level.
- --gst-plugin-spew
- GStreamer info flags to set Enable printout of errors while loading GStreamer plugins
- --gst-plugin-path=PATH
- Add directories separated with ':' to the plugin search path
- --gst-plugin-load=PLUGINS
- Preload plugins specified in a comma-separated list. Another way to specify plugins to preload is to use the environment variable GST_PLUGIN_PATH
PIPELINE DESCRIPTION¶
A pipeline consists elements and links. Elements can be put into bins of different sorts. Elements, links and bins can be specified in a pipeline description in any order. Elements ELEMENTTYPE [PROPERTY1 ...] Creates an element of type ELEMENTTYPE and sets the PROPERTIES. Properties PROPERTY=VALUE ... Sets the property to the specified value. You can use gst-inspect(1) to find out about properties and allowed values of different elements.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 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 videoconvert (for video) in front of the sink to make things work. Audio playbackgst-launch filesrc location=music.mp3 ! mad ! audioconvert ! audioresample ! osssink
gst-launch filesrc location=music.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! osssink
gst-launch gnomevfssrc location=music.mp3 ! mad ! osssink
gst-launch gnomevfssrc location=http://domain.com/music.mp3 ! mad ! audioconvert ! audioresample ! osssink
gst-launch gnomevfssrc location=smb://computer/music.mp3 ! mad ! audioconvert ! audioresample ! osssink
gst-launch filesrc location=music.mp3 ! mad ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg
gst-launch filesrc location=music.mp3 ! mad ! audioconvert ! flacenc ! filesink location=test.flac
gst-launch filesrc location=music.wav ! wavparse ! audioconvert ! audioresample ! osssink
gst-launch filesrc location=music.wav ! wavparse ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg
gst-launch filesrc location=music.wav ! wavparse ! audioconvert ! lame ! filesink location=music.mp3
gst-launch cdparanoiasrc mode=continuous ! audioconvert ! lame ! id3v2mux ! filesink location=cd.mp3
gst-launch cdparanoiasrc track=5 ! audioconvert ! lame ! id3v2mux ! filesink location=track5.mp3
gst-launch cdda://5 ! lame vbr=new vbr-quality=6 ! filesink location=track5.mp3
gst-launch osssrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=input.ogg
gst-launch filesrc location=JB_FF9_TheGravityOfLove.mpg ! dvddemux ! mpeg2dec ! xvimagesink
gst-launch filesrc location=/flflfj.vob ! dvddemux ! mpeg2dec ! sdlvideosink
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 ! mpegdemux name=demuxer demuxer. ! queue ! mpeg2dec ! videoconvert ! sdlvideosink demuxer. ! queue ! mad ! audioconvert ! audioresample ! osssink
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
gst-launch playbin uri=file:///path/to/movie.avi suburi=file:///path/to/movie.srt Network streaming Stream video using RTP and network elements.
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
gst-launch udpsrc port=5000 ! application/x-rtp, clock-rate=90000,payload=96 ! rtph263pdepay queue-delay=0 ! ffdec_h263 ! xvimagesink
gst-launch -v fakesrc num-buffers=16 ! fakesink
gst-launch audiotestsrc ! audioconvert ! audioresample ! osssink
gst-launch videotestsrc ! xvimagesink
gst-launch videotestsrc ! ximagesink
gst-launch filesrc location=musicfile ! decodebin ! audioconvert ! audioresample ! osssink
gst-launch filesrc location=videofile ! decodebin name=decoder decoder. ! queue ! audioconvert ! audioresample ! osssink decoder. ! videoconvert ! xvimagesink
gst-launch playbin uri=file:///home/joe/foo.avi
gst-launch videotestsrc ! 'video/x-raw,format=YUY2;video/x-raw,format=YV12' ! xvimagesink
gst-launch osssrc ! 'audio/x-raw,rate=[32000,64000],format={S16LE,S24LE,S32LE}' ! wavenc ! filesink location=recording.wav
ENVIRONMENT VARIABLES¶
- GST_DEBUG
- 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)
- GST_DEBUG_NO_COLOR
- When this environment variable is set, coloured debug output is disabled.
- GST_DEBUG_DUMP_DOT_DIR
- 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)
- GST_REGISTRY
- Path of the plugin registry file. Default is ~/.cache/gstreamer-1.0/registry-CPU.bin where CPU is the machine/cpu type GStreamer was compiled for, e.g. 'i486', 'i686', 'x86-64',
- GST_REGISTRY_UPDATE
- Set to "no" to force GStreamer to assume that no plugins have changed, been added or been removed. This will make GStreamer skip the initial check whether a rebuild of the registry cache is required or not. This may be useful in embedded environments where the installed plugins never change. Do not use this option in any other setup.
- GST_PLUGIN_PATH
- Specifies a list of directories to scan for additional plugins. These take precedence over the system plugins.
- GST_PLUGIN_SYSTEM_PATH
- 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
- GST_DEBUG_FILE
- 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.
- ORC_CODE
- Useful Orc environment variable. Set ORC_CODE=debug to enable debuggers such as gdb to create useful backtraces from Orc-generated code. Set ORC_CODE=backup or ORC_CODE=emulate if you suspect Orc's SIMD code generator is producing incorrect code. (Quite a few important GStreamer plugins like videotestsrc, audioconvert or audioresample use Orc).
- G_DEBUG
- Useful GLib environment variable. Set G_DEBUG=fatal_warnings to make GStreamer programs abort when a critical warning such as an assertion failure occurs. This is useful if you want to find out which part of the code caused that warning to be triggered and under what circumstances. Simply set G_DEBUG as mentioned above and run the program in gdb (or let it core dump). Then get a stack trace in the usual way.
FILES¶
- ~/.cache/gstreamer-1.0/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. Based on XDG_CACHE_DIR, so may be in a different location than the one suggested.
SEE ALSO¶
gst-inspect-1.0(1), gst-launch-1.0(1),AUTHOR¶
The GStreamer team at http://gstreamer.freedesktop.org/May 2007 |