Initial revision
[ffmpeg.git] / README
1 FFmpeg version 0.9 - (c) 2000 Gerard Lantau.
2
3 1) Introduction
4 ---------------
5
6 ffmpeg is a hyper fast realtime audio/video encoder and streaming
7 server. It can grab from a standard Video4Linux video source and
8 convert it into several file formats based on DCT/motion compensation
9 encoding. Sound is compressed in MPEG audio layer 2 or using an AC3
10 compatible stream.
11
12 What makes ffmpeg interesting ?
13
14 - Innovative streaming technology : multiformat, real time encoding,
15   simple configuration.
16
17 - Simple and efficient video encoder: outputs MPEG1, H263 and Real
18   Video(tm) compatible bitstreams using the same encoder core.
19
20 - Real time encoding (25 fps in 352x288 on a K6 500) using the video4linux API.
21
22 - Generates I and P frames, which means it is far better than a MJPEG
23   encoder.
24
25 - Hyper fast MPEG audio layer 2 compression (50 times faster than
26   realtime on a K6 500).
27
28 - Hyper fast AC3 compatible encoder.
29
30 - simple and very small portable C source code, easy to understand and
31   to modify. It be may the smallest decent MPEG encoder :-)
32
33 ffmpeg is made of two programs:
34
35 * ffmpeg: soft VCR which encodes in real time to several formats.
36
37 * ffserver: live broadcast streaming server based on the ffmpeg core
38 encoders.
39
40 2) Documentation
41 ----------------
42
43 read doc/ffmpeg.txt and doc/ffserver.txt to learn the basic features.
44
45 read ffmpeg
46
47 3) Licensing:
48 ------------
49
50 * See the file COPYING. ffmpeg is licensed under the GNU General
51   Public License.
52
53 * Source code from third parties: The DCT code comes from the Berkeley
54   MPEG decoder and the JPEG encoder. 
55
56 * This code should be patent free since it is very simple. I took care
57   to use the same video encoder core for all formats to show that they
58   really ARE THE SAME except for the encoding huffman codes.
59
60 Gerard Lantau (glantau@users.sourceforge.net).