From 76656050b56dfea267780f08d0054ea2ad379e93 Mon Sep 17 00:00:00 2001 From: Antonio Ospite Date: Thu, 3 Nov 2016 00:18:21 +0100 Subject: [PATCH] tools: put the examples descriptions before the commands in man page Put the description of the example command lines before the command instead of after them. The new way is more intuitive. https://bugzilla.gnome.org/show_bug.cgi?id=773917 --- tools/gst-launch.1.in | 112 +++++++++++++++++++++++++------------------------- 1 file changed, 55 insertions(+), 57 deletions(-) diff --git a/tools/gst-launch.1.in b/tools/gst-launch.1.in index dd2ac36..d1a4466 100644 --- a/tools/gst-launch.1.in +++ b/tools/gst-launch.1.in @@ -238,66 +238,66 @@ in front of the sink to make things work. .B Audio playback -.B - gst\-launch filesrc location=music.mp3 ! mad ! audioconvert ! audioresample ! pulsesink -.br Play the mp3 music file "music.mp3" using a libmad-based plug-in and output to an Pulseaudio device +.br +.B + gst\-launch filesrc location=music.mp3 ! mad ! audioconvert ! audioresample ! pulsesink +Play an Ogg Vorbis format file +.br .B gst\-launch filesrc location=music.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! pulsesink -.br -Play an Ogg Vorbis format file +Play an mp3 file or an http stream using GIO +.br .B gst\-launch giosrc location=music.mp3 ! mpegaudioparse ! mad ! pulsesink .br .B gst\-launch giosrc location=http://domain.com/music.mp3 ! mpegaudioparse ! mad ! audioconvert ! audioresample ! pulsesink -.br -Play an mp3 file or an http stream using GIO +Use GIO to play an mp3 file located on an SMB server +.br .B gst\-launch giosrc location=smb://computer/music.mp3 ! mpegaudioparse ! mad ! audioconvert ! audioresample ! pulsesink -.br -Use GIO to play an mp3 file located on an SMB server .B Format conversion +Convert an mp3 music file to an Ogg Vorbis file +.br .B gst\-launch filesrc location=music.mp3 ! mpegaudioparse ! mad ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg -.br -Convert an mp3 music file to an Ogg Vorbis file +Convert to the FLAC format +.br .B gst\-launch filesrc location=music.mp3 ! mpegaudioparse ! mad ! audioconvert ! flacenc ! filesink location=test.flac -.br -Convert to the FLAC format .B Other +Plays a .WAV file that contains raw audio data (PCM). +.br .B gst\-launch filesrc location=music.wav ! wavparse ! audioconvert ! audioresample ! pulsesink -.br -Plays a .WAV file that contains raw audio data (PCM). +Convert a .WAV file containing raw audio data into an Ogg Vorbis or mp3 file +.br .B gst\-launch filesrc location=music.wav ! wavparse ! audioconvert ! vorbisenc ! oggmux ! filesink location=music.ogg .br .B gst\-launch filesrc location=music.wav ! wavparse ! audioconvert ! lame ! filesink location=music.mp3 -.br -Convert a .WAV file containing raw audio data into an Ogg Vorbis or mp3 file +Rips all tracks from compact disc and convert them into a single mp3 file +.br .B gst\-launch cdparanoiasrc mode=continuous ! audioconvert ! lame ! mpegaudioparse ! id3v2mux ! filesink location=cd.mp3 -.br -rips all tracks from compact disc and convert them into a single mp3 file +Rips track 5 from the CD and converts it into a single mp3 file +.br .B gst\-launch cdparanoiasrc track=5 ! audioconvert ! lame ! mpegaudioparse ! id3v2mux ! filesink location=track5.mp3 -.br -rips track 5 from the CD and converts it into a single mp3 file Using \fBgst\-inspect\fR(1), it is possible to discover settings like the above for cdparanoiasrc that will tell it to rip the entire cd or only tracks of it. @@ -306,44 +306,43 @@ cdparanoia) that supports that protocol for you, e.g.: .B gst\-launch cdda://5 ! lame vbr=new vbr\-quality=6 ! filesink location=track5.mp3 +Records sound from your audio input and encodes it into an ogg file +.br .B gst\-launch pulsesrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=input.ogg -.br -records sound from your audio input and encodes it into an ogg file .B Video -.B - gst\-launch filesrc location=JB_FF9_TheGravityOfLove.mpg ! dvddemux ! mpegvideoparse ! mpeg2dec ! xvimagesink -.br Display only the video portion of an MPEG-1 video file, outputting to an X display window - -.B - gst\-launch filesrc location=/flflfj.vob ! dvddemux ! mpegvideoparse ! mpeg2dec ! sdlvideosink .br +.B + gst\-launch filesrc location=JB_FF9_TheGravityOfLove.mpg ! dvddemux ! mpegvideoparse ! mpeg2dec ! xvimagesink + Display the video portion of a .vob file (used on DVDs), outputting to an SDL window +.br +.B + gst\-launch filesrc location=/flflfj.vob ! dvddemux ! mpegvideoparse ! mpeg2dec ! sdlvideosink +Play both video and audio portions of an MPEG movie +.br .B gst\-launch filesrc location=movie.mpg ! dvddemux name=demuxer demuxer. ! queue ! mpegvideoparse ! mpeg2dec ! sdlvideosink demuxer. ! queue ! mpegaudioparse ! mad ! audioconvert ! audioresample ! pulsesink -.br -Play both video and audio portions of an MPEG movie +Play an AVI movie with an external text subtitle stream +.br .B gst\-launch filesrc location=movie.mpg ! mpegdemux name=demuxer demuxer. ! queue ! mpegvideoparse ! mpeg2dec ! videoconvert ! sdlvideosink demuxer. ! queue ! mpegaudioparse ! mad ! audioconvert ! audioresample ! pulsesink -.br -Play an AVI movie with an external text subtitle stream This example also shows how to refer to specific pads by name if an element (here: textoverlay) has multiple sink or source pads. - +.br .B 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 -.br Play an AVI movie with an external text subtitle stream using playbin - +.br .B gst\-launch playbin uri=file:///path/to/movie.avi suburi=file:///path/to/movie.srt @@ -351,71 +350,70 @@ Play an AVI movie with an external text subtitle stream using playbin Stream video using RTP and network elements. +This command would be run on the transmitter +.br .B 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 -.br -This command would be run on the transmitter +Use this command on the receiver +.br .B gst\-launch udpsrc port=5000 ! application/x\-rtp, clock\-rate=90000,payload=96 ! rtph263pdepay queue\-delay=0 ! ffdec_h263 ! xvimagesink -.br -Use this command on the receiver .B Diagnostic +Generate a null stream and ignore it (and print out details). +.br .B gst\-launch \-v fakesrc num\-buffers=16 ! fakesink -.br -Generate a null stream and ignore it (and print out details). +Generate a pure sine tone to test the audio output +.br .B gst\-launch audiotestsrc ! audioconvert ! audioresample ! pulsesink -.br -Generate a pure sine tone to test the audio output +Generate a familiar test pattern to test the video output +.br .B gst\-launch videotestsrc ! xvimagesink .br .B gst\-launch videotestsrc ! ximagesink -.br -Generate a familiar test pattern to test the video output .B Automatic linking You can use the decodebin element to automatically select the right elements to get a working pipeline. +Play any supported audio format +.br .B gst\-launch filesrc location=musicfile ! decodebin ! audioconvert ! audioresample ! pulsesink -.br -Play any supported audio format +Play any supported video format with video and audio output. Threads are used +automatically. To make this even easier, you can use the playbin element: +.br .B gst\-launch filesrc location=videofile ! decodebin name=decoder decoder. ! queue ! audioconvert ! audioresample ! pulsesink decoder. ! videoconvert ! xvimagesink .br -Play any supported video format with video and audio output. Threads are used -automatically. To make this even easier, you can use the playbin element: - .B gst\-launch playbin uri=file:///home/joe/foo.avi -.br .B Filtered connections These examples show you how to use filtered caps. +Show a test image and use the YUY2 or YV12 video format for this. +.br .B gst\-launch videotestsrc ! 'video/x\-raw,format=YUY2;video/x\-raw,format=YV12' ! xvimagesink -.br -Show a test image and use the YUY2 or YV12 video format for this. +Record audio and write it to a .wav file. Force usage of signed 16 to 32 bit +samples and a sample rate between 32kHz and 64KHz. +.br .B gst\-launch pulsesrc ! 'audio/x\-raw,rate=[32000,64000],format={S16LE,S24LE,S32LE}' ! wavenc ! filesink location=recording.wav -.br -record audio and write it to a .wav file. Force usage of signed 16 to 32 bit -samples and a sample rate between 32kHz and 64KHz. .SH "ENVIRONMENT VARIABLES" -- 2.7.4