updated html docs
authorFabrice Bellard <fabrice@bellard.org>
Sat, 28 Dec 2002 13:42:05 +0000 (13:42 +0000)
committerFabrice Bellard <fabrice@bellard.org>
Sat, 28 Dec 2002 13:42:05 +0000 (13:42 +0000)
Originally committed as revision 1368 to svn://svn.ffmpeg.org/ffmpeg/trunk

doc/faq.html
doc/ffmpeg-doc.html
doc/ffserver-doc.html
doc/hooks.html [new file with mode: 0644]

index 402f329..2d5b95b 100644 (file)
@@ -1,6 +1,6 @@
 <HTML>
 <HEAD>
-<!-- Created by texi2html 1.56k from faq.texi on 19 November 2002 -->
+<!-- Created by texi2html 1.56k from faq.texi on 28 December 2002 -->
 
 <TITLE>FFmpeg FAQ</TITLE>
 </HEAD>
@@ -142,7 +142,7 @@ terms of portability.
 
 
 <P><HR><P>
-This document was generated on 19 November 2002 using
+This document was generated on 28 December 2002 using
 <A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>&nbsp;1.56k.
 </BODY>
 </HTML>
index 7fc36e1..cc944fc 100644 (file)
@@ -1,6 +1,6 @@
 <HTML>
 <HEAD>
-<!-- Created by texi2html 1.56k from ffmpeg-doc.texi on 19 November 2002 -->
+<!-- Created by texi2html 1.56k from ffmpeg-doc.texi on 28 December 2002 -->
 
 <TITLE>FFmpeg Documentation</TITLE>
 </HEAD>
@@ -14,7 +14,7 @@
 <LI><A NAME="TOC2" HREF="ffmpeg-doc.html#SEC2">2. Quick Start</A>
 <UL>
 <LI><A NAME="TOC3" HREF="ffmpeg-doc.html#SEC3">2.1 Video and Audio grabbing</A>
-<LI><A NAME="TOC4" HREF="ffmpeg-doc.html#SEC4">2.2 Video and Audio file format convertion</A>
+<LI><A NAME="TOC4" HREF="ffmpeg-doc.html#SEC4">2.2 Video and Audio file format conversion</A>
 </UL>
 <LI><A NAME="TOC5" HREF="ffmpeg-doc.html#SEC5">3. Invocation</A>
 <UL>
@@ -41,7 +41,7 @@
 <LI><A NAME="TOC22" HREF="ffmpeg-doc.html#SEC22">6.4 MacOS X</A>
 <LI><A NAME="TOC23" HREF="ffmpeg-doc.html#SEC23">6.5 BeOS</A>
 </UL>
-<LI><A NAME="TOC24" HREF="ffmpeg-doc.html#SEC24">7. Developpers Guide</A>
+<LI><A NAME="TOC24" HREF="ffmpeg-doc.html#SEC24">7. Developers Guide</A>
 <UL>
 <LI><A NAME="TOC25" HREF="ffmpeg-doc.html#SEC25">7.1 API</A>
 <LI><A NAME="TOC26" HREF="ffmpeg-doc.html#SEC26">7.2 Integrating libavcodec or libavformat in your program</A>
@@ -99,7 +99,7 @@ video on the fly with a high quality polyphase filter.
 
 
 
-<H2><A NAME="SEC4" HREF="ffmpeg-doc.html#TOC4">2.2 Video and Audio file format convertion</A></H2>
+<H2><A NAME="SEC4" HREF="ffmpeg-doc.html#TOC4">2.2 Video and Audio file format conversion</A></H2>
 
 <P>
 * ffmpeg can use any supported file format and protocol as input: 
@@ -172,7 +172,7 @@ Examples:
 
 
 <P>
-* You can also do audio and video convertions at the same time:
+* You can also do audio and video conversions at the same time:
 
 
 
@@ -210,13 +210,13 @@ Examples:
 </PRE>
 
 <P>
