[FFmpeg-devel] [PATCH 2/3] Add section describing the filtergraph.

[Stefano Sabatini]

On date Thursday 2010-12-02 23:43:28 +0100, Stefano Sabatini encoded:
[...]
> > > diff --git a/doc/filters.texi b/doc/filters.texi
> > > index 9583e4e..d26a02e 100644
> > > --- a/doc/filters.texi
> > > +++ b/doc/filters.texi
> > > @@ -1,3 +1,91 @@
> > > + at chapter Filtergraph description
> > > + at c man begin FILTERGRAPH DESCRIPTION
> > > +
> > > +A filtergraph is a directed graph of filters. It can contain cycles,
> > > +and there can be multiple links between a pair of filters. Each link
> > > +has one input pad on one side connecting it to one filter from which
> > > +it takes its input and one output pad on the other side connecting it
> > > +to the one filter accepting its output.
> > > +
> > > +A filter with no input pads is called a "source", a filter with no
> > > +output pads is called a "sink".
> > > +
> > > + at section Filtergraph syntax
> > > +
> > > +A filtergraph can be represented using a textual representation, which
> > > +is recognized by the @code{-vf} and @code{-af} options of the ff*
> > > +tools, and by the @code{av_parse_graph()} function defined in
> > > + at file{libavfilter/avfiltergraph}.
> > > +
> > 
> > > +A filter in the graph is called filternode.
> > 
> > why?
> 
> That was to keep a consistent terminology:
> filternode
> filterchain
> filtergraph
> 
> if you have a better suggestion you're welcome. Basically I'm
> preferring this term in favor of "filter" (which is more related to
> the "class" concept of filter) and "filter instance" (which would be
> too long and not consistent with the other terms and less expressive).
>  
> > > +
> > > +A sequence of connected filternodes, each one connected to the
> > > +previous one in the sequence, is called a filterchain. A filterchain
> > > +is represented by a list of ","-separated filternode descriptions.
> > > +
> > 
> > > +A sequence of filterchains completely describe a filtergraph. A
> > > +filtergraph is represented by a list of ";"-separated filterchain
> > > +descriptions.
> > 
> > What is a sequence of filterchains
> 
> What is a sequence of pigs?
> 
> Rephrased:
> 
> |A filternode is a filter instance which is a node of a filter graph.
> |
> |A filterchain consists of a sequence of connected filternodes, each
> |one connected to the previous one in the sequence. A filterchain is
> |represented by a list of ","-separated filternode descriptions.
> |
> |A filtergraph is completely defined by a sequence of filterchains. A
> |sequence of filterchains is represented by a list of ";"-separated
> |filterchain descriptions.

It had the wrong patch attached, forgot to commit --amend before
sending the patch, updated.
-- 
FFmpeg = Freak Fabulous Mastering Proud Elastic God