summaryrefslogtreecommitdiff
path: root/doc/libavfilter.texi
diff options
context:
space:
mode:
authorStefano Sabatini <stefano.sabatini-lala@poste.it>2010-02-25 19:55:01 +0000
committerStefano Sabatini <stefano.sabatini-lala@poste.it>2010-02-25 19:55:01 +0000
commit11ab237e31860435816bc70739dc5a35c3078cc4 (patch)
treed92cad1be1e92947989ab064ed253ff8ef836dcf /doc/libavfilter.texi
parent9c16add67b0692e89feb2707d3159a2924470c4c (diff)
Add the graph2dot tools and document it.
Also link avfiltergraph.o and graphparser.o against libavfilter, as it uses them. Originally committed as revision 22063 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'doc/libavfilter.texi')
-rw-r--r--doc/libavfilter.texi28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/libavfilter.texi b/doc/libavfilter.texi
index 5bb5235898..32bf10fd9a 100644
--- a/doc/libavfilter.texi
+++ b/doc/libavfilter.texi
@@ -71,6 +71,34 @@ There exist so-called @var{source filters} that do not have a video
input, and we expect in the future some @var{sink filters} that will
not have video output.
+@chapter graph2dot
+
+The @file{graph2dot} program included in the FFmpeg @file{tools}
+directory can be used to parse a filter graph description and issue a
+corresponding textual representation in the dot language.
+
+Invoke the command:
+@example
+graph2dot -h
+@end example
+
+to see how to use @file{graph2dot}.
+
+You can then pass the dot description to the @file{dot} program (from
+the graphviz suite of programs) and obtain a graphical representation
+of the filter graph.
+
+For example the sequence of commands:
+@example
+echo @var{GRAPH_DESCRIPTION} | \
+tools/graph2dot -o graph.tmp && \
+dot -Tpng graph.tmp -o graph.png && \
+display graph.png
+@end example
+
+can be used to create and display an image representing the graph
+described by the @var{GRAPH_DESCRIPTION} string.
+
@chapter Available video filters
When you configure your FFmpeg build, you can disable any of the