* Add the gop_size to the video parameters. Also the audio framesize.
[ffmpeg.git] / doc / ffserver.txt
1 *************** FFserver live broadcast server *****************
2
3 0) Introduction
4
5 ffserver is a streaming server for both audio and video. It supports
6 several live feeds, streaming from files and time shifting on live
7 feeds (you can seek to positions in the past on each live feed,
8 provided you specify a big enough feed storage in ffserver.conf).
9
10 1) Quick help
11
12 - First you must ensure that your grab system is OK. Verify with
13   'xawtv' that your TV card is tuned on a correct video source.
14
15 - Try with ffmpeg that you can record correctly. For example:
16
17   ffmpeg /tmp/a.mpg
18
19 will record a ten seconds mpeg file from your TV card and audio
20 card. Use for example the mpegtv player or MPlayer to view the created
21 MPEG file.
22
23 - Launch ffserver on your PC with the sample config file:
24
25   ffserver -f doc/ffserver.conf
26
27 - Verify with your browser that ffserver is working correctly. For
28   that purpose, explore: http://localhost:8090/stat.html .
29
30 - Now launch ffmpeg to do real time encoding :
31
32   ffmpeg http://localhost:8090/feed1.ffm
33
34 - Then, use your favorite players to see each generated stream:
35
36   mtvp http://localhost:8090/test1.mpg
37
38   mpg123 http://localhost:8090/test.mp2
39
40   netscape http://localhost:8090/test.swf
41
42   realplayer http://localhost:8090/test.rm
43
44   etc...
45
46   Note that ffserver generate multiple streams in multiple formats AT
47   THE SAME TIME. It should be able to handle hundreds of users at the
48   same time if you internet connection is fast enough.
49
50 - Now you can configure ffserver for your real needs. Edit the
51   ffserver.conf file to use only the formats you want. Read the ffmpeg
52   documentation (ffmpeg.txt) to learn more about the codec and format
53   stuff.
54
55 - Report any bug you find (and the fix if you have it!).
56
57 2) URL Format
58
59   ffserver supports that you seek in some formats. The syntax is to
60   add a '?' option to the URL. Only the 'date' option is supported. 
61
62   The date format is [YYYY-MM-DDT][[HH:]MM:]SS[.m...] (clost to ISO
63   date format). For live streams, the date is absolute and give in
64   GMT. If the day is not specified, the current day is used.
65
66   example: 
67
68      mpg123 http://localhost:8090/test.mp2?date=10:00
69
70   play the stream starting at 10:00 AM GMT today.
71
72      mpg123 http://localhost:8090/test.mp2?date=2001-06-23T23:00
73
74   is also a valid date.
75
76   For file streams, the date is relative to the start of the file. No
77   day can be specified.
78
79