[FFmpeg-devel] [PATCH] doc/bitstream_filters: document dump_extra

[Stefano Sabatini]

On date Tuesday 2013-07-16 12:14:27 -0800, Lou Logan encoded:
> On Tue, 16 Jul 2013 15:34:55 +0200, Stefano Sabatini wrote:
> 
> > ---
> >  doc/bitstream_filters.texi | 30 ++++++++++++++++++++++++++++++
> >  1 file changed, 30 insertions(+)
> > 
> > diff --git a/doc/bitstream_filters.texi b/doc/bitstream_filters.texi
> > index fe3c910..d12aa0e 100644
> > --- a/doc/bitstream_filters.texi
> > +++ b/doc/bitstream_filters.texi
> > @@ -32,6 +32,36 @@ Remove zero padding at the end of a packet.
> >  
> >  @section dump_extra
> >  
> > +Add extradata to the beginning of the filtered packets.
> > +
> > +The additional arguments specifies which packets should be filtered.
> > +
> > + at table @samp
> > + at item a
> > +add extradata to all key packets, assuming that @var{local_header} is
> > +set in in the @option{flags2} codec context field
> 
> typo: in in
> 
> > + at item k
> > +add extradata to all key packets
> > +
> > + at item e
> > +add extradata to all packets
> > + at end table
> > +
> > +If not specified it is assumed @samp{k}.
> > +
> > +This filter is useful for example to manipulate bitstreams which
> > +specify a global header in extradata, but which was removed from the
> > +packet headers.
> 
> +This filter is useful for manipulating bitstreams that specify a global
> +header in extradata, but which was removed from the packet headers.
> 
> I'm still not completely happy with that sentence, but I can't come up
> with something better.
> 
> > +
> > +For example the following @command{ffmpeg} command allows to force a
> 
> s/allows to force/forces/
> 
> > +global header (thus disabling individual packet headers) in the H.264
> > +packets generated by the @code{libx264}, but correct them by adding
> 
> s/correct/corrects
> 
> I prefer explicitly specifying what "them" is (at the risk of becoming
> overly verbose).
> 
> > +the header stored in the extradata to the key packets:
> > + at example
> > +ffmpeg -i INPUT -map 0 -flags:v +global_header -c:v libx264 -bsf:v dump_extra -y out.ts
> 
> -y is a global option so it should be before the input options; or
> simply omit it.

Applied with the suggested changes, thanks.
-- 
FFmpeg = Fostering and Fabulous Mortal Philosophical Everlasting Glue