har0ke/FFmpeg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc update

Browse Source 
Originally committed as revision 1233 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Fabrice Bellard 2002-11-19 19:16:26 +00:00
parent b242baa411
commit 47d944d2be
5 changed files with 143 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/README.beos
View File

@ -1,23 +0,0 @@
Compilation on BeOS:
--------------------
François Revol - revol@free.fr - July 2002
The configure script should guess the configuration itself.
Networking support is currently not finished.
errno issues fixed by Andrew Bachmann.
Old stuff:
François Revol - revol@free.fr - April 2002
The configure script should guess the configuration itself,
however I still didn't tested building on net_server version of BeOS.
ffserver is broken (needs poll() implementation).
There is still issues with errno codes, which are negative in BeOs, and
that ffmpeg negates when returning. This ends up turning errors into
valid results, then crashes.
(To be fixed)

29
doc/faq.html
View File

@ -1,6 +1,6 @@
<HTML> <HTML>
<HEAD> <HEAD>
<!-- Created by texi2html 1.56k from faq.texi on 4 November 2002 --> <!-- Created by texi2html 1.56k from faq.texi on 19 November 2002 -->
<TITLE>FFmpeg FAQ</TITLE> <TITLE>FFmpeg FAQ</TITLE>
</HEAD> </HEAD>
@ -17,12 +17,13 @@
<LI><A NAME="TOC4" HREF="faq.html#SEC4">1.3 I get audio/video synchro problems when grabbing.</A> <LI><A NAME="TOC4" HREF="faq.html#SEC4">1.3 I get audio/video synchro problems when grabbing.</A>
<LI><A NAME="TOC5" HREF="faq.html#SEC5">1.4 How do I encode jpegs to another format ?</A> <LI><A NAME="TOC5" HREF="faq.html#SEC5">1.4 How do I encode jpegs to another format ?</A>
<LI><A NAME="TOC6" HREF="faq.html#SEC6">1.5 FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it ?</A> <LI><A NAME="TOC6" HREF="faq.html#SEC6">1.5 FFmpeg does not support codec XXX. Can you include a Windows DLL loader to support it ?</A>
<LI><A NAME="TOC7" HREF="faq.html#SEC7">1.6 How can I read from the standard input or write to the standard output ?</A>
</UL> </UL>
<LI><A NAME="TOC7" HREF="faq.html#SEC7">2. Development</A> <LI><A NAME="TOC8" HREF="faq.html#SEC8">2. Development</A>
<UL> <UL>
<LI><A NAME="TOC8" HREF="faq.html#SEC8">2.1 Can you support my C compiler XXX ?</A> <LI><A NAME="TOC9" HREF="faq.html#SEC9">2.1 Can you support my C compiler XXX ?</A>
<LI><A NAME="TOC9" HREF="faq.html#SEC9">2.2 I want to use ffmpeg or libavcodec under Windows. Can you support my proprietary C compiler XXX ?</A> <LI><A NAME="TOC10" HREF="faq.html#SEC10">2.2 I want to use ffmpeg or libavcodec under Windows. Can you support my proprietary C compiler XXX ?</A>
<LI><A NAME="TOC10" HREF="faq.html#SEC10">2.3 Can you add automake, libtool or autoconf support ?</A> <LI><A NAME="TOC11" HREF="faq.html#SEC11">2.3 Can you add automake, libtool or autoconf support ?</A>
</UL> </UL>
</UL> </UL>
<P><HR><P> <P><HR><P>
@ -100,11 +101,19 @@ portable, bloated and often slow.
<H1><A NAME="SEC7" HREF="faq.html#TOC7">2. Development</A></H1> <H2><A NAME="SEC7" HREF="faq.html#TOC7">1.6 How can I read from the standard input or write to the standard output ?</A></H2>
<P>
Use <TT>`-'</TT> as filename.
<H2><A NAME="SEC8" HREF="faq.html#TOC8">2.1 Can you support my C compiler XXX ?</A></H2>
<H1><A NAME="SEC8" HREF="faq.html#TOC8">2. Development</A></H1>
<H2><A NAME="SEC9" HREF="faq.html#TOC9">2.1 Can you support my C compiler XXX ?</A></H2>
<P> <P>
No. Only GCC is supported. GCC is ported on most systems available and I No. Only GCC is supported. GCC is ported on most systems available and I
@ -114,7 +123,7 @@ related to the compiler.
<H2><A NAME="SEC9" HREF="faq.html#TOC9">2.2 I want to use ffmpeg or libavcodec under Windows. Can you support my proprietary C compiler XXX ?</A></H2> <H2><A NAME="SEC10" HREF="faq.html#TOC10">2.2 I want to use ffmpeg or libavcodec under Windows. Can you support my proprietary C compiler XXX ?</A></H2>
<P> <P>
No. Use <CODE>mingw-gcc</CODE> available at <A HREF="http://www.mingw.org/">http://www.mingw.org/</A> to No. Use <CODE>mingw-gcc</CODE> available at <A HREF="http://www.mingw.org/">http://www.mingw.org/</A> to
@ -124,7 +133,7 @@ windows compilers.
<H2><A NAME="SEC10" HREF="faq.html#TOC10">2.3 Can you add automake, libtool or autoconf support ?</A></H2> <H2><A NAME="SEC11" HREF="faq.html#TOC11">2.3 Can you add automake, libtool or autoconf support ?</A></H2>
<P> <P>
No. These tools are too blowted and they complicate the build. Moreover, No. These tools are too blowted and they complicate the build. Moreover,
@ -133,7 +142,7 @@ terms of portability.
<P><HR><P> <P><HR><P>
This document was generated on 4 November 2002 using This document was generated on 19 November 2002 using
<A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>&nbsp;1.56k. <A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>&nbsp;1.56k.
</BODY> </BODY>
</HTML> </HTML>

4
doc/faq.texi
View File

@ -46,6 +46,10 @@ The same system is used for the other image formats.
No. FFmpeg only supports open source codecs. Windows DLLs are not No. FFmpeg only supports open source codecs. Windows DLLs are not
portable, bloated and often slow. portable, bloated and often slow.
@section How can I read from the standard input or write to the standard output ?
Use @file{-} as filename.
@chapter Development @chapter Development
@section Can you support my C compiler XXX ? @section Can you support my C compiler XXX ?

100
doc/ffmpeg-doc.html
View File

@ -1,6 +1,6 @@
<HTML> <HTML>
<HEAD> <HEAD>
<!-- Created by texi2html 1.56k from ffmpeg-doc.texi on 27 October 2002 --> <!-- Created by texi2html 1.56k from ffmpeg-doc.texi on 19 November 2002 -->
<TITLE>FFmpeg Documentation</TITLE> <TITLE>FFmpeg Documentation</TITLE>
</HEAD> </HEAD>
@ -32,13 +32,21 @@
<LI><A NAME="TOC15" HREF="ffmpeg-doc.html#SEC15">5.2 Video Codecs</A> <LI><A NAME="TOC15" HREF="ffmpeg-doc.html#SEC15">5.2 Video Codecs</A>
<LI><A NAME="TOC16" HREF="ffmpeg-doc.html#SEC16">5.3 Audio Codecs</A> <LI><A NAME="TOC16" HREF="ffmpeg-doc.html#SEC16">5.3 Audio Codecs</A>
</UL> </UL>
<LI><A NAME="TOC17" HREF="ffmpeg-doc.html#SEC17">6. Developpers Guide</A> <LI><A NAME="TOC17" HREF="ffmpeg-doc.html#SEC17">6. Platform Specific information</A>
<UL> <UL>
<LI><A NAME="TOC18" HREF="ffmpeg-doc.html#SEC18">6.1 API</A> <LI><A NAME="TOC18" HREF="ffmpeg-doc.html#SEC18">6.1 Linux</A>
<LI><A NAME="TOC19" HREF="ffmpeg-doc.html#SEC19">6.2 Integrating libavcodec or libavformat in your program</A> <LI><A NAME="TOC19" HREF="ffmpeg-doc.html#SEC19">6.2 BSD</A>
<LI><A NAME="TOC20" HREF="ffmpeg-doc.html#SEC20">6.3 Coding Rules</A> <LI><A NAME="TOC20" HREF="ffmpeg-doc.html#SEC20">6.3 Windows</A>
<LI><A NAME="TOC21" HREF="ffmpeg-doc.html#SEC21">6.4 Submitting patches</A> <LI><A NAME="TOC21" HREF="ffmpeg-doc.html#SEC21">6.4 MacOS X</A>
<LI><A NAME="TOC22" HREF="ffmpeg-doc.html#SEC22">6.5 Regression tests</A> <LI><A NAME="TOC22" HREF="ffmpeg-doc.html#SEC22">6.5 BeOS</A>
</UL>
<LI><A NAME="TOC23" HREF="ffmpeg-doc.html#SEC23">7. Developpers Guide</A>
<UL>
<LI><A NAME="TOC24" HREF="ffmpeg-doc.html#SEC24">7.1 API</A>
<LI><A NAME="TOC25" HREF="ffmpeg-doc.html#SEC25">7.2 Integrating libavcodec or libavformat in your program</A>
<LI><A NAME="TOC26" HREF="ffmpeg-doc.html#SEC26">7.3 Coding Rules</A>
<LI><A NAME="TOC27" HREF="ffmpeg-doc.html#SEC27">7.4 Submitting patches</A>
<LI><A NAME="TOC28" HREF="ffmpeg-doc.html#SEC28">7.5 Regression tests</A>
</UL> </UL>
</UL> </UL>
<P><HR><P> <P><HR><P>
@ -438,8 +446,8 @@ dump video coding statistics to file
<H2><A NAME="SEC11" HREF="ffmpeg-doc.html#TOC11">3.6 Protocols</A></H2> <H2><A NAME="SEC11" HREF="ffmpeg-doc.html#TOC11">3.6 Protocols</A></H2>
<P> <P>
The output file can be "-" to output to a pipe. This is only possible The filename can be <TT>`-'</TT> to read from the standard input or to write
with mpeg1 and h263 formats. to the standard output.
<P> <P>
@ -685,11 +693,71 @@ performances on systems without hardware floating point support).
<H1><A NAME="SEC17" HREF="ffmpeg-doc.html#TOC17">6. Developpers Guide</A></H1> <H1><A NAME="SEC17" HREF="ffmpeg-doc.html#TOC17">6. Platform Specific information</A></H1>
<H2><A NAME="SEC18" HREF="ffmpeg-doc.html#TOC18">6.1 API</A></H2> <H2><A NAME="SEC18" HREF="ffmpeg-doc.html#TOC18">6.1 Linux</A></H2>
<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
features only found in GCC 3.2.
<H2><A NAME="SEC19" HREF="ffmpeg-doc.html#TOC19">6.2 BSD</A></H2>
<H2><A NAME="SEC20" HREF="ffmpeg-doc.html#TOC20">6.3 Windows</A></H2>
<H2><A NAME="SEC21" HREF="ffmpeg-doc.html#TOC21">6.4 MacOS X</A></H2>
<H2><A NAME="SEC22" HREF="ffmpeg-doc.html#TOC22">6.5 BeOS</A></H2>
<P>
The configure script should guess the configuration itself.
Networking support is currently not finished.
errno issues fixed by Andrew Bachmann.
<P>
Old stuff:
<P>
François Revol - revol at free dot fr - April 2002
<P>
The configure script should guess the configuration itself,
however I still didn't tested building on net_server version of BeOS.
<P>
ffserver is broken (needs poll() implementation).
<P>
There is still issues with errno codes, which are negative in BeOs, and
that ffmpeg negates when returning. This ends up turning errors into
valid results, then crashes.
(To be fixed)
<H1><A NAME="SEC23" HREF="ffmpeg-doc.html#TOC23">7. Developpers Guide</A></H1>
<H2><A NAME="SEC24" HREF="ffmpeg-doc.html#TOC24">7.1 API</A></H2>
<UL> <UL>
<LI>libavcodec is the library containing the codecs (both encoding and <LI>libavcodec is the library containing the codecs (both encoding and
@ -704,7 +772,7 @@ performances on systems without hardware floating point support).
<H2><A NAME="SEC19" HREF="ffmpeg-doc.html#TOC19">6.2 Integrating libavcodec or libavformat in your program</A></H2> <H2><A NAME="SEC25" HREF="ffmpeg-doc.html#TOC25">7.2 Integrating libavcodec or libavformat in your program</A></H2>
<P> <P>
You can integrate all the source code of the libraries to link them You can integrate all the source code of the libraries to link them
@ -721,7 +789,7 @@ to send your patches to the ffmpeg mailing list.
<H2><A NAME="SEC20" HREF="ffmpeg-doc.html#TOC20">6.3 Coding Rules</A></H2> <H2><A NAME="SEC26" HREF="ffmpeg-doc.html#TOC26">7.3 Coding Rules</A></H2>
<P> <P>
ffmpeg is programmed in ANSI C language. GCC extensions are ffmpeg is programmed in ANSI C language. GCC extensions are
@ -745,7 +813,7 @@ can be generated automatically.
<H2><A NAME="SEC21" HREF="ffmpeg-doc.html#TOC21">6.4 Submitting patches</A></H2> <H2><A NAME="SEC27" HREF="ffmpeg-doc.html#TOC27">7.4 Submitting patches</A></H2>
<P> <P>
When you submit your patch, try to send a unified diff (diff '-u' When you submit your patch, try to send a unified diff (diff '-u'
@ -773,7 +841,7 @@ transmission) to the ffmpeg-devel mailinglist, see
<H2><A NAME="SEC22" HREF="ffmpeg-doc.html#TOC22">6.5 Regression tests</A></H2> <H2><A NAME="SEC28" HREF="ffmpeg-doc.html#TOC28">7.5 Regression tests</A></H2>
<P> <P>
Before submitting a patch (or commiting with CVS), you should at least Before submitting a patch (or commiting with CVS), you should at least
@ -803,7 +871,7 @@ accordingly].
<P><HR><P> <P><HR><P>
This document was generated on 27 October 2002 using This document was generated on 19 November 2002 using
<A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>&nbsp;1.56k. <A HREF="http://wwwinfo.cern.ch/dis/texi2html/">texi2html</A>&nbsp;1.56k.
</BODY> </BODY>
</HTML> </HTML>

38
doc/ffmpeg-doc.texi
View File

@ -266,8 +266,8 @@ dump video coding statistics to file
@section Protocols @section Protocols
The output file can be "-" to output to a pipe. This is only possible The filename can be @file{-} to read from the standard input or to write
with mpeg1 and h263 formats. to the standard output.
ffmpeg handles also many protocols specified with the URL syntax. ffmpeg handles also many protocols specified with the URL syntax.
@ -398,6 +398,40 @@ solutions.
@code{I} means that an integer only version is available too (ensures highest @code{I} means that an integer only version is available too (ensures highest
performances on systems without hardware floating point support). performances on systems without hardware floating point support).
@chapter Platform Specific information
@section Linux
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
features only found in GCC 3.2.
@section BSD
@section Windows
@section MacOS X
@section BeOS
The configure script should guess the configuration itself.
Networking support is currently not finished.
errno issues fixed by Andrew Bachmann.
Old stuff:
François Revol - revol at free dot fr - April 2002
The configure script should guess the configuration itself,
however I still didn't tested building on net_server version of BeOS.
ffserver is broken (needs poll() implementation).
There is still issues with errno codes, which are negative in BeOs, and
that ffmpeg negates when returning. This ends up turning errors into
valid results, then crashes.
(To be fixed)
@chapter Developpers Guide @chapter Developpers Guide
@section API @section API