README.md

   1 FFmpeg README
   2 =============
   3
   4 FFmpeg is a collection of libraries and tools to process multimedia content
   5 such 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 * `libswresample` implements audio mixing and resampling routines.
  15 * `libswscale` implements color conversion and scaling routines.
  16
  17 ## Tools
  18
  19 * [ffmpeg](https://ffmpeg.org/ffmpeg.html) is a command line toolbox to
  20   manipulate, convert and stream multimedia content.
  21 * [ffplay](https://ffmpeg.org/ffplay.html) is a minimalistic multimedia player.
  22 * [ffprobe](https://ffmpeg.org/ffprobe.html) is a simple analysis tool to inspect
  23   multimedia content.
  24 * [ffserver](https://ffmpeg.org/ffserver.html) is a multimedia streaming server
  25   for live broadcasts.
  26 * Additional small tools such as `aviocat`, `ismindex` and `qt-faststart`.
  27
  28 ## Documentation
  29
  30 The offline documentation is available in the **doc/** directory.
  31
  32 The online documentation is available in the main [website](https://ffmpeg.org)
  33 and in the [wiki](https://trac.ffmpeg.org).
  34
  35 ### Examples
  36
  37 Coding examples are available in the **doc/examples** directory.
  38
  39 ## License
  40
  41 FFmpeg codebase is mainly LGPL-licensed with optional components licensed under
  42 GPL. Please refer to the LICENSE file for detailed information.
  43
  44 ## Contributing
  45
  46 Patches should be submitted to the ffmpeg-devel mailing list using
  47 `git format-patch` or `git send-email`. Github pull requests should be
  48 avoided because they are not part of our review process and will be ignored.