-  This is a typicall DVD ripper example, input from a VOB file, output
+  This is a typical DVD ripper example, input from a VOB file, output
   to an AVI file with MPEG-4 video and MP3 audio, note that in this
   command we use B frames so the MPEG-4 stream is DivX5 compatible, GOP
   size is 300 that means an INTRA frame every 10 seconds for 29.97 fps
   input video.  Also the audio stream is MP3 encoded so you need LAME
   support which is enabled using <CODE>--enable-mp3lame</CODE> when
-  configuring.  The mapping is particullary usefull for DVD transcoding
+  configuring.  The mapping is particularly useful for DVD transcoding
   to get the desired audio language.
 
 
@@ -254,7 +254,7 @@ Examples:
 
 <P>
   By default, ffmpeg tries to convert as losslessly as possible: it
-  uses the same audio and video parameter fors the outputs as the one
+  uses the same audio and video parameter for the outputs as the one
   specified for the inputs.
 
 
@@ -494,7 +494,7 @@ ffmpeg handles also many protocols specified with the URL syntax.
 
   compression at the expense of the compression ratio. You can use
   '-me zero' to speed up motion estimation, and '-intra' to disable
-  completly motion estimation (you have only I frames, which means it
+  completely motion estimation (you have only I frames, which means it
   is about as good as JPEG compression).
 
 <LI>To have very low bitrates in audio, reduce the sampling frequency
@@ -526,7 +526,7 @@ You can use the <CODE>-formats</CODE> option to have an exhaustive list.
 <H2><A NAME="SEC14" HREF="ffmpeg-doc.html#TOC14">5.1 File Formats</A></H2>
 
 <P>
-FFmpeg supports the following file formats thru the <CODE>libavformat</CODE>
+FFmpeg supports the following file formats through the <CODE>libavformat</CODE>
 library:
 
 
@@ -701,15 +701,15 @@ solutions.
 </TR>
 <TR><TD>MPEG audio layer 1/3   </TD><TD> IX   </TD><TD>  IX</TD>
 
-</TD><TD> MP3 encoding is supported thru the external library LAME
+</TD><TD> MP3 encoding is supported through the external library LAME
 </TR>
 <TR><TD>AC3                    </TD><TD>  IX  </TD><TD>  X</TD>
 
 </TD><TD> liba52 is used internally for decoding.
 </TR>
-<TR><TD>Vorbis                 </TD><TD>  X   </TD><TD></TD>
+<TR><TD>Vorbis                 </TD><TD>  X   </TD><TD>  X</TD>
 
-</TD><TD> encoding is supported thru the external library libvorbis.
+</TD><TD> supported through the external library libvorbis.
 </TR>
 <TR><TD>WMA V1/V2              </TD><TD>      </TD><TD> X</TD>
 
@@ -734,7 +734,7 @@ performances on systems without hardware floating point support).
 
 <P>
 ffmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
-prefered compiler now for ffmpeg. All futur optimizations will depend on
+preferred compiler now for ffmpeg. All future optimizations will depend on
 features only found in GCC 3.2.
 
 
@@ -786,7 +786,7 @@ valid results, then crashes.
 
 
 
-<H1><A NAME="SEC24" HREF="ffmpeg-doc.html#TOC24">7. Developpers Guide</A></H1>
+<H1><A NAME="SEC24" HREF="ffmpeg-doc.html#TOC24">7. Developers Guide</A></H1>
 
 
 
@@ -855,12 +855,12 @@ option). I cannot read other diffs :-)
 
 <P>
 Run the regression tests before submitting a patch so that you can
-verify that there is no big problems.
+verify that there are no big problems.
 
 
 <P>
 Except if your patch is really big and adds an important feature, by
-submitting it to me, you accept implicitely to put it under my
+submitting it to me, you accept implicitly to put it under my
 copyright. I prefer to do this to avoid potential problems if
 licensing of ffmpeg changes.
 
