[Ffmpeg-devel] [RFC]: vhook Documentation

[Víctor Paesa]

Hi,

> OK, here's what I fixed:
> 1) Made the example commands more
> cut-and-pasteable,separated the correct points, and
> shortened to:
> 2) Keep every line below 80 characters.
>
> There is a long line for the bulb in a lissagous
> pattern, I left it as is, because to separate it would
> be to break it as per 1) above.

Yes, IMO it makes sense to keep it in one long line.

> I had an older copy, I had made some corrections that
> you had already fixed, but left them in rather an
> re-edit.
>
> Some additional language and references were added.
>
> When I finish reading svn help diff I'll get back to
> you.
>
> For now, its diff -Naur.

Some comments/nitpicks:

-Text fonts are being looked for in a FONTPATH environment variable.
+The font file used is looked for in a FONTPATH environment variable, and
+prepended to the point size as a command line option and can be specified
+with the full path to the font file, as in:
+ at example
+-F /usr/X11R6/lib/X11/fonts/TTF/VeraBd.ttf/20
+# where 20 is the point size.
+ at end example

The way to express point size might be more visible this way:

+ at end example
+where 20 is the point size.


+   # Date and time stamp, security-camera style:
+   ffmpeg -r 29.97 -s 320x256 -f video4linux -i /dev/video0 \
+     -vhook 'vhook/imlib2.so -x 0 -y 0 -i black-260x20.png' \
+     -vhook  'vhook/imlib2.so -c white -F VeraBd.ttf/12 -x 0 -y 0 -t
%A-%D-%T' \
+     output.avi

Why is the second vhook not aligned with first?

+A list of them is here:
+
+http://netpbm.sourceforge.net/doc/directory.html

There is a tag for URLs @url{}

+Options:
+ at multitable @columnfractions .2 .8
+ at item @option{-c <color>}          @tab Foreground color of the text
('internet' way) <#RRGGBB> [default #ffffff]
+ at item @option{-C <color>}          @tab Background color of the text
('internet' way) <#RRGGBB> [default #000000]
+ at item @option{-f <font-filename>}  @tab The font file to use
+ at item @option{-t <text>}           @tab The text to display
+ at item @option{-T <filename>}       @tab The filename to read text from
+ at item @option{-x <pos>}            @tab X coordinate of the start of text
+ at item @option{-y <pos>}            @tab Y coordinate of the start of text
+ at end multitable

X,Y should be x,y in drawtext help too.


+Command Line options:
+-m [0|1]  Mode. Zero is the default mode, see below.
+-t 000000 - ffffff  Threshold. Six digit hex.
+-f <filename> - Watermark image filename. You must specify this!

Shouldn't be these items in a table?


+ An example watermark file is at
+ http://engene.se/ffmpeg_watermark.gif

URL tag.

And that's all.

Regards,
V?ctor