license/copyright change
[ffmpeg.git] / README
1 1) Introduction
2 ---------------
3
4 ffmpeg is a hyper fast realtime audio/video encoder, a streaming
5 server and a generic audio and video file converter. 
6
7 It can grab from a standard Video4Linux video source and convert it
8 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, Real
18   Video(tm), MPEG4, DIVX and MJPEG compatible bitstreams using the
19   same encoder core.
20
21 - Real time encoding (25 fps in 352x288 on a K6 500) using the
22   video4linux API.
23
24 - Generates I and P frames, which means it is far better than a MJPEG
25   encoder.
26
27 - Hyper fast MPEG audio layer 2 compression (50 times faster than
28   realtime on a K6 500).
29
30 - Hyper fast AC3 compatible encoder.
31
32 - simple and very small portable C source code, easy to understand and
33   to modify. It be may the smallest decent MPEG encoder :-)
34
35 - optional non real time higher quality encoding (different motion
36   estimators available).
37
38 - Audio and Video decoders are in development.
39
40 ffmpeg is made of two programs:
41
42 * ffmpeg: soft VCR which encodes in real time to several formats. It
43   can also encode from any supported input file format to any input
44   supported format.
45
46 * ffserver: high performance live broadcast streaming server based on
47   the ffmpeg core encoders.
48
49 2) Documentation
50 ----------------
51
52 * Read doc/ffmpeg.txt and doc/ffserver.txt to learn the basic features.
53
54 * Read doc/TODO to know what are the know bugs and missing features.
55
56 * Read doc/README.dev if you want to contribute or use the codec or
57   format libraries.
58
59 3) Licensing:
60 ------------
61
62 * See the file COPYING. ffmpeg and the associated library EXCEPT
63   liba52 are licensed under the Lesser GNU General Public
64   License. liba52 is distributed under the GNU General Public License.
65
66 * This code should be patent free since it is very simple. I took care
67   to use the same video encoder/decoder core for all formats to show
68   that they really are mostly the same.
69
70 Fabrice Bellard.