Difference between revisions of "Gstreamer cheat sheet"

From MyLabWiki
Jump to: navigation, search
(Text Overlay)
Line 26: Line 26:
== Compositing ==
== Compositing ==
=== Picture in Picture ===
=== Text Overlay ===
=== Text Overlay ===

Revision as of 14:56, 19 June 2010

This page contains various shortcuts to achieving specific functionality using Gstreamer. These functionalities are mostly related to my Digital Video Transmission experiments. There is no easy to read "user manual" for gstreamerbut the online the plugin documentation[1] often contains command line examples in addition to the API docs. Other sources of documentation:

  • The manual page for gst-launch
  • The gst-inspect tool
  • Online tutorials

The Gstreamer documentation is also available in Devhelp.

Video Test Source

Webcam Capture

Resizing and Cropping

The aspectratiocrop[2] plugin can be used to convert the video stream to a specific aspect ratio:

 gst-launch v4l2src ! video/x-raw-yuv,width=640,height=480,framerate=15/1 ! aspectratiocrop aspect-ratio=16/9 ! ffmpegcolorspace ! xvimagesink

Network Streaming

Encoding and Muxing

Decoding and Demuxing


Picture in Picture


Text Overlay

The texoverlay[3] plugin can be used to add text to the video stream:

 gst-launch -v videotestsrc ! video/x-raw-yuv,width=640,height=480,framerate=15/1 ! textoverlay text="Hello" ! ffmpegcolorspace ! ximagesink

It has many options for text positioning and alignment. User can also specify font properties as a Pango font description string, e.g. "Sans Italic 24".

TODO: A few font description examples.

Time Overlay

Elapsed time can be added using the timeoverlay[4] plugin:

 gst-launch -v videotestsrc ! timeoverlay ! xvimagesink

Timeoverlay inherits the properties of textoverlay so the text properties can be set using the smae properties:

 gst-launch -v videotestsrc ! timeoverlay halign=right valign=bottom text="Stream time:" shaded-background=true ! xvimagesink

Alternatively, cairotimeoverlay[5] can be used but it doesn't seem to have any properties:

 gst-launch videotestsrc ! cairotimeoverlay ! xvimagesink

Instead of elapsed time, the system date and time can be added using the clockoverlay[6] plugin:

 gst-launch -v videotestsrc ! clockoverlay ! xvimagesink

Clockloverlay also inherits the properties of textoverlay. In addition to that clockoverlay also allows setting the time format:

 gst-launch -v videotestsrc ! clockoverlay halign=right valign=bottom shaded-background=true time-format="%Y.%m.%D" ! ffmpegcolorspace ! ximagesink


  1. Gstreamer documentation http://gstreamer.freedesktop.org/documentation/
  2. GStreamer Good Plugins 0.10 Plugins Reference Manual – aspectratiocrop
  3. GStreamer Base Plugins 0.10 Plugins Reference Manual – textoverlay
  4. GStreamer Base Plugins 0.10 Plugins Reference Manual – timeoverlay
  5. GStreamer Good Plugins 0.10 Plugins Reference Manual – cairotimeoverlay
  6. GStreamer Base Plugins 0.10 Plugins Reference Manual - clockoverlay