doc: Add more information in the README
[libav.git] / README.md
CommitLineData
96ce6d6f
LB
1Libav
2=====
3
4Libav is a collection of libraries and tools to process multimedia content
5such as audio, video, subtitles and related metadata.
6
7## Libraries
8
9* `libavcodec` provides implementation of a wider range of codecs.
10* `libavformat` implements streaming protocols, container formats and basic I/O access.
11* `libavutil` includes hashers, decompressors and miscellaneous utility functions.
12* `libavfilter` provides a mean to alter decoded Audio and Video through chain of filters.
13* `libavdevice` provides an abstraction to access capture and playback devices.
14* `libavresample` implements audio mixing and resampling routines.
15* `libswscale` implements color conversion and scaling routines.
16
17## Tools
18
19* [avconv](http://libav.org/avconv.html) is a command line toolbox to
20 manipulate, convert and stream multimedia content.
21* [avplay](http://libav.org/avplay.html) is a minimalistic multimedia player.
22* [avprobe](http://libav.org/avprobe.html) is a simple analisys tool to inspect
23 multimedia content.
24* Additional small tools such as `aviocat`, `ismindex` and `qt-faststart`.
25
26## Documentation
27
28The offline documentation is available in the **doc/** directory.
29
30The online documentation is available in the main [website](http://libav.org)
31and in the [wiki](http://wiki.libav.org).
32
33### Examples
34
35Conding examples are available in the **doc/example** directory.
36
37## License
38
39Libav codebase is mainly LGPL-licensed with optional components licensed under
40GPL. Please refer to the LICENSE file for detailed information.