annotate libmpdemux/README @ 8556:ecff1745d189

Document things from the start. Inspired by a patch from Thomas Jarosch <tomj@simonv.com>.
author diego
date Tue, 24 Dec 2002 18:41:20 +0000
parents d044a69a705d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2339
d044a69a705d some more rtfm
arpi
parents:
diff changeset
1 libmpdemux - MPlayer's input/demuxer layer (C) A'rpi / MPlayer team
d044a69a705d some more rtfm
arpi
parents:
diff changeset
2 ==========================================
d044a69a705d some more rtfm
arpi
parents:
diff changeset
3
d044a69a705d some more rtfm
arpi
parents:
diff changeset
4 NOTE: It is not in the final form yet! API may change...
d044a69a705d some more rtfm
arpi
parents:
diff changeset
5
d044a69a705d some more rtfm
arpi
parents:
diff changeset
6 Stream input layer:
d044a69a705d some more rtfm
arpi
parents:
diff changeset
7 ===================
d044a69a705d some more rtfm
arpi
parents:
diff changeset
8 #include "stream.h"
d044a69a705d some more rtfm
arpi
parents:
diff changeset
9
d044a69a705d some more rtfm
arpi
parents:
diff changeset
10 Supported modes:
d044a69a705d some more rtfm
arpi
parents:
diff changeset
11 - file (by 2048 byte sectors) including STDIN (if filename "-")
d044a69a705d some more rtfm
arpi
parents:
diff changeset
12 - VCD disk (by 2324 byte mode2 sectors)
d044a69a705d some more rtfm
arpi
parents:
diff changeset
13 - network (buggy, mpg/avi download-like streaming works, asf not)
d044a69a705d some more rtfm
arpi
parents:
diff changeset
14 - DVD disk using with libdvdread 0.8 or 0.9
d044a69a705d some more rtfm
arpi
parents:
diff changeset
15
d044a69a705d some more rtfm
arpi
parents:
diff changeset
16 Note: optional CACHE layer with read-ahead and seek-back buffer (not finished)
d044a69a705d some more rtfm
arpi
parents:
diff changeset
17
d044a69a705d some more rtfm
arpi
parents:
diff changeset
18 Demuxer layer:
d044a69a705d some more rtfm
arpi
parents:
diff changeset
19 ==============
d044a69a705d some more rtfm
arpi
parents:
diff changeset
20 #include "demuxer.h"
d044a69a705d some more rtfm
arpi
parents:
diff changeset
21
d044a69a705d some more rtfm
arpi
parents:
diff changeset
22 Supported formats:
d044a69a705d some more rtfm
arpi
parents:
diff changeset
23 - MPEG (PS,PES,VOB,ES), including VCD disk image files (.ISO/.BIN)
d044a69a705d some more rtfm
arpi
parents:
diff changeset
24 - AVI, with or without index, interleaved and non-interleaved formats
d044a69a705d some more rtfm
arpi
parents:
diff changeset
25 - ASF v1.0 (aka .wmv/.wma)
d044a69a705d some more rtfm
arpi
parents:
diff changeset
26 - Quicktime MOV - including compressed headers, CBR and VBR
d044a69a705d some more rtfm
arpi
parents:
diff changeset
27
d044a69a705d some more rtfm
arpi
parents:
diff changeset
28 Others:
d044a69a705d some more rtfm
arpi
parents:
diff changeset
29 =======
d044a69a705d some more rtfm
arpi
parents:
diff changeset
30 #include "stheader.h" - audio and video stream structs used by header parsers
d044a69a705d some more rtfm
arpi
parents:
diff changeset
31 #include "parse_es.h" - Mpeg ES stream parser
d044a69a705d some more rtfm
arpi
parents:
diff changeset
32
d044a69a705d some more rtfm
arpi
parents:
diff changeset
33 Using it outside of mplayer tree:
d044a69a705d some more rtfm
arpi
parents:
diff changeset
34 =================================
d044a69a705d some more rtfm
arpi
parents:
diff changeset
35 It uses a few things from mplayer tree:
d044a69a705d some more rtfm
arpi
parents:
diff changeset
36 config.h - system-dependent options, see ./configure
d044a69a705d some more rtfm
arpi
parents:
diff changeset
37 mp_msg.c/.h - mplayer's message printing code - copy it or impement your own
d044a69a705d some more rtfm
arpi
parents:
diff changeset
38 help_mp.h - error/info message texts
d044a69a705d some more rtfm
arpi
parents:
diff changeset
39 bswap.h - little/big endian conversion
d044a69a705d some more rtfm
arpi
parents:
diff changeset
40
d044a69a705d some more rtfm
arpi
parents:
diff changeset
41 If you use it in your project - please tell me!
d044a69a705d some more rtfm
arpi
parents:
diff changeset
42
d044a69a705d some more rtfm
arpi
parents:
diff changeset
43 A'rpi - arpi@thot.banki.hu