@@ -877,19 +877,25 @@ transmission) to the ffmpeg-devel mailinglist, see
 <H2><A NAME="SEC29" HREF="ffmpeg-doc.html#TOC29">7.5 Regression tests</A></H2>
 
 <P>
-Before submitting a patch (or commiting with CVS), you should at least
+Before submitting a patch (or committing with CVS), you should at least
 test that you did not break anything.
 
 
 <P>
 The regression test build a synthetic video stream and a synthetic
-audio stream. Then there are encoded then decoded with all codecs or
+audio stream. Then these are encoded then decoded with all codecs or
 formats. The CRC (or MD5) of each generated file is recorded in a
 result file. Then a 'diff' is launched with the reference results and
 the result file.
 
 
 <P>
+The regression test then goes on to test the ffserver code with a 
+limited set of streams. It is important that this step runs correctly
+as well.
+
+
+<P>
 Run 'make test' to test all the codecs.
 
 
@@ -904,7 +910,7 @@ accordingly].
 
 
 <P><HR><P>
-This document was generated on 19 November 2002 using
+This document was generated on 28 December 2002 using
 <A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>&nbsp;1.56k.
 </BODY>
 </HTML>
index 62a30b3..2356264 100644 (file)
@@ -1,7 +1,6 @@
 <HTML>
 <HEAD>
-<!-- This HTML file has been created by texi2html 1.51
-     from ffserver-doc.texi on 19 November 2002 -->
+<!-- Created by texi2html 1.56k from ffserver-doc.texi on 28 December 2002 -->
 
 <TITLE>FFserver Documentation</TITLE>
 </HEAD>
 <P><HR><P>
 <H1>Table of Contents</H1>
 <UL>
-<LI><A NAME="TOC1" HREF="ffserver-doc.html#SEC1">1  Introduction</A>
-<LI><A NAME="TOC2" HREF="ffserver-doc.html#SEC2">2  QuickStart</A>
+<LI><A NAME="TOC1" HREF="ffserver-doc.html#SEC1">1. Introduction</A>
+<LI><A NAME="TOC2" HREF="ffserver-doc.html#SEC2">2. QuickStart</A>
 <UL>
-<LI><A NAME="TOC3" HREF="ffserver-doc.html#SEC3">2.1  What can this do?</A>
-<LI><A NAME="TOC4" HREF="ffserver-doc.html#SEC4">2.2  What do I need?</A>
-<LI><A NAME="TOC5" HREF="ffserver-doc.html#SEC5">2.3  How do I make it work?</A>
-<LI><A NAME="TOC6" HREF="ffserver-doc.html#SEC6">2.4  What happens next?</A>
-<LI><A NAME="TOC7" HREF="ffserver-doc.html#SEC7">2.5  Troubleshooting</A>
+<LI><A NAME="TOC3" HREF="ffserver-doc.html#SEC3">2.1 What can this do?</A>
+<LI><A NAME="TOC4" HREF="ffserver-doc.html#SEC4">2.2 What do I need?</A>
+<LI><A NAME="TOC5" HREF="ffserver-doc.html#SEC5">2.3 How do I make it work?</A>
+<LI><A NAME="TOC6" HREF="ffserver-doc.html#SEC6">2.4 What happens next?</A>
+<LI><A NAME="TOC7" HREF="ffserver-doc.html#SEC7">2.5 Troubleshooting</A>
 <UL>
