From 9d6f1d52c5e0d109c79db373e10c3632ed4886a1 Mon Sep 17 00:00:00 2001 From: Philip Gladstone Date: Sat, 30 Nov 2002 17:12:23 +0000 Subject: Moved hook documentation into the doc directory Originally committed as revision 1292 to svn://svn.ffmpeg.org/ffmpeg/trunk --- doc/Makefile | 2 +- doc/hooks.texi | 49 +++++++++++++++++++++++++++++ vhook/Makefile | 2 +- vhook/hooks.html | 95 -------------------------------------------------------- vhook/hooks.texi | 49 ----------------------------- 5 files changed, 51 insertions(+), 146 deletions(-) create mode 100644 doc/hooks.texi delete mode 100644 vhook/hooks.html delete mode 100644 vhook/hooks.texi diff --git a/doc/Makefile b/doc/Makefile index dd5bca1f1d..034d4921b4 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,4 +1,4 @@ -all: ffmpeg-doc.html faq.html ffserver-doc.html +all: ffmpeg-doc.html faq.html ffserver-doc.html hooks.html %.html: %.texi texi2html -monolithic -number $< diff --git a/doc/hooks.texi b/doc/hooks.texi new file mode 100644 index 0000000000..7eb2da8848 --- /dev/null +++ b/doc/hooks.texi @@ -0,0 +1,49 @@ +\input texinfo @c -*- texinfo -*- + +@settitle Video Hook Documentation +@titlepage +@sp 7 +@center @titlefont{Video Hook Documentation} +@sp 3 +@end titlepage + + +@chapter Introduction + + +The video hook functionality is designed (mostly) for live video. It allows +the video to be modified or examined between the decoder and the encoder. + +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 +be used as a base for your own modules. + +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 +are passed as arguments to the Configure function of the module. + +@section null.c + +This does nothing. Actually it converts the input image to RGB24 and then converts +it back again. This is meant as a sample that you can use to test your setup. + +@section fish.c + +This implements a 'fish detector'. Essentially it converts the image into HSV +space and tests whether more than a certain percentage of the pixels fall into +a specific HSV cuboid. If so, then the image is saved into a file for processing +by other bits of code. + +Why use HSV? It turns out that HSV cuboids represent a more compact range of +colors than would an RGB cuboid. + +@section imlib2.c + +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. + + +@bye diff --git a/vhook/Makefile b/vhook/Makefile index e6755cc457..898dbb4b6b 100644 --- a/vhook/Makefile +++ b/vhook/Makefile @@ -13,7 +13,7 @@ ifeq ($(HAVE_IMLIB2),yes) HOOKS += imlib2.so endif -all: $(HOOKS) hooks.html +all: $(HOOKS) install: install -s -m 755 $(HOOKS) $(INSTDIR) diff --git a/vhook/hooks.html b/vhook/hooks.html deleted file mode 100644 index 750d15cc92..0000000000 --- a/vhook/hooks.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - -Video Hook Documentation - - -

Video Hook Documentation

-

-

-

Table of Contents

- -

- -

-Video Hook Documentation -

- -

- - - -

1 Introduction

- -

-The video hook functionality is designed (mostly) for live video. It allows -the video to be modified or examined between the decoder and the encoder. - -

-

-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 -be used as a base for your own modules. - -

-

-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 -are passed as arguments to the Configure function of the module. - -

- - -

1.1 null.c

- -

-This does nothing. Actually it converts the input image to RGB24 and then converts -it back again. This is meant as a sample that you can use to test your setup. - -

- - -

1.2 fish.c

- -

-This implements a 'fish detector'. Essentially it converts the image into HSV -space and tests whether more than a certain percentage of the pixels fall into -a specific HSV cuboid. If so, then the image is saved into a file for processing -by other bits of code. - -

-

-Why use HSV? It turns out that HSV cuboids represent a more compact range of -colors than would an RGB cuboid. - -

- - -

1.3 imlib2.c

- -

-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. - -

- -

-This document was generated on 20 November 2002 using the -texi2html -translator version 1.51.

- - diff --git a/vhook/hooks.texi b/vhook/hooks.texi deleted file mode 100644 index 7eb2da8848..0000000000 --- a/vhook/hooks.texi +++ /dev/null @@ -1,49 +0,0 @@ -\input texinfo @c -*- texinfo -*- - -@settitle Video Hook Documentation -@titlepage -@sp 7 -@center @titlefont{Video Hook Documentation} -@sp 3 -@end titlepage - - -@chapter Introduction - - -The video hook functionality is designed (mostly) for live video. It allows -the video to be modified or examined between the decoder and the encoder. - -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 -be used as a base for your own modules. - -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 -are passed as arguments to the Configure function of the module. - -@section null.c - -This does nothing. Actually it converts the input image to RGB24 and then converts -it back again. This is meant as a sample that you can use to test your setup. - -@section fish.c - -This implements a 'fish detector'. Essentially it converts the image into HSV -space and tests whether more than a certain percentage of the pixels fall into -a specific HSV cuboid. If so, then the image is saved into a file for processing -by other bits of code. - -Why use HSV? It turns out that HSV cuboids represent a more compact range of -colors than would an RGB cuboid. - -@section imlib2.c - -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. - - -@bye -- cgit v1.2.3