summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorFabrice Bellard <fabrice@bellard.org>2001-07-22 14:37:44 +0000
committerFabrice Bellard <fabrice@bellard.org>2001-07-22 14:37:44 +0000
commit85f07f223de9fbeb2b9d66db11f89091ac717926 (patch)
tree07c79a0ac6c7829c2ce248f2747bdfcd547262a9 /README
parentde6d9b6404bfd1c589799142da5a95428f146edd (diff)
merge
Originally committed as revision 6 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'README')
-rw-r--r--README73
1 files changed, 73 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000000..4ae288ece9
--- /dev/null
+++ b/README
@@ -0,0 +1,73 @@
+FFmpeg - (c) 2000,2001 Gerard Lantau.
+
+1) Introduction
+---------------
+
+ffmpeg is a hyper fast realtime audio/video encoder, a streaming
+server and a generic audio and video file converter.
+
+It can grab from a standard Video4Linux video source and convert it
+into several file formats based on DCT/motion compensation
+encoding. Sound is compressed in MPEG audio layer 2 or using an AC3
+compatible stream.
+
+What makes ffmpeg interesting ?
+
+- Innovative streaming technology : multiformat, real time encoding,
+ simple configuration.
+
+- Simple and efficient video encoder: outputs MPEG1, H263, Real
+ Video(tm), MPEG4, DIVX and MJPEG compatible bitstreams using the
+ same encoder core.
+
+- Real time encoding (25 fps in 352x288 on a K6 500) using the
+ video4linux API.
+
+- Generates I and P frames, which means it is far better than a MJPEG
+ encoder.
+
+- Hyper fast MPEG audio layer 2 compression (50 times faster than
+ realtime on a K6 500).
+
+- Hyper fast AC3 compatible encoder.
+
+- simple and very small portable C source code, easy to understand and
+ to modify. It be may the smallest decent MPEG encoder :-)
+
+- optional non real time higher quality encoding (different motion
+ estimators available).
+
+- Audio and Video decoders are in development.
+
+ffmpeg is made of two programs:
+
+* ffmpeg: soft VCR which encodes in real time to several formats. It
+ can also encode from any supported input file format to any input
+ supported format.
+
+* ffserver: high performance live broadcast streaming server based on
+ the ffmpeg core encoders.
+
+2) Documentation
+----------------
+
+* Read doc/ffmpeg.txt and doc/ffserver.txt to learn the basic features.
+
+* Read doc/TODO to know what are the know bugs and missing features.
+
+* Read doc/README.dev if you want to contribute or use the codec or
+ format libraries.
+
+3) Licensing:
+------------
+
+* See the file COPYING. ffmpeg and the associated library are licensed
+ under the GNU General Public License. I may change the license of
+ libavcodec and libav to LGPL if many people ask it (and if they
+ submit good patches!).
+
+* This code should be patent free since it is very simple. I took care
+ to use the same video encoder/decoder core for all formats to show
+ that they really ARE THE SAME except for the encoding huffman codes.
+
+Gerard Lantau (glantau@yahoo.fr).