-<LI><A NAME="TOC8" HREF="ffserver-doc.html#SEC8">2.5.1  I don't hear any audio, but video is fine</A>
-<LI><A NAME="TOC9" HREF="ffserver-doc.html#SEC9">2.5.2  The audio and video loose sync after a while.</A>
-<LI><A NAME="TOC10" HREF="ffserver-doc.html#SEC10">2.5.3  After a long while, the video update rate goes way down in WMP.</A>
-<LI><A NAME="TOC11" HREF="ffserver-doc.html#SEC11">2.5.4  WMP 6.4 behaves differently to WMP 7.</A>
+<LI><A NAME="TOC8" HREF="ffserver-doc.html#SEC8">2.5.1 I don't hear any audio, but video is fine</A>
+<LI><A NAME="TOC9" HREF="ffserver-doc.html#SEC9">2.5.2 The audio and video loose sync after a while.</A>
+<LI><A NAME="TOC10" HREF="ffserver-doc.html#SEC10">2.5.3 After a long while, the video update rate goes way down in WMP.</A>
+<LI><A NAME="TOC11" HREF="ffserver-doc.html#SEC11">2.5.4 WMP 6.4 behaves differently to WMP 7.</A>
 </UL>
-<LI><A NAME="TOC12" HREF="ffserver-doc.html#SEC12">2.6  What else can it do?</A>
-<LI><A NAME="TOC13" HREF="ffserver-doc.html#SEC13">2.7  Tips</A>
-<LI><A NAME="TOC14" HREF="ffserver-doc.html#SEC14">2.8  Why does the ?buffer / Preroll stop working after a time?</A>
-<LI><A NAME="TOC15" HREF="ffserver-doc.html#SEC15">2.9  Does the <CODE>?date=</CODE> stuff work.</A>
+<LI><A NAME="TOC12" HREF="ffserver-doc.html#SEC12">2.6 What else can it do?</A>
+<LI><A NAME="TOC13" HREF="ffserver-doc.html#SEC13">2.7 Tips</A>
+<LI><A NAME="TOC14" HREF="ffserver-doc.html#SEC14">2.8 Why does the ?buffer / Preroll stop working after a time?</A>
+<LI><A NAME="TOC15" HREF="ffserver-doc.html#SEC15">2.9 Does the <CODE>?date=</CODE> stuff work.</A>
 </UL>
 </UL>
 <P><HR><P>
 
 <P>
 FFserver Documentation
-<P>
 
-</P>
 
 
 
-<H1><A NAME="SEC1" HREF="ffserver-doc.html#TOC1">1  Introduction</A></H1>
+<H1><A NAME="SEC1" HREF="ffserver-doc.html#TOC1">1. Introduction</A></H1>
 
 <P>
 FFserver is a streaming server for both audio and video. It supports
@@ -49,76 +46,76 @@ several live feeds, streaming from files and time shifting on live feeds
 (you can seek to positions in the past on each live feed, provided you
 specify a big enough feed storage in ffserver.conf).
 
