RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity
mpv/README.md

138 lines
5.5 KiB
Markdown
Raw Normal View History

README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
mpv
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
===
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
Overview
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
--------
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
**mpv** is a movie player based on MPlayer and mplayer2. It supports a wide
variety of video file formats, audio and video codecs, and subtitle types.
If you are wondering what's different from mplayer2 and MPlayer you can read
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
more about the [changes][changes].
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
Compilation
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
-----------
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
Compiling with full features requires development files for several
switch the build system to waf This commit adds a new build system based on waf. configure and Makefile are deprecated effective immediately and someday in the future they will be removed (they are still available by running ./old-configure). You can find how the choice for waf came to be in `DOCS/waf-buildsystem.rst`. TL;DR: we couldn't get the same level of abstraction and customization with other build systems we tried (CMake and autotools). For guidance on how to build the software now, take a look at README.md and the cross compilation guide. CREDITS: This is a squash of ~250 commits. Some of them are not by me, so here is the deserved attribution: - @wm4 contributed some Windows fixes, renamed configure to old-configure and contributed to the bootstrap script. Also, GNU/Linux testing. - @lachs0r contributed some Windows fixes and the bootstrap script. - @Nikoli contributed a lot of testing and discovered many bugs. - @CrimsonVoid contributed changes to the bootstrap script.
2013-07-16 11:28:28 +00:00
external libraries. Below is a list of some important requirements.
The mpv build system uses *waf* but we don't store it in your source tree. The
script './bootstrap.py' will download the latest version of waf that was tested
with the build system.
For a list of the available build options use `./waf configure --help`. If
you think you have support for some feature installed but configure fails to
detect it, the file `build/config.log` may contain information about the
reasons for the failure.
build: hide duplicate options from `--help` Hide --enable variants from [autodetect]'ed options and --enable/--disable variants for [enable]'d/[disable]'d options. The hidden options are still usable, just hidden for more readability.
2013-12-14 13:59:07 +00:00
NOTE: To avoid cluttering the output with unreadable spam, `--help` only shows
one of the two switches for each option. If the option is autodetected by
default, the `--disable-***` switch is printed; if the option is disabled by
default, the `--enable-***` switch is printed. Either way, you can use
`--enable-***` or `--disable-**` regardless of what is printed by `--help`.
README: mention build result being located at build/mpv
2013-11-23 10:14:22 +00:00
To build the software you can use `./waf build`: the result of the compilation
will be located in `build/mpv`. You can use `./waf install` to install mpv
to the *prefix* after it is compiled.
switch the build system to waf This commit adds a new build system based on waf. configure and Makefile are deprecated effective immediately and someday in the future they will be removed (they are still available by running ./old-configure). You can find how the choice for waf came to be in `DOCS/waf-buildsystem.rst`. TL;DR: we couldn't get the same level of abstraction and customization with other build systems we tried (CMake and autotools). For guidance on how to build the software now, take a look at README.md and the cross compilation guide. CREDITS: This is a squash of ~250 commits. Some of them are not by me, so here is the deserved attribution: - @wm4 contributed some Windows fixes, renamed configure to old-configure and contributed to the bootstrap script. Also, GNU/Linux testing. - @lachs0r contributed some Windows fixes and the bootstrap script. - @Nikoli contributed a lot of testing and discovered many bugs. - @CrimsonVoid contributed changes to the bootstrap script.
2013-07-16 11:28:28 +00:00
NOTE: Using the old build system (with `./old-configure`) should still work,
but will be removed in a future version of mpv.
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
Essential dependencies (incomplete list):
- gcc or clang
- X development headers (xlib, X extensions, libvdpau, libGL, libXv, ...)
- Audio output development headers (libasound, pulseaudio)
README: split list of dependencies And make some additions. I'm not really sure why we list dependencies that are not ours, but that of external libraries. Still might be useful, though.
2014-03-12 16:02:57 +00:00
- FFmpeg libraries (libavutil libavcodec libavformat libswscale libavresample)
README: mention minimum FFmpeg/Libav versions
2014-04-15 17:53:14 +00:00
At least FFmpeg 2.1.4 or Libav 10 is required.
README: split list of dependencies And make some additions. I'm not really sure why we list dependencies that are not ours, but that of external libraries. Still might be useful, though.
2014-03-12 16:02:57 +00:00
- libjpeg (for screenshots)
Drop libquvi support No development activity (or even any sign of life) for almost a year. A replacement based on youtube-dl will probably be provided before the next mpv release. Ask on the IRC channel if you want to test. Simplify the Lua check too: libquvi linking against a different Lua version than mpv was a frequent issue, but with libquvi gone, no direct dependency uses Lua, and such a clash is rather unlikely.
2014-10-25 18:07:44 +00:00
- Lua (strictly speaking optional, but required for the OSC pseudo-GUI)
README: split list of dependencies And make some additions. I'm not really sure why we list dependencies that are not ours, but that of external libraries. Still might be useful, though.
2014-03-12 16:02:57 +00:00
Libass dependencies:
- gcc or clang, yasm on x86 and x86_64
- fribidi, freetype, fontconfig development headers (for libass)
FFmpeg dependencies:
- gcc or clang, yasm on x86 and x86_64
- OpenSSL (has to be explicitly enabled when compiling ffmpeg)
README: small addition to encoding dependencies
2013-07-15 19:43:14 +00:00
- libx264/libmp3lame/libfdk-aac if you want to use encoding (has to be
explicitly enabled when compiling ffmpeg)
README: split list of dependencies And make some additions. I'm not really sure why we list dependencies that are not ours, but that of external libraries. Still might be useful, though.
2014-03-12 16:02:57 +00:00
- Libav also works, but some features will not work. (See section below.)
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
Most of the above libraries are available in suitable versions on normal
Linux distributions. However FFmpeg is an exception (distro versions may be
too old to work at all or work well). For that reason you may want to use
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
the separately available build wrapper ([mpv-build][mpv-build]) that first compiles FFmpeg
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
libraries and libass, and then compiles the player statically linked against
those.
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
If you are running Mac OSX and using homebrew we provide [homebrew-mpv][homebrew-mpv], an up
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
to date formula that compiles mpv with sensible dependencies and defaults for
OSX.
README: add a link to the wiki about the FFmpeg vs. Libav issue
2013-10-25 19:23:22 +00:00
FFmpeg vs. Libav
----------------
Generally, mpv should work with the latest release as well as the git version
of both FFmpeg and Libav. But FFmpeg is preferred, and some mpv features work
with FFmpeg only. See the [wiki article][ffmpeg_vs_libav] about the issue.
README: describe release cycle
2014-05-20 00:31:44 +00:00
Release cycle
-------------
DOCS: add document describing the release policy and procedure
2014-06-24 11:36:15 +00:00
Every few months, a new release is cut off of the master branch and is assigned
a 0.X.0 version number.
As part of the maintenance process, minor releases are made, which are assigned
0.X.Y version numbers. Minor releases contain bug fixes only. They never merge
the master branch, and no features are added to it. Only the latest release is
maintained.
The goal of releases is to provide stability and an unchanged base for the sake
of Linux distributions. If you want the newest features, just use the master
branch, which is stable most of the time, except sometimes, when it's not.
README: describe release cycle
2014-05-20 00:31:44 +00:00
Releases other than the latest release are unsupported and unmaintained.
DOCS: add document describing the release policy and procedure
2014-06-24 11:36:15 +00:00
See the [release policy document][release-policy] for more information.
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
Bug reports
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
-----------
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
README: update Contact info with Mailing Lists
2013-09-13 21:14:20 +00:00
Please use the [issue tracker][issue-tracker] provided by GitHub to send us bug
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
reports or feature requests.
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
Contributing
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
------------
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
For small changes you can just send us pull requests through GitHub. For bigger
changes come and talk to us on IRC before you start working on them. It will
make code review easier for both parties later on.
README: describe release cycle
2014-05-20 00:31:44 +00:00
Contact
-------
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
README: cleanup contact section I spotted to the grammatically incorrect "it's", and ended up redoing parts of the section.
2014-11-22 13:37:57 +00:00
Most activity happens on the IRC channel and the github issue tracker. The
mailing lists are mostly unused.
README: update Contact info with Mailing Lists
2013-09-13 21:14:20 +00:00
README: cleanup contact section I spotted to the grammatically incorrect "it's", and ended up redoing parts of the section.
2014-11-22 13:37:57 +00:00
- **Github issue tracker**: [issue tracker][issue-tracker] (report bugs here)
- **User IRC Channel**: `#mpv-player` on `irc.freenode.net`
- **Developer IRC Channel**: `#mpv-player-dev` on `irc.freenode.net`
README: update Contact info with Mailing Lists
2013-09-13 21:14:20 +00:00
- **Users Mailing List**: `mpv-users@googlegroups.com` ([Archive / Subscribe][mpv-users]).
- **Devel Mailing List**: `mpv-devel@googlegroups.com` ([Archive / Subscribe][mpv-devel])
README: cleanup contact section I spotted to the grammatically incorrect "it's", and ended up redoing parts of the section.
2014-11-22 13:37:57 +00:00
To contact the `mpv` team in private write to `mpv-team@googlegroups.com`. Use
only if discretion is required.
README: add a new one using ReST Hopefully this is a little more useful for people opening the GitHub project page and can serve the role of a poor man's project website.
2012-11-13 06:25:28 +00:00
DOCS: remove en/ sub-directory This additional sub-directory doesn't serve any purpose anymore. Get rid of it.
2014-06-20 21:01:12 +00:00
[changes]: https://github.com/mpv-player/mpv/blob/master/DOCS/man/changes.rst
add Travis-CI integration Travis-CI [1] is a continous integration cloud service. It is free for open-source projects and tigthly integrated tiwh GitHub so there is really no reason for us not use it. :) For now we are going to do a total of 4 builds, mainly to test ffmpeg/libav API breakage: * ffmpeg-stable, libass-stable * ffmpeg-git, libass-stable * libav-stable, libass-stable * libav-git, libass-stable The compiler that is currently used is clang for two reasons: * running 8 build targets would be quite wasteful and take a long time * clang is less tested and used during development than gcc (especially on linux) Currently Travis doesn't support OS X environments alongside Linux ones [2]. When it will, we will add a fifth build target to test OS X compilation breakage. README was moved to markdown to add the little build status image. I ran some tests with my GitHub fork and couldn't get images to show up using ReStructured Text. [1]: https://github.com/travis-ci/travis-ci [2]: travis-ci/travis-ci#216
2013-05-19 07:19:29 +00:00
[mpv-build]: https://github.com/mpv-player/mpv-build
[homebrew-mpv]: https://github.com/mpv-player/homebrew-mpv
README: update Contact info with Mailing Lists
2013-09-13 21:14:20 +00:00
[issue-tracker]: https://github.com/mpv-player/mpv/issues
[mpv-users]: https://groups.google.com/forum/?hl=en#!forum/mpv-users
[mpv-devel]: https://groups.google.com/forum/?hl=en#!forum/mpv-devel
README: add a link to the wiki about the FFmpeg vs. Libav issue
2013-10-25 19:23:22 +00:00
[ffmpeg_vs_libav]: https://github.com/mpv-player/mpv/wiki/FFmpeg-versus-Libav
README: fix link to release policy document
2014-06-30 21:23:50 +00:00
[release-policy]: https://github.com/mpv-player/mpv/blob/master/DOCS/release-policy.md