README.md 1.75 KB
Newer Older
1
FFmpeg README
2
=============
Fabrice Bellard's avatar
Fabrice Bellard committed
3

4
FFmpeg is a collection of libraries and tools to process multimedia content
5
such as audio, video, subtitles and related metadata.
Fabrice Bellard's avatar
Fabrice Bellard committed
6

7
## Libraries
8

9 10 11 12 13
* `libavcodec` provides implementation of a wider range of codecs.
* `libavformat` implements streaming protocols, container formats and basic I/O access.
* `libavutil` includes hashers, decompressors and miscellaneous utility functions.
* `libavfilter` provides a mean to alter decoded Audio and Video through chain of filters.
* `libavdevice` provides an abstraction to access capture and playback devices.
14
* `libswresample` implements audio mixing and resampling routines.
15
* `libswscale` implements color conversion and scaling routines.
Fabrice Bellard's avatar
Fabrice Bellard committed
16

17
## Tools
Fabrice Bellard's avatar
Fabrice Bellard committed
18

19
* [ffmpeg](https://ffmpeg.org/ffmpeg.html) is a command line toolbox to
20
  manipulate, convert and stream multimedia content.
21 22
* [ffplay](https://ffmpeg.org/ffplay.html) is a minimalistic multimedia player.
* [ffprobe](https://ffmpeg.org/ffprobe.html) is a simple analysis tool to inspect
23 24
  multimedia content.
* Additional small tools such as `aviocat`, `ismindex` and `qt-faststart`.
25

26
## Documentation
27

28 29
The offline documentation is available in the **doc/** directory.

30 31
The online documentation is available in the main [website](https://ffmpeg.org)
and in the [wiki](https://trac.ffmpeg.org).
32 33 34

### Examples

35
Coding examples are available in the **doc/examples** directory.
36 37 38

## License

39
FFmpeg codebase is mainly LGPL-licensed with optional components licensed under
40
GPL. Please refer to the LICENSE file for detailed information.
41 42 43 44 45

## Contributing

Patches should be submitted to the ffmpeg-devel mailing list using
`git format-patch` or `git send-email`. Github pull requests should be
Josh de Kock's avatar
Josh de Kock committed
46
avoided because they are not part of our review process and will be ignored.