-</P>
+
 <P>
 This documentation covers only the streaming aspects of ffserver /
 ffmpeg. All questions about parameters for ffmpeg, codec questions,
 etc. are not covered here. Read <TT>`ffmpeg-doc.[texi|html]'</TT> for more
 information.
 
-</P>
 
 
-<H1><A NAME="SEC2" HREF="ffserver-doc.html#TOC2">2  QuickStart</A></H1>
+
+<H1><A NAME="SEC2" HREF="ffserver-doc.html#TOC2">2. QuickStart</A></H1>
 
 <P>
 [Contributed by Philip Gladstone, philip-ffserver at gladstonefamily dot net]
 
-</P>
 
 
-<H2><A NAME="SEC3" HREF="ffserver-doc.html#TOC3">2.1  What can this do?</A></H2>
+
+<H2><A NAME="SEC3" HREF="ffserver-doc.html#TOC3">2.1 What can this do?</A></H2>
 
 <P>
 When properly configured and running, you can capture video and audio in real
 time from a suitable capture card, and stream it out over the Internet to
 either Windows Media Player or RealAudio player (with some restrictions).
 
-</P>
+
 <P>
 It can also stream from files, though that is currently broken. Very often, a
 web server can be used to serve up the files just as well.
 
-</P>
+
 <P>
 It can stream prerecorded video from .ffm files, though it is somewhat tricky
 to make it work correctly.
 
-</P>
 
 
-<H2><A NAME="SEC4" HREF="ffserver-doc.html#TOC4">2.2  What do I need?</A></H2>
+
+<H2><A NAME="SEC4" HREF="ffserver-doc.html#TOC4">2.2 What do I need?</A></H2>
 
 <P>
 I use Linux on a 900MHz Duron with a cheapo Bt848 based TV capture card. I'm
 using stock linux 2.4.17 with the stock drivers. [Actually that isn't true,
 I needed some special drivers from my motherboard based sound card.]
 
-</P>
+
 <P>
 I understand that FreeBSD systems work just fine as well.
 
-</P>
 
 
-<H2><A NAME="SEC5" HREF="ffserver-doc.html#TOC5">2.3  How do I make it work?</A></H2>
+
+<H2><A NAME="SEC5" HREF="ffserver-doc.html#TOC5">2.3 How do I make it work?</A></H2>
 
 <P>
 First, build the kit. It *really* helps to have installed LAME first. Then when
 you run the ffserver ./configure, make sure that you have the --enable-mp3lame
 flag turned on.
 
-</P>
+
 <P>
 LAME is important as it allows streaming of audio to Windows Media Player. Don't
 ask why the other audio types do not work.
 
-</P>
+
 <P>
 As a simple test, just run the following two command lines (assuming that you
 have a V4L video capture card):
 
-</P>
+
 
 <PRE>
 ./ffserver -f doc/ffserver.conf &#38;
@@ -129,7 +126,7 @@ have a V4L video capture card):
 At this point you should be able to go to your windows machine and fire up
 Windows Media Player (WMP). Go to Open URL and enter 
 
-</P>
+
 
 <PRE>
     http://&#60;linuxbox&#62;:8090/test.asf
@@ -138,29 +135,29 @@ Windows Media Player (WMP). Go to Open URL and enter
 <P>
 You should see (after a short delay) video and hear audio. 
 
-</P>
+
 <P>
 WARNING: trying to stream test1.mpg doesn't work with WMP as it tries to
 transfer the entire file before starting to play. The same is true of avi files.
 
-</P>
 
 
-<H2><A NAME="SEC6" HREF="ffserver-doc.html#TOC6">2.4  What happens next?</A></H2>
+
+<H2><A NAME="SEC6" HREF="ffserver-doc.html#TOC6">2.4 What happens next?</A></H2>
 
 <P>
 You should edit the ffserver.conf file to suit your needs (in terms of 
 frame rates etc). Then install ffserver and ffmpeg, write a script to start
 them up, and off you go.
 
-</P>
 
 
-<H2><A NAME="SEC7" HREF="ffserver-doc.html#TOC7">2.5  Troubleshooting</A></H2>
+
+<H2><A NAME="SEC7" HREF="ffserver-doc.html#TOC7">2.5 Troubleshooting</A></H2>
 
 
 
-<H3><A NAME="SEC8" HREF="ffserver-doc.html#TOC8">2.5.1  I don't hear any audio, but video is fine</A></H3>
+<H3><A NAME="SEC8" HREF="ffserver-doc.html#TOC8">2.5.1 I don't hear any audio, but video is fine</A></H3>
 
 <P>
 Maybe you didn't install LAME, or get your ./configure statement right. Check
@@ -172,26 +169,26 @@ that only captures in stereo and also requires that one channel be flipped.
 If you are one of these people, then export 'AUDIO_FLIP_LEFT=1' before 
 starting ffmpeg.
 
-</P>
 
 
-<H3><A NAME="SEC9" HREF="ffserver-doc.html#TOC9">2.5.2  The audio and video loose sync after a while.</A></H3>
+
+<H3><A NAME="SEC9" HREF="ffserver-doc.html#TOC9">2.5.2 The audio and video loose sync after a while.</A></H3>
 
 <P>
 Yes, they do.
 
-</P>
 
 
-<H3><A NAME="SEC10" HREF="ffserver-doc.html#TOC10">2.5.3  After a long while, the video update rate goes way down in WMP.</A></H3>
+
+<H3><A NAME="SEC10" HREF="ffserver-doc.html#TOC10">2.5.3 After a long while, the video update rate goes way down in WMP.</A></H3>
 
 <P>
 Yes, it does. Who knows why?
 
-</P>
 
 
-<H3><A NAME="SEC11" HREF="ffserver-doc.html#TOC11">2.5.4  WMP 6.4 behaves differently to WMP 7.</A></H3>
+
+<H3><A NAME="SEC11" HREF="ffserver-doc.html#TOC11">2.5.4 WMP 6.4 behaves differently to WMP 7.</A></H3>
 
 <P>
 Yes, it does. Any thoughts on this would be gratefully received. These
@@ -200,10 +197,10 @@ different object ids that you can use, one of them -- the old one -- cannot
 play very well, and the new one works well (both on the same system). However, 
 I suspect that the new one is not available unless you have installed WMP 7].
 
-</P>
 
 
-<H2><A NAME="SEC12" HREF="ffserver-doc.html#TOC12">2.6  What else can it do?</A></H2>
+
+<H2><A NAME="SEC12" HREF="ffserver-doc.html#TOC12">2.6 What else can it do?</A></H2>
 
 <P>
 You can replay video from .ffm files that was recorded earlier.
@@ -212,14 +209,14 @@ ffserver parameters must match the original parameters used to record the
 file. If not, then ffserver deletes the file before recording into it. (Now I write
 this, this seems broken).
 
-</P>
+
 <P>
 You can fiddle with many of the codec choices and encoding parameters, and
 there are a bunch more parameters that you cannot control. Post a message
 to the mailing list if there are some 'must have' parameters. Look in the
 ffserver.conf for a list of the currently available controls.
 
-</P>
+
 <P>
 It will automatically generate the .ASX or .RAM files that are often used
 in browsers. These files are actually redirections to the underlying .ASF
@@ -229,10 +226,10 @@ are very small and can be transferred quickly. [The stream itself is
 often 'infinite' and thus the browser tries to download it and never 
 finishes.]
 
-</P>
 
 
-<H2><A NAME="SEC13" HREF="ffserver-doc.html#TOC13">2.7  Tips</A></H2>
+
+<H2><A NAME="SEC13" HREF="ffserver-doc.html#TOC13">2.7 Tips</A></H2>
 
 <P>
 * When you connect to a live stream, most players (WMP, RA etc) want to
@@ -245,7 +242,7 @@ stream should start 5 seconds in the past -- and so the first 5 seconds
 of the stream is sent as fast as the network will allow. It will then
 slow down to real time. This noticeably improves the startup experience.
 
-</P>
+
 <P>
 You can also add a 'Preroll 15' statement into the ffserver.conf that will
 add the 15 second prebuffering on all requests that do not otherwise
@@ -253,15 +250,15 @@ specify a time. In addition, ffserver will skip frames until a key_frame
 is found. This further reduces the startup delay by not transferring data
 that will be discarded.
 
-</P>
+
 <P>
 * You may want to adjust the MaxBandwidth in the ffserver.conf to limit
 the amount of bandwidth consumed by live streams.
 
-</P>
 
 
-<H2><A NAME="SEC14" HREF="ffserver-doc.html#TOC14">2.8  Why does the ?buffer / Preroll stop working after a time?</A></H2>
+
+<H2><A NAME="SEC14" HREF="ffserver-doc.html#TOC14">2.8 Why does the ?buffer / Preroll stop working after a time?</A></H2>
 
 <P>
 It turns out that (on my machine at least) the number of frames successfully
@@ -270,27 +267,27 @@ means that the timestamp in the encoded data stream gets behind real time.
 This means that if you say 'preroll 10', then when the stream gets 10
 or more seconds behind, there is no preroll left.
 
-</P>
+
 <P>
 Fixing this requires a change in the internals in how timestamps are 
 handled.
 
-</P>
 
 
-<H2><A NAME="SEC15" HREF="ffserver-doc.html#TOC15">2.9  Does the <CODE>?date=</CODE> stuff work.</A></H2>
+
+<H2><A NAME="SEC15" HREF="ffserver-doc.html#TOC15">2.9 Does the <CODE>?date=</CODE> stuff work.</A></H2>
 
 <P>
 Yes (subject to the caution above). Also note that whenever you start
-ffserver, it deletes the ffm file (if any parameters hacve changed), thus wiping out what you had recorded
+ffserver, it deletes the ffm file (if any parameters have changed), thus wiping out what you had recorded
 before. 
 
-</P>
+
 <P>
 The format of the <CODE>?date=xxxxxx</CODE> is fairly flexible. You should use one
 of the following formats (the 'T' is literal):
 
-</P>
+
 
 <PRE>
 * YYYY-MM-DDTHH:MM:SS     (localtime)
@@ -302,15 +299,14 @@ You can omit the YYYY-MM-DD, and then it refers to the current day. However
 note that <SAMP>`?date=16:00:00'</SAMP>  refers to 4PM on the current day -- this may be
 in the future and so unlikely to useful.
 
