Browse code

ffplay: extend documentation for the -vf option

In particular, make it consistent with the ffmpeg docs.

Stefano Sabatini authored on 2013/01/13 23:23:15
Showing 2 changed files
... ...
@@ -74,10 +74,15 @@ You can interactively cycle through the available show modes by
74 74
 pressing the key @key{w}.
75 75
 
76 76
 @item -vf @var{filter_graph}
77
+Create the filter graph specified by @var{filter_graph} and use it to
78
+filter the video stream.
79
+
77 80
 @var{filter_graph} is a description of the filter graph to apply to
78
-the input video.
79
-Use the option "-filters" to show all the available filters (including
80
-also sources and sinks).
81
+the stream, and must have a single video input and a single video
82
+output. In the filter graph, the input is associated to the label
83
+@code{in}, and the output to the label @code{out}. See the
84
+ffmpeg-filters manual for more information about the filtergraph
85
+syntax.
81 86
 
82 87
 @item -i @var{input_file}
83 88
 Read @var{input_file}.
... ...
@@ -3241,7 +3241,7 @@ static const OptionDef options[] = {
3241 3241
     { "infbuf", OPT_BOOL | OPT_EXPERT, { &infinite_buffer }, "don't limit the input buffer size (useful with realtime streams)", "" },
3242 3242
     { "window_title", OPT_STRING | HAS_ARG, { &window_title }, "set window title", "window title" },
3243 3243
 #if CONFIG_AVFILTER
3244
-    { "vf", OPT_STRING | HAS_ARG, { &vfilters }, "video filters", "filter list" },
3244
+    { "vf", OPT_STRING | HAS_ARG, { &vfilters }, "set video filters", "filter_graph" },
3245 3245
 #endif
3246 3246
     { "rdftspeed", OPT_INT | HAS_ARG| OPT_AUDIO | OPT_EXPERT, { &rdftspeed }, "rdft speed", "msecs" },
3247 3247
     { "showmode", HAS_ARG, { .func_arg = opt_show_mode}, "select show mode (0 = video, 1 = waves, 2 = RDFT)", "mode" },