PPM vhook documentation, by Victor Paesa.
[ffmpeg.git] / doc / hooks.texi
index 7eb2da8..bd817e7 100644 (file)
@@ -18,10 +18,10 @@ Any number of hook modules can be placed inline, and they are run in the
 order that they were specified on the ffmpeg command line.
 
 Three modules are provided and are described below. They are all intended to
 order that they were specified on the ffmpeg command line.
 
 Three modules are provided and are described below. They are all intended to
-be used as a base for your own modules. 
+be used as a base for your own modules.
 
 Modules are loaded using the -vhook option to ffmpeg. The value of this parameter
 
 Modules are loaded using the -vhook option to ffmpeg. The value of this parameter
-is a space seperated list of arguments. The first is the module name, and the rest
+is a space separated list of arguments. The first is the module name, and the rest
 are passed as arguments to the Configure function of the module.
 
 @section null.c
 are passed as arguments to the Configure function of the module.
 
 @section null.c
@@ -45,5 +45,16 @@ This allows a caption to be placed onto each frame. It supports inserting the
 time and date. By using the imlib functions, it would be easy to add your own
 graphical logo, add a frame/border, etc.
 
 time and date. By using the imlib functions, it would be easy to add your own
 graphical logo, add a frame/border, etc.
 
+@section ppm.c
+
+It's basically a launch point for a PPM pipe, so you can use any
+executable (or script) which consumes a PPM on stdin and produces a PPM
+on stdout (and flushes each frame).
+
+Usage example:
+
+@example
+ffmpeg -i input -vhook "/path/to/ppm.so some-ppm-filter args" output
+@end example
 
 @bye
 
 @bye