-</P>
+
 <P>
 You use this by adding the ?date= to the end of the URL for the stream.
 For example:   <SAMP>`http://localhost:8080/test.asf?date=2002-07-26T23:05:00'</SAMP>.
 
-</P>
+
 <P><HR><P>
-This document was generated on 19 November 2002 using the
-<A HREF="http://wwwcn.cern.ch/dci/texi2html/">texi2html</A>
-translator version 1.51.</P>
+This document was generated on 28 December 2002 using
+<A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>&nbsp;1.56k.
 </BODY>
 </HTML>
diff --git a/doc/hooks.html b/doc/hooks.html
new file mode 100644 (file)
index 0000000..d18376f
--- /dev/null
@@ -0,0 +1,90 @@
+<HTML>
+<HEAD>
+<!-- Created by texi2html 1.56k from hooks.texi on 28 December 2002 -->
+
+<TITLE>Video Hook Documentation</TITLE>
+</HEAD>
+<BODY>
+<H1>Video Hook Documentation</H1>
+<P>
+<P><HR><P>
+<H1>Table of Contents</H1>
+<UL>
+<LI><A NAME="TOC1" HREF="hooks.html#SEC1">1. Introduction</A>
+<UL>
+<LI><A NAME="TOC2" HREF="hooks.html#SEC2">1.1 null.c</A>
+<LI><A NAME="TOC3" HREF="hooks.html#SEC3">1.2 fish.c</A>
+<LI><A NAME="TOC4" HREF="hooks.html#SEC4">1.3 imlib2.c</A>
+</UL>
+</UL>
+<P><HR><P>
+
+<P>
+Video Hook Documentation
+
+
+
+
+<H1><A NAME="SEC1" HREF="hooks.html#TOC1">1. Introduction</A></H1>
+
+<P>
+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.
+
+
+<P>
+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.
+
+
+<P>
+Three modules are provided and are described below. They are all intended to
+be used as a base for your own modules. 
+
+
+<P>
+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.
+
+
+
+
+<H2><A NAME="SEC2" HREF="hooks.html#TOC2">1.1 null.c</A></H2>
+
+<P>
+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.
+
+
+
+
+<H2><A NAME="SEC3" HREF="hooks.html#TOC3">1.2 fish.c</A></H2>
+
+<P>
+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.
+
+
+<P>
+Why use HSV? It turns out that HSV cuboids represent a more compact range of
+colors than would an RGB cuboid.
+
+
+
+
+<H2><A NAME="SEC4" HREF="hooks.html#TOC4">1.3 imlib2.c</A></H2>
+
+<P>
+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.
+
+
+<P><HR><P>
+This document was generated on 28 December 2002 using
+<A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>&nbsp;1.56k.
+</BODY>
+</HTML>