Release 0.16.0

Merge branch 'master' into release/current
Release 0.15.0
2016-02-29 00:22:04 +01:00 · 2016-02-28 23:31:51 +01:00 · 2016-01-18 07:28:12 +01:00 · 2016-01-18 07:27:03 +01:00 · 2015-12-11 19:20:29 +01:00 · 2015-12-11 18:33:38 +01:00
905 changed files with 83999 additions and 153079 deletions
@@ -1,10 +0,0 @@
-# To use this config on you editor, follow the instructions at:
-# http://editorconfig.org
-
-root = true
-
-[*]
-charset = utf-8
-insert_final_newline = true
-indent_style = space
-indent_size = 4
@@ -1,16 +0,0 @@
---
-name: 'README: DO NOT IGNORE OR DELETE THE ISSUE TEMPLATE'
-about: 'Chose and fill out one of the following templates!'
-title: ''
-labels: priority:ignored-issue-template
-assignees: ''
-
---
-
-We ask you to not ignore the issue template. Fill it out as good and correct as
-possible. Issues that don't adhere to our request will be closed for ignoring
-the issue template. This is because analyzing a bug without a log file is harder
-than necessary. Low quality bug reports are noise.
-
-Please go back and chose the proper issue template. Opening issues with this
-template will be closed immediately.
@@ -1,49 +0,0 @@
---
-name: 'Report a Linux Issue'
-about: 'Create a report for a runtime related Linux Issue'
-title: ''
-labels: 'os:linux'
-assignees: ''
-
---
-
-### Important Information
-
-Provide following Information:
- mpv version
- Linux Distribution and Version
- Source of the mpv binary
- If known which version of mpv introduced the problem
- Window Manager and version
- GPU driver and version
- Possible screenshot or video of visual glitches
-
-If you're not using git master or the latest release, update.
-Releases are listed here: https://github.com/mpv-player/mpv/releases
-
-### Reproduction steps
-
-Try to reproduce your issue with --no-config first. If it isn't reproducible
-with --no-config try to first find out which option or script causes your issue.
-
-Describe the reproduction steps as precise as possible. It's very likely that
-the bug you experience wasn't reproduced by the developer because the workflow
-differs from your own.
-
-### Expected behavior
-
-### Actual behavior
-
-### Log file
-
-Make a log file made with -v -v or --log-file=output.txt, paste it to
-https://0x0.st/ or attach it to the github issue, and replace this text with a
-link to it.
-
-The issue will be closed for ignoring the issue template.
-
-### Sample files
-
-Sample files needed to reproduce this issue can be uploaded to https://0x0.st/
-or similar sites. (Only needed if the issue cannot be reproduced without it.)
-Do not use garbage like "cloud storage", especially not Google Drive.
@@ -1,51 +0,0 @@
---
-name: 'Report a macOS Issue'
-about: 'Create a report for a runtime related macOS Issue'
-title: ''
-labels: 'os:mac'
-assignees: ''
-
---
-
-### Important Information
-
-Provide following Information:
- mpv version
- macOS Version
- Source of the mpv binary or bundle
- If known which version of mpv introduced the problem
- Possible screenshot or video of visual glitches
-
-If you're not using git master or the latest release, update.
-Releases are listed here: https://github.com/mpv-player/mpv/releases
-
-### Reproduction steps
-
-Try to reproduce your issue with --no-config first. If it isn't reproducible
-with --no-config try to first find out which option or script causes your issue.
-
-Describe the reproduction steps as precise as possible. It's very likely that
-the bug you experience wasn't reproduced by the developer because the workflow
-differs from your own.
-
-### Expected behavior
-
-### Actual behavior
-
-### Log file
-
-Make a log file made with -v -v or --log-file=output.txt. If you use the Bundle
-from a version later than 0.32 a default log is created for your last run at
-~/Library/Logs/mpv.log. You can jump to that file via the Help > Show log File…
-menu. Paste the log to https://0x0.st/ or attach it to the github issue, and
-replace this text with a link to it.
-
-In the case of a crash please provide the macOS Crash Report (Backtrace).
-
-The issue will be closed for ignoring the issue template.
-
-### Sample files
-
-Sample files needed to reproduce this issue can be uploaded to https://0x0.st/
-or similar sites. (Only needed if the issue cannot be reproduced without it.)
-Do not use garbage like "cloud storage", especially not Google Drive.
@@ -1,47 +0,0 @@
---
-name: 'Report a Windows Issue'
-about: 'Create a report for a runtime related Windows Issue'
-title: ''
-labels: 'os:win'
-assignees: ''
-
---
-
-### Important Information
-
-Provide following Information:
- mpv version
- Windows Version
- Source of the mpv binary
- If known which version of mpv introduced the problem
- Possible screenshot or video of visual glitches
-
-If you're not using git master or the latest release, update.
-Releases are listed here: https://github.com/mpv-player/mpv/releases
-
-### Reproduction steps
-
-Try to reproduce your issue with --no-config first. If it isn't reproducible
-with --no-config try to first find out which option or script causes your issue.
-
-Describe the reproduction steps as precise as possible. It's very likely that
-the bug you experience wasn't reproduced by the developer because the workflow
-differs from your own.
-
-### Expected behavior
-
-### Actual behavior
-
-### Log file
-
-Make a log file made with -v -v or --log-file=output.txt, paste it to
-https://0x0.st/ or attach it to the github issue, and replace this text with a
-link to it.
-
-The issue will be closed for ignoring the issue template.
-
-### Sample files
-
-Sample files needed to reproduce this issue can be uploaded to https://0x0.st/
-or similar sites. (Only needed if the issue cannot be reproduced without it.)
-Do not use garbage like "cloud storage", especially not Google Drive.
@@ -1,43 +0,0 @@
---
-name: 'Report a different Issue'
-about: 'Create a report for a runtime related Issue'
-title: ''
-labels: ''
-assignees: ''
-
---
-
-### Important Information
-
-Provide following Information:
- mpv version
- Platform and Version
- Source of the mpv binary
-
-If you're not using git master or the latest release, update.
-Releases are listed here: https://github.com/mpv-player/mpv/releases
-
-### Reproduction steps
-
-Try to reproduce your issue with --no-config first. If it isn't reproducible
-with --no-config try to first find out which option or script causes your issue.
-
-Describe the reproduction steps as precise as possible. It's very likely that
-the bug you experience wasn't reproduced by the developer because the workflow
-differs from your own.
-
-### Expected behavior
-
-### Actual behavior
-
-### Log file
-
-Make a log file made with -v -v or --log-file=output.txt, paste it to
-https://0x0.st/ or attach it to the github issue, and replace this text with a
-link to it.
-
-### Sample files
-
-Sample files needed to reproduce this issue can be uploaded to https://0x0.st/
-or similar sites. (Only needed if the issue cannot be reproduced without it.)
-Do not use garbage like "cloud storage", especially not Google Drive.
@@ -1,30 +0,0 @@
---
-name: 'Report a build Problem'
-about: 'Create a report for a build related Issue'
-title: ''
-labels: 'core:waf'
-assignees: ''
-
---
-
-### mpv version and platform versions
-
-If you're not using git master or the latest release, update.
-Releases are listed here: https://github.com/mpv-player/mpv/releases
-
-### Reproduction steps
-
-Describe the reproduction steps as precise as possible. It's very likely that
-the bug you experience wasn't reproduced by the developer because the workflow
-differs from your own.
-
-### Expected behavior
-
-### Actual behavior
-
-### Log file
-
-Upload build/config.log or ./waf configure output to https://0x0.st/ or attach
-it to the github issue, and replace this text with a link to it.
-
-The issue will be closed for ignoring the issue template.
@@ -1,22 +0,0 @@
---
-name: 'Request a new Feature'
-about: 'Create a request for a new feature'
-title: ''
-labels: 'meta:feature-request'
-assignees: ''
-
---
-
-Before requesting a new feature make sure it hasn't been requested yet.
-https://github.com/mpv-player/mpv/labels/meta%3Afeature-request
-
-### Expected behavior of the wanted feature
-
-### Alternative behavior of the wanted feature
-
-### Log file
-
-Even if you think it's not necessary at first, it might help us later to find
-possible issues. Make a log file made with -v -v or --log-file=output.txt, paste
-it to https://0x0.st/ or attach it to the github issue, and replace this text
-with a link to it.
@@ -1,25 +0,0 @@
---
-name: 'Ask a Question'
-about: 'Ask a question about mpv'
-title: ''
-labels: 'meta:question'
-assignees: ''
-
---
-
-Don't ask questions about issues, errors or problems you have and instead open
-a proper issue with the right template from the previous selection.
-
-This template is meant for questions about the workings of mpv, to clarify about
-unspecified behaviour of options or command, or anything else that is not well
-described and needs clarification.
-
-Before asking a question make sure it hasn't been asked or answered yet.
-https://github.com/mpv-player/mpv/labels/meta%3Aquestion
-
-### Log file
-
-Even if you think it's not necessary at first, it might help us later to find
-possible issues. Make a log file made with -v -v or --log-file=output.txt, paste
-it to https://0x0.st/ or attach it to the github issue, and replace this text
-with a link to it.
@@ -1,9 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: mpv IRC channel
-    url: https://mpv.io/community/
-    about: Feel free to ask questions here irc://irc.libera.chat/mpv
-  - name: mpv IRC developer channel
-    url: https://mpv.io/community/
-    about: Ask questions related to the development of mpv here
-           irc://irc.libera.chat/mpv-devel
@@ -1,5 +0,0 @@
-Read this before you submit this pull request:
-https://github.com/mpv-player/mpv/blob/master/DOCS/contribute.md
-
-Reading this link and following the rules will get your pull request reviewed
-and merged faster. Nobody wants lazy pull requests.
@@ -1,207 +0,0 @@
-name: build
-
-on:
-  push:
-    branches:
-      - master
-      - ci
-      - 'release/**'
-  pull_request:
-    branches: [master]
-
-jobs:
-  mingw:
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        target: [i686-w64-mingw32, x86_64-w64-mingw32]
-    steps:
-      - uses: actions/checkout@v3
-
-      # Increase -N suffix here to force full rebuild after changes
-      - uses: actions/cache@v3
-        with:
-          path: mingw_prefix/
-          key: "${{ matrix.target }}-6"
-
-      - name: Install dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y autoconf automake pkg-config g++-mingw-w64 gcc-multilib meson nasm
-          ./bootstrap.py
-
-      - name: Build libraries
-        run: |
-          ./ci/build-mingw64.sh
-        env:
-          TARGET: ${{ matrix.target }}
-
-      - name: Build with meson
-        run: |
-          ./ci/build-mingw64.sh meson
-        env:
-          TARGET: ${{ matrix.target }}
-
-      - name: Print meson log
-        if: ${{ failure() }}
-        run: |
-          cat ./build/meson-logs/meson-log.txt
-
-      - name: Build with waf
-        run: |
-          ./ci/build-mingw64.sh waf pack
-        env:
-          TARGET: ${{ matrix.target }}
-
-      - name: Print waf log
-        if: ${{ failure() }}
-        run: |
-          cat ./build/config.log
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: mpv-${{ matrix.target }}
-          path: mpv-git-*.zip
-
-  macos:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        cc:
-          - "clang"
-        os:
-          - "macos-11"
-          - "macos-12"
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Remove stray upstream python binary symlinks under /usr/local
-        run: |
-          find /usr/local/bin -lname '*/Library/Frameworks/Python.framework/*' -delete -print
-          brew unlink python && brew link --overwrite python
-
-      - name: Install dependencies
-        run: |
-          brew update
-          brew install autoconf automake pkg-config libtool python freetype fribidi little-cms2 lua@5.1 libass ffmpeg meson
-
-      - name: Build with meson
-        run: |
-          ./ci/build-macos.sh meson
-        env:
-          CC: "${{ matrix.cc }}"
-          TRAVIS_OS_NAME: "${{ matrix.os }}"
-
-      - name: Print meson log
-        if: ${{ failure() }}
-        run: |
-          cat ./build/meson-logs/meson-log.txt
-
-      - name: Build with waf
-        run: |
-          ./ci/build-macos.sh waf
-        env:
-          CC: "${{ matrix.cc }}"
-          TRAVIS_OS_NAME: "${{ matrix.os }}"
-
-      - name: Print waf log
-        if: ${{ failure() }}
-        run: |
-          cat ./build/config.log
-
-  linux:
-    runs-on: "ubuntu-22.04"
-    container:
-      image: "registry.opensuse.org/home/mia/images/images/mpv-ci:stable-deps"
-      env:
-        CC: "${{ matrix.cc }}"
-    strategy:
-      matrix:
-        cc:
-          - "gcc"
-          - "clang"
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Install dependencies
-        run: |
-          ./bootstrap.py
-          # workaround to avoid "fatal: unsafe repository" error
-          git config --global --add safe.directory "$GITHUB_WORKSPACE"
-
-      - name: Build with meson
-        run: |
-          ./ci/build-tumbleweed.sh meson
-
-      - name: Print meson log
-        if: ${{ failure() }}
-        run: |
-          cat ./build/meson-logs/meson-log.txt
-
-      - name: Build with waf
-        run: |
-          ./ci/build-tumbleweed.sh waf
-
-      - name: Print waf log
-        if: ${{ failure() }}
-        run: |
-          cat ./build/config.log
-
-  freebsd:
-    runs-on: macos-12 # until https://github.com/actions/runner/issues/385
-    steps:
-    - uses: actions/checkout@v3
-    - name: Test in FreeBSD VM
-      uses: vmactions/freebsd-vm@v0
-      with:
-        usesh: true
-        prepare: |
-            # Requested in ci/build-freebsd.sh
-            pkg install -y \
-                cmake \
-                evdev-proto \
-                ffmpeg \
-                libplacebo \
-                libxkbcommon \
-                libXinerama \
-                libxpresent \
-                luajit \
-                meson \
-                openal-soft \
-                pkgconf \
-                python3 \
-                sdl2 \
-                sndio \
-                vulkan-headers \
-                wayland-protocols \
-                #
-            # Optionally auto-enabled
-            pkg install -y \
-                alsa-lib \
-                jackit \
-                libXv \
-                libarchive \
-                libbluray \
-                libcaca \
-                libcdio-paranoia \
-                libdvdnav \
-                mujs \
-                pipewire \
-                pulseaudio \
-                rubberband \
-                sekrit-twc-zimg \
-                uchardet \
-                v4l_compat \
-                #
-        run: |
-          ./ci/build-freebsd.sh
-
-    - name: Print meson log
-      if: ${{ failure() }}
-      run: |
-        cat ./build/meson-logs/meson-log.txt
-
-    - name: Print waf log
-      if: ${{ failure() }}
-      run: |
-        cat ./build/config.log
@@ -15,11 +15,11 @@
 /tags
 /TAGS
 /video/out/x11_icon.inc
+/video/out/opengl/nnedi3_weights.inc
 /demux/ebml_defs.c
 /demux/ebml_types.h
 /sub/osd_font.h
 /player/lua/*.inc
-/player/builtin_conf.inc
 /DOCS/man/mpv.1
 /DOCS/man/mpv.aux
 /DOCS/man/mpv.log
@@ -36,5 +36,3 @@

 /old_build
 /Makefile
-
-/subprojects
@@ -0,0 +1,62 @@
+language: c
+
+os:
+  - linux
+  - osx
+env:
+  matrix:
+    - LIBAV=libav-stable
+    - LIBAV=libav-git
+    - LIBAV=ffmpeg-stable
+    - LIBAV=ffmpeg-git
+  global:
+    # Coverity token
+    - secure: "H21mSRlMhk4BKS0xHZvCFGJxteCP0hRVUxTuNfM2Z9HBsyutuLEYMtViLO86VtM+Tqla3xXPzUdS4ozLwI72Ax/5ZUDXACROj73yW6QhFB5D6rLut12+FjqC7M33Qv2hl0xwgNBmR5dsm1ToP37+Wn+ecJQNvN8fkTXF+HVzOEw="
+compiler:
+  - clang
+  - gcc
+
+branches:
+  only:
+    - master
+    - ci
+    - coverity_scan
+
+matrix:
+  exclude:
+    - os: osx
+      env: LIBAV=libav-stable
+    - os: osx
+      env: LIBAV=libav-git
+    - os: osx
+      env: LIBAV=ffmpeg-git
+    - os: osx
+      compiler: gcc
+    - os: linux
+      env: LIBAV=ffmpeg-stable
+    - os: linux
+      compiler: clang
+
+before_install: ./travis-deps libass-stable $LIBAV
+script:
+  - ./bootstrap.py
+  - ./waf configure
+  - ./waf build
+
+notifications:
+  email: false
+  irc:
+    channels:
+      - "irc.freenode.org#mpv-devel"
+    on_success: change
+    on_failure: always
+
+addons:
+  coverity_scan:
+    project:
+      name: "mpv-player/mpv"
+      description: "Build submitted via Travis CI"
+    notification_email: mpv-team@googlegroups.com
+    build_command_prepend: "./bootstrap.py && ./waf configure"
+    build_command:   "./waf build"
+    branch_pattern: coverity_scan
@@ -0,0 +1,32 @@
+Reporting bugs
+==============
+
+- State your platform and mpv version.
+- Make sure you're actually using the latest mpv release. Linux distributions
+  in particular love redistributing ancient and unmaintained mpv releases.
+- Attach a log file made with ``-v`` or ``--log-file=output.txt``.
+- Avoid attaching text files packed in archive files (zip/rar/...), unless
+  explicitly asked so. There are better means, such as using http://sprunge.us
+- If you think this is file specific, upload a sample file and link it.
+- Don't report multiple unrelated/barely related bugs in one issue.
+- If you don't get a reply after days, be sure to post a new message to the
+  issue - it could have been overlooked or forgotten.
+- Read: https://mpv.io/bug-reports/
+
+Asking questions
+================
+
+Preferably, asking questions should be done via IRC (#mpv on irc.freenode.net),
+but asking questions by opening a github issue is also barely tolerated.
+
+When asking on IRC (#mpv on irc.freenode.net), don't ask to ask, just state
+your problem. Stay long enough until someone gets a chance to reply. Sometimes
+it can take hours.
+
+Sending patches
+===============
+
+See: https://github.com/mpv-player/mpv/blob/master/DOCS/contribute.md
+
+In particular, be aware that all changes to GPL code must come with the
+implicit agreement that they might be LGPLv2.1+ relicensed at a later point.
@@ -1,74 +1,30 @@
 mpv is a fork of mplayer2, which is a fork of MPlayer.

-mpv as a whole is licensed under the GNU General Public License GPL version 2
-or later (called GPLv2+ in this document, see LICENSE.GPL for full license
-text) by default, or the GNU Lesser General Public License LGPL version 2 or
-later (LGPLv2.1+ in this document, see LICENSE.LGPL for full license text) if
-built with the --enable-lgpl configure switch.
+mpv as a whole is licensed as GPL version 2 or later (see LICENSE). Most source
+files are GPLv2+, but some files are available under a more liberal license,
+such as LGPLv2.1+, BSD, MIT, ISC, and possibly others. Look at the copyright
+header of each source file, and grep the sources for "Copyright" if you need
+to know details. Files without Copyright notice are licensed as LGPLv2.1+.

-Most source files are LGPLv2.1+ or GPLv2+, but some files are available under
-more liberal licenses, such as BSD, MIT, ISC, and possibly others. Look at the
-copyright header of each source file, and grep the sources for "Copyright" if
-you need to know details. C source files without Copyright notice are usually
-licensed as LGPLv2.1+. Also see the list of files with specific licenses below
-(not all files can have a standard license header).
+All new contributions must be LGPLv2.1+ licensed, or if the changes are done on
+GPL code, must come with the implicit agreement that the project can relicense
+the code to LGPLv2.1+ at a later point without asking the contributor. (This
+is a safeguard for making potential relicensing of the project to LGPLv2.1+
+easier.) Using a more liberal license compatible to LGPLv2.1+ is also ok.

-All new contributions must be LGPLv2.1+ licensed. Using a more liberal license
-compatible to LGPLv2.1+ is also ok.
-
-Changes done to GPL code must come with the implicit/explicit agreement that the
-project can relicense the changes to LGPLv2.1+ at a later point without asking
-the contributor. This is a safeguard for making potential relicensing of
-remaining GPL code to LGPLv2.1+ easier.
-
-See DOCS/contribute.md for binding rules wrt. licensing for contributions.
+Some GPLv3 or LGPLv3 code in mpv can be enabled by building with --enable-gpl3,
+and in this case, the resulting binaries must be distributed under GPLv3.

 For information about authors and contributors, consult the git log, which
 contains the complete SVN and CVS history as well.

+Note that mplayer2 as a whole is licensed under GPLv3+. This is because it uses
+a copy of talloc (part of Samba), which is LGPLv3+, and the next compatible
+license for this mix is GPLv3+.
+
+MPlayer as a whole is licensed under GPLv2 (incompatible to GPLv3!), because
+some files are licensed to GPLv2 (and _not_ any later version of the license).
+In particular, this affects the file libmpdemux/demux_ty_osd.c. It is disabled
+under mplayer2, and has been removed from mpv.
+
 "v2.1+" in this context means "version 2.1 or later".
-
-Some libraries are GPLv2+ or GPLv3+ only. Building mpv with Samba support makes
-it GPLv3+.
-
-mpv can be built as LGPLv2.1+ with the --enable-lgpl configure option. To add
-a LGPL mode to mpv, MPlayer code had to be relicensed from GPLv2+ to LGPLv2.1+
-by asking the MPlayer authors for permission. Since permission could not be
-obtained from everyone, LGPL mode disables the following features, some of
-them quite central:
- Linux X11 video output
- BSD audio output via OSS
- NVIDIA/Linux hardware decoding (vdpau, although nvdec usually works)
- Linux TV input
- minor features: jack, DVD, CDDA, SMB, CACA, legacy direct3d VO
-Some of these will be fixed in the future. The intended use for LGPL mode is
-with libmpv, and currently it's not recommended to build mpv CLI in LGPL mode
-at all.
-
-The following files are still GPL only (--enable-lgpl disables them):
-
-    audio/out/ao_jack.c             will stay GPL
-    audio/out/ao_oss.c              will stay GPL
-    stream/dvb*                     must stay GPL
-    stream/stream_cdda.c            unknown
-    stream/stream_dvb.*             must stay GPL
-    stream/stream_dvdnav.c          unknown
-    video/out/vo_caca.c             unknown
-    video/out/vo_direct3d.c         unknown
-    video/out/vo_vaapi.c            probably impossible (some company's code)
-    video/out/vo_vdpau.c            probably impossible (nVidia's code)
-    video/out/vo_x11.c              probably impossible
-    video/out/vo_xv.c               probably impossible
-    video/out/x11_common.*          probably impossible
-    video/vdpau.c                   hard (GPL-only parts must be ifdefed)
-    video/vdpau.h                   unknown
-    video/vdpau_mixer.*             actual code must be rewritten
-    DOCS/man/                       GPLv2+
-    bootstrap.py                    unknown license, probably GPLv2+ or LGPLv2+
-    etc/mplayer-input.conf          unknown license, probably GPLv2+
-    mpv.desktop                     unknown license, probably GPLv2+
-    etc/restore-old-bindings.conf   unknown license, probably GPLv2+
-
-None of the cases listed above affect the final binary if it's built as
-LGPL. Linked libraries still can affect the final license (for example if
-FFmpeg was built as GPL).
@@ -1,70 +0,0 @@
-# Differences Between Meson and Waf
-
-mpv currently supports two different build systems: waf and meson. In general,
-option names between both build systems are mostly the same. In most cases,
-``--enable-foo`` in waf becomes ``-Dfoo=enabled`` in meson. Likewise,
-``--disable-foo`` becomes ``-Dfoo=disabled``.  For the rest of this document,
-Waf options will be noted as ``--foo`` while meson options are noted as
-``foo``.
-
-## Universal Options
-
-Meson has several [universal options](https://mesonbuild.com/Builtin-options.html#universal-options)
-that you get for free. In some cases, these overlapped with custom waf options.
-
-* ``--libmpv-static`` and ``--libmpv-shared`` were combined into one option:
-  ``libmpv``. Use ``default_library`` to control if you want to build static or
-  shared libraries.
-* Waf had a boolean ``--optimize`` option. In meson, this is a universal option,
-  ``optimization``, which can take several different values. In mpv's meson
-  build, the default is ``2``.
-* Instead of ``--debug-build``, meson simply calls it ``debug``. It is enabled
-  by default.
-
-## Changed Options
-
-* The legacy lua names (``52``, ``52deb``, etc.) for ``--lua`` are not
-  supported in the meson build. Instead, pass the generic pkg-config values
-  such as ``lua52``, ``lua5.2``, etc.
-* ``--lgpl`` was changed to ``gpl``. If ``gpl`` is false, the build is LGPL2.1+.
-
-### Boolean Options
-
-The following options are all booleans that accept ``true`` or ``false``
-instead of ``enabled`` or ``disabled``.
-
-* ``build-date``
-* ``cplayer``
-* ``gpl``
-* ``libmpv``
-* ``ta-leak-report``
-* ``tests``
-
-## Removed Options
-
-There are options removed with no equivalent in the meson build.
-
-* ``--asm`` was removed since it doesn't do anything.
-* ``--android`` was removed since meson knows if the machine is android.
-* ``--clang-compilation-database`` was removed. Meson can do this on its own
-  by invoking ninja (``ninja -t compdb``).
-* ``--tvos`` was removed since it doesn't do anything.
-* ``--static-build`` was removed. Use ``default_library``.
-* ``--swift-static`` was removed. The swift library always dynamically links.
-
-## Renamed Options
-
-These are some other options that were renamed.
-
-* ``--gl-wayland`` was renamed to ``egl-wayland``.
-* ``--swift`` was renamed to ``swift-build``.
-
-## Other
-
-* The meson build supports passing the ``SOURCE_DATE_EPOCH`` environment variable
-during the compilation step for those who want reproducibility without having to
-disable the build date.
-* The ``Configuration`` line shown by ``mpv -v`` does not show everything passed on
-cli since meson does not have any easy way to access a user's argv. Instead, it
-simply shows whatever the value of ``prefix`` is regardless if it was specified
-or not.
@@ -16,7 +16,7 @@ The version number is the same as used for MPV_CLIENT_API_VERSION (see
 ``client.h`` how to convert between major/minor version numbers and the flat
 32 bit integer).

-Also, read the section ``Compatibility`` in ``client.h``, and compatibility.rst.
+Also, read the section ``Compatibility`` in ``client.h``.

 Options, commands, properties
 =============================
@@ -32,165 +32,6 @@ API changes

 ::

- --- mpv 0.35.0 ---
- 2.0    - remove headers/functions of the obsolete opengl_cb API
-        - remove mpv_opengl_init_params.extra_exts field
-        - remove deprecated mpv_detach_destroy. Use mpv_destroy instead.
-        - remove obsolete mpv_suspend and mpv_resume
-        - remove deprecated SCRIPT_INPUT_DISPATCH, PAUSE and UNPAUSE, TRACKS_CHANGED
-          TRACK_SWITCHED, METADATA_UPDATE, CHAPTER_CHANGE events
- --- mpv 0.33.0 ---
- 1.109  - add MPV_RENDER_API_TYPE_SW and related (software rendering API)
-        - inactivate the opengl_cb API (always fails to initialize now)
-          The opengl_cb API was deprecated over 2 years ago. Use the render API
-          instead.
- 1.108  - Deprecate MPV_EVENT_IDLE
-        - add mpv_event_start_file
-        - add the following fields to mpv_event_end_file: playlist_entry_id,
-          playlist_insert_id, playlist_insert_num_entries
-        - add mpv_event_to_node()
-        - add mpv_client_id()
- 1.107  - Remove the deprecated qthelper.hpp. This was obviously not part of the
-          libmpv API, only an "additionally" provided helper, thus this is not
-          considered an API change. If you are maintaining a project that relies
-          on this header, you can simply download this file and adjust the
-          include statement to use it instead:
-
-            https://raw.githubusercontent.com/mpv-player/mpv/v0.32.0/libmpv/qthelper.hpp
-
-          It is a good idea to write better wrappers for your use, though.
- --- mpv 0.31.0 ---
- 1.107  - Deprecate MPV_EVENT_TICK
- --- mpv 0.30.0 ---
- 1.106  - Add cancel_fn to mpv_stream_cb_info
- 1.105  - Fix deadlock problems with MPV_RENDER_PARAM_ADVANCED_CONTROL and if
-          the "vd-lavc-dr" option is enabled (which it is by default).
-          There were no actual API changes.
-          API users on older API versions and mpv releases should set
-          "vd-lavc-dr" to "no" to avoid these issues.
-          API users must still adhere to the tricky rules documented in render.h
-          to avoid other deadlocks.
- 1.104  - Deprecate struct mpv_opengl_drm_params. Replaced by mpv_opengl_drm_params_v2
-        - Deprecate MPV_RENDER_PARAM_DRM_DISPLAY. Replaced by MPV_RENDER_PARAM_DRM_DISPLAY_V2.
- 1.103  - redo handling of async commands
-        - add mpv_event_command and make it possible to return values from
-          commands issued with mpv_command_async() or mpv_command_node_async()
-        - add mpv_abort_async_command()
- 1.102  - rename struct mpv_opengl_drm_osd_size to mpv_opengl_drm_draw_surface_size
-        - rename MPV_RENDER_PARAM_DRM_OSD_SIZE to MPV_RENDER_PARAM_DRM_DRAW_SURFACE_SIZE
- --- mpv 0.29.0 ---
- 1.101  - add MPV_RENDER_PARAM_ADVANCED_CONTROL and related API
-        - add MPV_RENDER_PARAM_NEXT_FRAME_INFO and related symbols
-        - add MPV_RENDER_PARAM_BLOCK_FOR_TARGET_TIME
-        - add MPV_RENDER_PARAM_SKIP_RENDERING
-        - add mpv_render_context_get_info()
- 1.100  - bump API number to avoid confusion with mpv release versions
-        - actually apply the GL_MP_MPGetNativeDisplay change for the new render
-          API. This also means compatibility for anything but x11 and wayland
-          through the old opengl-cb GL_MP_MPGetNativeDisplay method is now
-          unsupported.
-        - deprecate mpv_get_wakeup_pipe(). It's complex, but easy to replace
-          using normal API (just set a wakeup callback to a function which
-          writes to a pipe).
-        - add a 1st class hook API, which replaces the hacky mpv_command()
-          based one. The old API is deprecated and will be removed soon. The
-          old API was never meant to be stable, while the new API is.
- 1.29   - the behavior of mpv_terminate_destroy() and mpv_detach_destroy()
-          changes subtly (see documentation in the header file). In particular,
-          mpv_detach_destroy() will not leave the player running in all
-          situations anymore (it gets closer to refcounting).
-        - rename mpv_detach_destroy() to mpv_destroy() (the old function will
-          remain valid as deprecated alias)
-        - add mpv_create_weak_client(), which makes use of above changes
-        - MPV_EVENT_SHUTDOWN is now returned exactly once if a mpv_handle
-          should terminate, instead of spamming the event queue with this event
- 1.28   - deprecate the render opengl_cb API, and replace it with render.h
-          and render_gl.h. The goal is allowing support for APIs other than
-          OpenGL. The old API is emulated with the new API.
-          Likewise, the "opengl-cb" VO is renamed to "libmpv".
-          mpv_get_sub_api() is deprecated along the opengl_cb API.
-          The new API is relatively similar, but not the same. The rough
-          equivalents are:
-            mpv_opengl_cb_init_gl => mpv_render_context_create
-            mpv_opengl_cb_set_update_callback => mpv_render_context_set_update_callback
-            mpv_opengl_cb_draw => mpv_render_context_render
-            mpv_opengl_cb_report_flip => mpv_render_context_report_swap
-            mpv_opengl_cb_uninit_gl => mpv_render_context_free
-          The VO opengl-cb is also renamed to "libmpv".
-          Also, the GL_MP_MPGetNativeDisplay pseudo extension is not used by the
-          render API anymore, and the old opengl-cb API only handles the "x11"
-          and "wl" names anymore. Support for everything else has been removed.
-          The new render API uses proper API parameters, e.g. for X11 you pass
-          MPV_RENDER_PARAM_X11_DISPLAY directly.
-        - deprecate the qthelper.hpp header file. This provided some C++ helper
-          utility functions for Qt with use of libmpv. There is no reason to
-          keep this in the mpv git repository, nor to make it part of the libmpv
-          API. If you're using this header, you can safely copy it into your
-          project - it uses only libmpv public API. Alternatively, it could be
-          maintained in a separate repository by interested parties.
- 1.27   - make opengl-cb the default VO. This causes a subtle behavior change
-          if the API user called mpv_opengl_cb_init_gl(), but does not set
-          the "vo" option. Before, it would still have used another VO (like
-          on the CLI, e.g. vo=gpu). Now it'll behave as if vo=opengl-cb was
-          used.
- --- mpv 0.28.0 ---
- 1.26   - remove glMPGetNativeDisplay("drm") support
-        - add mpv_opengl_cb_window_pos and mpv_opengl_cb_drm_params and
-          support via glMPGetNativeDisplay() for using it
-        - make --stop-playback-on-init-failure=no the default in libmpv (just
-          like in mpv CLI)
- --- mpv 0.27.0 ---
- 1.25   - remove setting "no-" options via mpv_set_option*(). (See corresponding
-          deprecation in 0.23.0.)
- --- mpv 0.25.0 ---
- 1.24   - add a MPV_ENABLE_DEPRECATED preprocessor symbol, which can be defined
-          by the user to exclude deprecated API symbols from the C headers
- --- mpv 0.23.0 ---
- 1.24   - the deprecated mpv_suspend() and mpv_resume() APIs now do nothing.
- --- mpv 0.22.0 ---
- 1.23   - deprecate setting "no-" options via mpv_set_option*(). For example,
-          instead of "no-video=" you should set "video=no".
-        - do not override the SIGPIPE signal handler anymore. This was done as
-          workaround for the FFmpeg TLS code, which has been fixed long ago.
-        - deprecate mpv_suspend() and mpv_resume(). They will be stubbed out
-          in mpv 0.23.0.
-        - make mpv_set_property() work to some degree before mpv_initialize().
-          It can now be used instead of mpv_set_option().
-        - semi-deprecate mpv_set_option()/mpv_set_option_string(). You should
-          use mpv_set_property() instead. There are some deprecated properties
-          which conflict with some options (see client.h remarks on
-          mpv_set_option()), for which mpv_set_option() might still be required.
-          In future mpv releases, the conflicting deprecated options/properties
-          will be removed, and mpv_set_option() will internally translate API
-          calls to mpv_set_property().
-        - qthelper.hpp: deprecate get_property_variant, set_property_variant,
-          set_option_variant, command_variant, and replace them with
-          get_property, set_property, command.
- --- mpv 0.19.0 ---
- 1.22   - add stream_cb API for custom protocols
- --- mpv 0.18.1 ---
- ----   - remove "status" log level from mpv_request_log_messages() docs. This
-          is 100% equivalent to "v". The behavior is still the same, thus no
-          actual API change.
- --- mpv 0.18.0 ---
- 1.21   - mpv_set_property() changes behavior with MPV_FORMAT_NODE. Before this
-          change it rejected mpv_nodes with format==MPV_FORMAT_STRING if the
-          property was not a string or did not have special mechanisms in place
-          the function failed. Now it always invokes the option string parser,
-          and mpv_node with a basic data type works exactly as if the function
-          is invoked with that type directly. This new behavior is equivalent
-          to mpv_set_option().
-          This also affects the mp.set_property_native() Lua function.
-        - generally, setting choice options/properties with "yes"/"no" options
-          can now be set as MPV_FORMAT_FLAG
-        - reading a choice property as MPV_FORMAT_NODE will now return a
-          MPV_FORMAT_FLAG value if the choice is "yes" (true) or "no" (false)
-          This implicitly affects Lua and JSON IPC interfaces as well.
-        - big changes to vo-cmdline on vo_opengl and vo_opengl_hq (but not
-          vo_opengl_cb): options are now normally not reset, but applied on top
-          of the current options. The special undocumented value "-" still
-          works, but now resets all options to before any vo-cmdline command
-          has been called.
 --- mpv 0.12.0 ---
 1.20   - deprecate "GL_MP_D3D_interfaces"/"glMPGetD3DInterface", and introduce
          "GL_MP_MPGetNativeDisplay"/"glMPGetNativeDisplay" (this is a
@@ -0,0 +1,14 @@
+All examples in this directory and its sub-directories are licensed
+under one of the following licenses:
+
+    WTFPL, ISC, Ms-PL, AGPLv3, BSD (any)
+
+Pick any license of your liking, and disregard the others.
+
+(The full text of each license is available on this website:
+  http://opensource.org/licenses/alphabetical )
+
+Additionally, you may consider the example code to be public domain.
+You are free to use any of the example code without further
+requirements or need for attribution.
+
@@ -0,0 +1,114 @@
+# Client API examples
+
+All these examples use the mpv client API through libmpv.
+
+## Where are the docs?
+
+The libmpv C API is documented directly in the header files (on normal Unix
+systems, this is in `/usr/include/mpv/client.h`.
+
+libmpv merely gives you access to mpv's command interface, which is documented
+here:
+* Options (`mpv_set_option()` and friends): http://mpv.io/manual/master/#options
+* Commands (`mpv_command()` and friends): http://mpv.io/manual/master/#list-of-input-commands
+* Properties (`mpv_set_property()` and friends): http://mpv.io/manual/master/#properties
+
+Essentially everything is done with them, including loading a file, retrieving
+playback progress, and so on.
+
+## Methods of embedding the video window
+
+All of these examples concentrate on how to integrate mpv's video renderers
+with your own GUI. This is generally the hardest part. libmpv enforces a
+somewhat efficient video output method, rather than e.g. returning a RGBA
+surface in memory for each frame. The latter would be prohibitively inefficient,
+because it would require conversion on the CPU. The goal is also not requiring
+the API users to reinvent their own video rendering/scaling/presentation
+mechanisms.
+
+There are currently 2 methods of embedding video.
+
+### Native window embedding
+
+This uses the platform's native method of nesting multiple windows. For example,
+Linux/X11 can nest a window from a completely different process. The nested
+window can redraw contents on its own, and receive user input if the user
+interacts with this window.
+
+libmpv lets you specify a parent window for its own video window via the `wid`
+option. Then libmpv will create its window with your window as parent, and
+render its video inside of it.
+
+This method is highly OS-dependent. Some behavior is OS-specific. There are
+problems with focusing on X11 (the ancient X11 focus policy mismatches with
+that of modern UI toolkits - it's normally worked around, but this is not
+easily possible with raw window embedding). It seems to have stability problems
+on OSX when using the Qt toolkit.
+
+### OpenGL embedding
+
+This method lets you use libmpv's OpenGL renderer directly. You create an
+OpenGL context, and then use `mpv_opengl_cb_draw()` to render the video on
+each frame.
+
+This is more complicated, because libmpv will work directly on your own OpenGL
+state. It's also not possible to have mpv automatically receive user input.
+You will have to simulate this with the `mouse`/`keypress`/`keydown`/`keyup`
+commands.
+
+You also get much more flexibility. For example, you can actually render your
+own OSD on top of the video, something that is not possible with raw window
+embedding.
+
+### Which one to use?
+
+Due to the various platform-specific behavior and problems (in particular on
+OSX), OpenGL embedding is recommended. If you're not comfortable with requiring
+OpenGL, or want to support "direct" video output such as vdpau (which might
+win when it comes to performance and energy-saving), you should probably
+support both methods if possible.
+
+## List of examples
+
+### simple
+
+Very primitive terminal-only example. Shows some most basic API usage.
+
+### cocoa
+
+Shows how to embed the mpv video window in Objective-C/Cocoa.
+
+### cocoa-openglcb
+
+Similar to the cocoa sample, but shows how to integrate mpv's OpenGL renderer
+using libmpv's opengl-cb API. Since it does not require complicated interaction
+with Cocoa elements from different libraries, it's more robust.
+
+### qt
+
+Shows how to embed the mpv video window in Qt (using normal desktop widgets).
+
+### qt_opengl
+
+Shows how to use mpv's OpenGL video renderer in Qt. This uses the opengl-cb API
+for video. Since it does not rely on embedding "foreign" native Windows, it's
+usually more robust, potentially faster, and it's easier to control how your
+GUI interacts with the video. You can do your own OpenGL rendering on top of
+the video as well.
+
+### qml
+
+Shows how to use mpv's OpenGL video renderer in QtQuick2 with QML. Uses the
+opengl-cb API for video. Since the video is a normal QML element, it's trivial
+to create OSD overlays with QML-native graphical elements as well.
+
+### qml_direct
+
+Alternative example, which typically avoids a FBO indirection. Might be
+slightly faster, but is less flexible and harder to use. In particular, the
+video is not a normal QML element. Uses the opengl-cb API for video.
+
+### sdl
+
+Show how to embed the mpv OpenGL renderer in SDL. Uses the opengl-cb API for
+video.
@@ -0,0 +1,304 @@
+// Plays a video from the command line in an opengl view in its own window.
+
+// Build with: clang -o cocoa-openglcb cocoa-openglcb.m `pkg-config --libs --cflags mpv` -framework Cocoa -framework OpenGL
+
+#import <mpv/client.h>
+#import <mpv/opengl_cb.h>
+
+#import <stdio.h>
+#import <stdlib.h>
+#import <OpenGL/gl.h>
+
+#import <Cocoa/Cocoa.h>
+
+
+static inline void check_error(int status)
+{
+    if (status < 0) {
+        printf("mpv API error: %s\n", mpv_error_string(status));
+        exit(1);
+    }
+}
+
+static void *get_proc_address(void *ctx, const char *name)
+{
+    CFStringRef symbolName = CFStringCreateWithCString(kCFAllocatorDefault, name, kCFStringEncodingASCII);
+    void *addr = CFBundleGetFunctionPointerForName(CFBundleGetBundleWithIdentifier(CFSTR("com.apple.opengl")), symbolName);
+    CFRelease(symbolName);
+    return addr;
+}
+
+static void glupdate(void *ctx);
+
+@interface MpvClientOGLView : NSOpenGLView
+@property mpv_opengl_cb_context *mpvGL;
+- (instancetype)initWithFrame:(NSRect)frame;
+- (void)drawRect;
+- (void)fillBlack;
+@end
+
+@implementation MpvClientOGLView
+- (instancetype)initWithFrame:(NSRect)frame
+{
+    // make sure the pixel format is double buffered so we can use
+    // [[self openGLContext] flushBuffer].
+    NSOpenGLPixelFormatAttribute attributes[] = {
+        NSOpenGLPFADoubleBuffer,
+        0
+    };
+    self = [super initWithFrame:frame
+                    pixelFormat:[[NSOpenGLPixelFormat alloc] initWithAttributes:attributes]];
+
+    if (self) {
+        [self setAutoresizingMask:NSViewWidthSizable|NSViewHeightSizable];
+        // swap on vsyncs
+        GLint swapInt = 1;
+        [[self openGLContext] setValues:&swapInt forParameter:NSOpenGLCPSwapInterval];
+        [[self openGLContext] makeCurrentContext];
+        self.mpvGL = nil;
+    }
+    return self;
+}
+
+- (void)fillBlack
+{
+    glClearColor(0, 0, 0, 0);
+    glClear(GL_COLOR_BUFFER_BIT);
+}
+
+- (void)drawRect
+{
+    if (self.mpvGL)
+        mpv_opengl_cb_draw(self.mpvGL, 0, self.bounds.size.width, -self.bounds.size.height);
+    else
+        [self fillBlack];
+    [[self openGLContext] flushBuffer];
+}
+
+- (void)drawRect:(NSRect)dirtyRect
+{
+    [self drawRect];
+}
+@end
+
+@interface CocoaWindow : NSWindow
+@property(retain, readonly) MpvClientOGLView *glView;
+@property(retain, readonly) NSButton *pauseButton;
+@end
+
+@implementation CocoaWindow
+- (BOOL)canBecomeMainWindow { return YES; }
+- (BOOL)canBecomeKeyWindow { return YES; }
+- (void)initOGLView {
+    NSRect bounds = [[self contentView] bounds];
+    // window coordinate origin is bottom left
+    NSRect glFrame = NSMakeRect(bounds.origin.x, bounds.origin.y + 30, bounds.size.width, bounds.size.height - 30);
+    _glView = [[MpvClientOGLView alloc] initWithFrame:glFrame];
+    [self.contentView addSubview:_glView];
+
+    NSRect buttonFrame = NSMakeRect(bounds.origin.x, bounds.origin.y, 60, 30);
+    _pauseButton = [[NSButton alloc] initWithFrame:buttonFrame];
+    _pauseButton.buttonType = NSToggleButton;
+    // button target has to be the delegate (it holds the mpv context
+    // pointer), so that's set later.
+    _pauseButton.action = @selector(togglePause:);
+    _pauseButton.title = @"Pause";
+    _pauseButton.alternateTitle = @"Play";
+    [self.contentView addSubview:_pauseButton];
+}
+@end
+
+@interface AppDelegate : NSObject <NSApplicationDelegate>
+{
+    mpv_handle *mpv;
+    dispatch_queue_t queue;
+    CocoaWindow *window;
+}
+@end
+
+static void wakeup(void *);
+
+@implementation AppDelegate
+
+- (void)createWindow {
+
+    int mask = NSTitledWindowMask|NSClosableWindowMask|
+               NSMiniaturizableWindowMask|NSResizableWindowMask;
+
+    window = [[CocoaWindow alloc]
+        initWithContentRect:NSMakeRect(0, 0, 1280, 720)
+                  styleMask:mask
+                    backing:NSBackingStoreBuffered
+                      defer:NO];
+
+    // force a minimum size to stop opengl from exploding.
+    [window setMinSize:NSMakeSize(200, 200)];
+    [window initOGLView];
+    [window setTitle:@"cocoa-openglcb example"];
+    [window makeMainWindow];
+    [window makeKeyAndOrderFront:nil];
+
+    NSMenu *m = [[NSMenu alloc] initWithTitle:@"AMainMenu"];
+    NSMenuItem *item = [m addItemWithTitle:@"Apple" action:nil keyEquivalent:@""];
+    NSMenu *sm = [[NSMenu alloc] initWithTitle:@"Apple"];
+    [m setSubmenu:sm forItem:item];
+    [sm addItemWithTitle: @"quit" action:@selector(terminate:) keyEquivalent:@"q"];
+    [NSApp setMenu:m];
+    [NSApp activateIgnoringOtherApps:YES];
+}
+
+- (void) applicationDidFinishLaunching:(NSNotification *)notification {
+    [NSApp setActivationPolicy:NSApplicationActivationPolicyRegular];
+    atexit_b(^{
+        // Because activation policy has just been set to behave like a real
+        // application, that policy must be reset on exit to prevent, among
+        // other things, the menubar created here from remaining on screen.
+        [NSApp setActivationPolicy:NSApplicationActivationPolicyProhibited];
+    });
+
+    // Read filename
+    NSArray *args = [NSProcessInfo processInfo].arguments;
+    if (args.count < 2) {
+        NSLog(@"Expected filename on command line");
+        exit(1);
+    }
+    NSString *filename = args[1];
+
+    [self createWindow];
+    window.pauseButton.target = self;
+
+    mpv = mpv_create();
+    if (!mpv) {
+        printf("failed creating context\n");
+        exit(1);
+    }
+
+    check_error(mpv_set_option_string(mpv, "input-media-keys", "yes"));
+    // request important errors
+    check_error(mpv_request_log_messages(mpv, "warn"));
+
+    check_error(mpv_initialize(mpv));
+    check_error(mpv_set_option_string(mpv, "vo", "opengl-cb"));
+    mpv_opengl_cb_context *mpvGL = mpv_get_sub_api(mpv, MPV_SUB_API_OPENGL_CB);
+    if (!mpvGL) {
+        puts("libmpv does not have the opengl-cb sub-API.");
+        exit(1);
+    }
+    // pass the mpvGL context to our view
+    window.glView.mpvGL = mpvGL;
+    int r = mpv_opengl_cb_init_gl(mpvGL, NULL, get_proc_address, NULL);
+    if (r < 0) {
+        puts("gl init has failed.");
+        exit(1);
+    }
+    mpv_opengl_cb_set_update_callback(mpvGL, glupdate, (__bridge void *)window.glView);
+
+    // Deal with MPV in the background.
+    queue = dispatch_queue_create("mpv", DISPATCH_QUEUE_SERIAL);
+    dispatch_async(queue, ^{
+        // Register to be woken up whenever mpv generates new events.
+        mpv_set_wakeup_callback(mpv, wakeup, (__bridge void *)self);
+        // Load the indicated file
+        const char *cmd[] = {"loadfile", filename.UTF8String, NULL};
+        check_error(mpv_command(mpv, cmd));
+    });
+}
+
+static void glupdate(void *ctx)
+{
+    MpvClientOGLView *glView = (__bridge MpvClientOGLView *)ctx;
+    // I'm still not sure what the best way to handle this is, but this
+    // works.
+    dispatch_async(dispatch_get_main_queue(), ^{
+        [glView drawRect];
+    });
+}
+
+- (void) handleEvent:(mpv_event *)event
+{
+    switch (event->event_id) {
+    case MPV_EVENT_SHUTDOWN: {
+        mpv_detach_destroy(mpv);
+        mpv_opengl_cb_uninit_gl(window.glView.mpvGL);
+        mpv = NULL;
+        printf("event: shutdown\n");
+        break;
+    }
+
+    case MPV_EVENT_LOG_MESSAGE: {
+        struct mpv_event_log_message *msg = (struct mpv_event_log_message *)event->data;
+        printf("[%s] %s: %s", msg->prefix, msg->level, msg->text);
+    }
+
+    default:
+        printf("event: %s\n", mpv_event_name(event->event_id));
+    }
+}
+
+- (void)togglePause:(NSButton *)button
+{
+    if (mpv) {
+        switch (button.state) {
+            case NSOffState:
+                {
+                    int pause = 0;
+                    mpv_set_property(mpv, "pause", MPV_FORMAT_FLAG, &pause);
+                }
+                break;
+            case NSOnState:
+                {
+                    int pause = 1;
+                    mpv_set_property(mpv, "pause", MPV_FORMAT_FLAG, &pause);
+                }
+                break;
+            default:
+                NSLog(@"This should never happen.");
+        }
+    }
+}
+
+- (void) readEvents
+{
+    dispatch_async(queue, ^{
+        while (mpv) {
+            mpv_event *event = mpv_wait_event(mpv, 0);
+            if (event->event_id == MPV_EVENT_NONE)
+                break;
+            [self handleEvent:event];
+        }
+    });
+}
+
+static void wakeup(void *context)
+{
+    AppDelegate *a = (__bridge AppDelegate *) context;
+    [a readEvents];
+}
+
+// quit when the window is closed.
+- (BOOL)applicationShouldTerminateAfterLastWindowClosed:(NSApplication *)app
+{
+    return YES;
+}
+
+- (NSApplicationTerminateReply)applicationShouldTerminate:(NSApplication *)sender
+{
+    NSLog(@"Terminating.");
+    const char *args[] = {"quit", NULL};
+    mpv_command(mpv, args);
+    [window.glView clearGLContext];
+    return NSTerminateNow;
+}
+
+@end
+
+// Delete this if you already have a main.m.
+int main(int argc, const char * argv[]) {
+    @autoreleasepool {
+        NSApplication *app = [NSApplication sharedApplication];
+        AppDelegate *delegate = [AppDelegate new];
+        app.delegate = delegate;
+        [app run];
+    }
+    return 0;
+}
@@ -0,0 +1,209 @@
+// Plays a video from the command line in a view provided by the client
+// application.
+
+// Build with: clang -o cocoabasic cocoabasic.m `pkg-config --libs --cflags mpv` -framework cocoa
+
+#include <mpv/client.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+
+static inline void check_error(int status)
+{
+    if (status < 0) {
+        printf("mpv API error: %s\n", mpv_error_string(status));
+        exit(1);
+    }
+}
+
+#import <Cocoa/Cocoa.h>
+
+@interface CocoaWindow : NSWindow
+@end
+
+@implementation CocoaWindow
+- (BOOL)canBecomeMainWindow { return YES; }
+- (BOOL)canBecomeKeyWindow { return YES; }
+@end
+
+@interface AppDelegate : NSObject <NSApplicationDelegate>
+{
+    mpv_handle *mpv;
+    dispatch_queue_t queue;
+    NSWindow *w;
+    NSView *wrapper;
+}
+@end
+
+static void wakeup(void *);
+
+@implementation AppDelegate
+
+- (void)createWindow {
+
+    int mask = NSTitledWindowMask|NSClosableWindowMask|
+               NSMiniaturizableWindowMask|NSResizableWindowMask;
+
+    self->w = [[CocoaWindow alloc]
+        initWithContentRect:NSMakeRect(0,0, 1280, 720)
+                  styleMask:mask
+                    backing:NSBackingStoreBuffered
+                      defer:NO];
+
+    [self->w setTitle:@"cocoabasic example"];
+    [self->w makeMainWindow];
+    [self->w makeKeyAndOrderFront:nil];
+
+    NSRect frame = [[self->w contentView] bounds];
+    self->wrapper = [[NSView alloc] initWithFrame:frame];
+    [self->wrapper setAutoresizingMask:NSViewWidthSizable|NSViewHeightSizable];
+    [[self->w contentView] addSubview:self->wrapper];
+    [self->wrapper release];
+
+    NSMenu *m = [[NSMenu alloc] initWithTitle:@"AMainMenu"];
+    NSMenuItem *item = [m addItemWithTitle:@"Apple" action:nil keyEquivalent:@""];
+    NSMenu *sm = [[NSMenu alloc] initWithTitle:@"Apple"];
+    [m setSubmenu:sm forItem:item];
+    [sm addItemWithTitle: @"mpv_command('stop')" action:@selector(mpv_stop) keyEquivalent:@""];
+    [sm addItemWithTitle: @"mpv_command('quit')" action:@selector(mpv_quit) keyEquivalent:@""];
+    [sm addItemWithTitle: @"quit" action:@selector(terminate:) keyEquivalent:@"q"];
+    [NSApp setMenu:m];
+    [NSApp activateIgnoringOtherApps:YES];
+}
+
+- (void) applicationDidFinishLaunching:(NSNotification *)notification {
+    [NSApp setActivationPolicy:NSApplicationActivationPolicyRegular];
+    atexit_b(^{
+        // Because activation policy has just been set to behave like a real
+        // application, that policy must be reset on exit to prevent, among
+        // other things, the menubar created here from remaining on screen.
+        [NSApp setActivationPolicy:NSApplicationActivationPolicyProhibited];
+    });
+
+    // Read filename
+    NSArray *args = [NSProcessInfo processInfo].arguments;
+    if (args.count < 2) {
+        NSLog(@"Expected filename on command line");
+        exit(1);
+    }
+    NSString *filename = args[1];
+
+    [self createWindow];
+
+    // Deal with MPV in the background.
+    queue = dispatch_queue_create("mpv", DISPATCH_QUEUE_SERIAL);
+    dispatch_async(queue, ^{
+
+        mpv = mpv_create();
+        if (!mpv) {
+            printf("failed creating context\n");
+            exit(1);
+        }
+
+        int64_t wid = (intptr_t) self->wrapper;
+        check_error(mpv_set_option(mpv, "wid", MPV_FORMAT_INT64, &wid));
+
+        // Maybe set some options here, like default key bindings.
+        // NOTE: Interaction with the window seems to be broken for now.
+        check_error(mpv_set_option_string(mpv, "input-default-bindings", "yes"));
+
+        // for testing!
+        check_error(mpv_set_option_string(mpv, "input-media-keys", "yes"));
+        check_error(mpv_set_option_string(mpv, "input-cursor", "no"));
+        check_error(mpv_set_option_string(mpv, "input-vo-keyboard", "yes"));
+
+        // request important errors
+        check_error(mpv_request_log_messages(mpv, "warn"));
+
+        check_error(mpv_initialize(mpv));
+
+        // Register to be woken up whenever mpv generates new events.
+        mpv_set_wakeup_callback(mpv, wakeup, (__bridge void *) self);
+
+        // Load the indicated file
+        const char *cmd[] = {"loadfile", filename.UTF8String, NULL};
+        check_error(mpv_command(mpv, cmd));
+    });
+}
+
+- (void) handleEvent:(mpv_event *)event
+{
+    switch (event->event_id) {
+    case MPV_EVENT_SHUTDOWN: {
+        mpv_detach_destroy(mpv);
+        mpv = NULL;
+        printf("event: shutdown\n");
+        break;
+    }
+
+    case MPV_EVENT_LOG_MESSAGE: {
+        struct mpv_event_log_message *msg = (struct mpv_event_log_message *)event->data;
+        printf("[%s] %s: %s", msg->prefix, msg->level, msg->text);
+    }
+
+    case MPV_EVENT_VIDEO_RECONFIG: {
+        dispatch_async(dispatch_get_main_queue(), ^{
+            NSArray *subviews = [self->wrapper subviews];
+            if ([subviews count] > 0) {
+                // mpv's events view
+                NSView *eview = [self->wrapper subviews][0];
+                [self->w makeFirstResponder:eview];
+            }
+        });
+    }
+
+    default:
+        printf("event: %s\n", mpv_event_name(event->event_id));
+    }
+}
+
+- (void) readEvents
+{
+    dispatch_async(queue, ^{
+        while (mpv) {
+            mpv_event *event = mpv_wait_event(mpv, 0);
+            if (event->event_id == MPV_EVENT_NONE)
+                break;
+            [self handleEvent:event];
+        }
+    });
+}
+
+static void wakeup(void *context) {
+    AppDelegate *a = (__bridge AppDelegate *) context;
+    [a readEvents];
+}
+
+// Ostensibly, mpv's window would be hooked up to this.
+- (BOOL) windowShouldClose:(id)sender
+{
+    return NO;
+}
+
+- (void) mpv_stop
+{
+    if (mpv) {
+        const char *args[] = {"stop", NULL};
+        mpv_command(mpv, args);
+    }
+}
+
+- (void) mpv_quit
+{
+    if (mpv) {
+        const char *args[] = {"quit", NULL};
+        mpv_command(mpv, args);
+    }
+}
+@end
+
+// Delete this if you already have a main.m.
+int main(int argc, const char * argv[]) {
+    @autoreleasepool {
+        NSApplication *app = [NSApplication sharedApplication];
+        AppDelegate *delegate = [AppDelegate new];
+        app.delegate = delegate;
+        [app run];
+    }
+    return 0;
+}
@@ -0,0 +1,136 @@
+#include "main.h"
+
+#include <stdexcept>
+#include <clocale>
+
+#include <QObject>
+#include <QtGlobal>
+#include <QOpenGLContext>
+#include <QGuiApplication>
+
+#include <QtGui/QOpenGLFramebufferObject>
+
+#include <QtQuick/QQuickWindow>
+#include <QtQuick/QQuickView>
+
+class MpvRenderer : public QQuickFramebufferObject::Renderer
+{
+    static void *get_proc_address(void *ctx, const char *name) {
+        (void)ctx;
+        QOpenGLContext *glctx = QOpenGLContext::currentContext();
+        if (!glctx)
+            return NULL;
+        return (void *)glctx->getProcAddress(QByteArray(name));
+    }
+
+    mpv::qt::Handle mpv;
+    QQuickWindow *window;
+    mpv_opengl_cb_context *mpv_gl;
+public:
+    MpvRenderer(const MpvObject *obj)
+        : mpv(obj->mpv), window(obj->window()), mpv_gl(obj->mpv_gl)
+    {
+        int r = mpv_opengl_cb_init_gl(mpv_gl, NULL, get_proc_address, NULL);
+        if (r < 0)
+            throw std::runtime_error("could not initialize OpenGL");
+    }
+
+    virtual ~MpvRenderer()
+    {
+        // Until this call is done, we need to make sure the player remains
+        // alive. This is done implicitly with the mpv::qt::Handle instance
+        // in this class.
+        mpv_opengl_cb_uninit_gl(mpv_gl);
+    }
+
+    void render()
+    {
+        QOpenGLFramebufferObject *fbo = framebufferObject();
+        window->resetOpenGLState();
+        mpv_opengl_cb_draw(mpv_gl, fbo->handle(), fbo->width(), fbo->height());
+        window->resetOpenGLState();
+    }
+};
+
+MpvObject::MpvObject(QQuickItem * parent)
+    : QQuickFramebufferObject(parent), mpv_gl(0)
+{
+    mpv = mpv::qt::Handle::FromRawHandle(mpv_create());
+    if (!mpv)
+        throw std::runtime_error("could not create mpv context");
+
+    mpv_set_option_string(mpv, "terminal", "yes");
+    mpv_set_option_string(mpv, "msg-level", "all=v");
+
+    if (mpv_initialize(mpv) < 0)
+        throw std::runtime_error("could not initialize mpv context");
+
+    // Make use of the MPV_SUB_API_OPENGL_CB API.
+    mpv::qt::set_option_variant(mpv, "vo", "opengl-cb");
+
+    // Request hw decoding, just for testing.
+    mpv::qt::set_option_variant(mpv, "hwdec", "auto");
+
+    // Setup the callback that will make QtQuick update and redraw if there
+    // is a new video frame. Use a queued connection: this makes sure the
+    // doUpdate() function is run on the GUI thread.
+    mpv_gl = (mpv_opengl_cb_context *)mpv_get_sub_api(mpv, MPV_SUB_API_OPENGL_CB);
+    if (!mpv_gl)
+        throw std::runtime_error("OpenGL not compiled in");
+    mpv_opengl_cb_set_update_callback(mpv_gl, MpvObject::on_update, (void *)this);
+    connect(this, &MpvObject::onUpdate, this, &MpvObject::doUpdate,
+            Qt::QueuedConnection);
+}
+
+MpvObject::~MpvObject()
+{
+    if (mpv_gl)
+        mpv_opengl_cb_set_update_callback(mpv_gl, NULL, NULL);
+}
+
+void MpvObject::on_update(void *ctx)
+{
+    MpvObject *self = (MpvObject *)ctx;
+    emit self->onUpdate();
+}
+
+// connected to onUpdate(); signal makes sure it runs on the GUI thread
+void MpvObject::doUpdate()
+{
+    update();
+}
+
+void MpvObject::command(const QVariant& params)
+{
+    mpv::qt::command_variant(mpv, params);
+}
+
+void MpvObject::setProperty(const QString& name, const QVariant& value)
+{
+    mpv::qt::set_property_variant(mpv, name, value);
+}
+
+QQuickFramebufferObject::Renderer *MpvObject::createRenderer() const
+{
+    window()->setPersistentOpenGLContext(true);
+    window()->setPersistentSceneGraph(true);
+    return new MpvRenderer(this);
+}
+
+int main(int argc, char **argv)
+{
+    QGuiApplication app(argc, argv);
+
+    // Qt sets the locale in the QGuiApplication constructor, but libmpv
+    // requires the LC_NUMERIC category to be set to "C", so change it back.
+    std::setlocale(LC_NUMERIC, "C");
+
+    qmlRegisterType<MpvObject>("mpvtest", 1, 0, "MpvObject");
+
+    QQuickView view;
+    view.setResizeMode(QQuickView::SizeRootObjectToView);
+    view.setSource(QUrl("qrc:///mpvtest/main.qml"));
+    view.show();
+
+    return app.exec();
+}
@@ -0,0 +1,36 @@
+#ifndef MPVRENDERER_H_
+#define MPVRENDERER_H_
+
+#include <QtQuick/QQuickFramebufferObject>
+
+#include <mpv/client.h>
+#include <mpv/opengl_cb.h>
+#include <mpv/qthelper.hpp>
+
+class MpvRenderer;
+
+class MpvObject : public QQuickFramebufferObject
+{
+    Q_OBJECT
+
+    mpv::qt::Handle mpv;
+    mpv_opengl_cb_context *mpv_gl;
+
+    friend class MpvRenderer;
+
+public:
+    MpvObject(QQuickItem * parent = 0);
+    virtual ~MpvObject();
+    virtual Renderer *createRenderer() const;
+public slots:
+    void command(const QVariant& params);
+    void setProperty(const QString& name, const QVariant& value);
+signals:
+    void onUpdate();
+private slots:
+    void doUpdate();
+private:
+    static void on_update(void *ctx);
+};
+
+#endif
@@ -0,0 +1,71 @@
+import QtQuick 2.0
+import QtQuick.Controls 1.0
+
+import mpvtest 1.0
+
+Item {
+    width: 1280
+    height: 720
+
+    MpvObject {
+        id: renderer
+        anchors.fill: parent
+
+        MouseArea {
+            anchors.fill: parent
+            onClicked: renderer.command(["loadfile", "../../../test.mkv"])
+        }
+    }
+
+    Rectangle {
+        id: labelFrame
+        anchors.margins: -50
+        radius: 5
+        color: "white"
+        border.color: "black"
+        opacity: 0.8
+        anchors.fill: box
+    }
+
+    Row {
+        id: box
+        anchors.bottom: renderer.bottom
+        anchors.left: renderer.left
+        anchors.right: renderer.right
+        anchors.margins: 100
+
+        Text {
+            anchors.margins: 10
+            wrapMode: Text.WordWrap
+            text: "QtQuick and mpv are both rendering stuff.\n
+                   Click to load ../../../test.mkv"
+        }
+
+        // Don't take these controls too seriously. They're for testing.
+        Column {
+            CheckBox {
+                id: checkbox
+                anchors.margins: 10
+                // Heavily filtered means good, right?
+                text: "Make video look like on a Smart TV"
+                onClicked: {
+                    if (checkbox.checked) {
+                        renderer.command(["vo_cmdline", "sharpen=5.0"])
+                    } else {
+                        renderer.command(["vo_cmdline", ""])
+                    }
+                }
+            }
+            Slider {
+                id: slider
+                anchors.margins: 10
+                anchors.left: checkbox.left
+                anchors.right: checkbox.right
+                minimumValue: -100
+                maximumValue:  100
+                value: 0
+                onValueChanged: renderer.setProperty("gamma", slider.value | 0)
+            }
+        }
+    }
+}
@@ -0,0 +1,12 @@
+QT += qml quick
+
+HEADERS += main.h
+SOURCES += main.cpp
+
+QT_CONFIG -= no-pkg-config
+CONFIG += link_pkgconfig debug
+PKGCONFIG += mpv
+
+RESOURCES += mpvtest.qrc
+
+OTHER_FILES += main.qml
@@ -0,0 +1,5 @@
+<RCC>
+    <qresource prefix="/mpvtest">
+        <file>main.qml</file>
+    </qresource>
+</RCC>
@@ -0,0 +1,159 @@
+#include "main.h"
+
+#include <stdexcept>
+#include <clocale>
+
+#include <QObject>
+#include <QtGlobal>
+#include <QOpenGLContext>
+
+#include <QGuiApplication>
+#include <QtQuick/QQuickWindow>
+#include <QtQuick/QQuickView>
+
+static void *get_proc_address(void *ctx, const char *name) {
+    (void)ctx;
+    QOpenGLContext *glctx = QOpenGLContext::currentContext();
+    if (!glctx)
+        return NULL;
+    return (void *)glctx->getProcAddress(QByteArray(name));
+}
+
+MpvRenderer::MpvRenderer(mpv::qt::Handle a_mpv, mpv_opengl_cb_context *a_mpv_gl)
+    : mpv(a_mpv), mpv_gl(a_mpv_gl), window(0), size()
+{
+    int r = mpv_opengl_cb_init_gl(mpv_gl, NULL, get_proc_address, NULL);
+    if (r < 0)
+        throw std::runtime_error("could not initialize OpenGL");
+}
+
+MpvRenderer::~MpvRenderer()
+{
+    // Until this call is done, we need to make sure the player remains
+    // alive. This is done implicitly with the mpv::qt::Handle instance
+    // in this class.
+    mpv_opengl_cb_uninit_gl(mpv_gl);
+}
+
+void MpvRenderer::paint()
+{
+    window->resetOpenGLState();
+
+    // This uses 0 as framebuffer, which indicates that mpv will render directly
+    // to the frontbuffer. Note that mpv will always switch framebuffers
+    // explicitly. Some QWindow setups (such as using QQuickWidget) actually
+    // want you to render into a FBO in the beforeRendering() signal, and this
+    // code won't work there.
+    // The negation is used for rendering with OpenGL's flipped coordinates.
+    mpv_opengl_cb_draw(mpv_gl, 0, size.width(), -size.height());
+
+    window->resetOpenGLState();
+}
+
+MpvObject::MpvObject(QQuickItem * parent)
+    : QQuickItem(parent), mpv_gl(0), renderer(0)
+{
+    mpv = mpv::qt::Handle::FromRawHandle(mpv_create());
+    if (!mpv)
+        throw std::runtime_error("could not create mpv context");
+
+    mpv_set_option_string(mpv, "terminal", "yes");
+    mpv_set_option_string(mpv, "msg-level", "all=v");
+
+    if (mpv_initialize(mpv) < 0)
+        throw std::runtime_error("could not initialize mpv context");
+
+    // Make use of the MPV_SUB_API_OPENGL_CB API.
+    mpv::qt::set_option_variant(mpv, "vo", "opengl-cb");
+
+    // Setup the callback that will make QtQuick update and redraw if there
+    // is a new video frame. Use a queued connection: this makes sure the
+    // doUpdate() function is run on the GUI thread.
+    mpv_gl = (mpv_opengl_cb_context *)mpv_get_sub_api(mpv, MPV_SUB_API_OPENGL_CB);
+    if (!mpv_gl)
+        throw std::runtime_error("OpenGL not compiled in");
+    mpv_opengl_cb_set_update_callback(mpv_gl, MpvObject::on_update, (void *)this);
+    connect(this, &MpvObject::onUpdate, this, &MpvObject::doUpdate,
+            Qt::QueuedConnection);
+
+    connect(this, &QQuickItem::windowChanged,
+            this, &MpvObject::handleWindowChanged);
+}
+
+MpvObject::~MpvObject()
+{
+    if (mpv_gl)
+        mpv_opengl_cb_set_update_callback(mpv_gl, NULL, NULL);
+}
+
+void MpvObject::handleWindowChanged(QQuickWindow *win)
+{
+    if (!win)
+        return;
+    connect(win, &QQuickWindow::beforeSynchronizing,
+            this, &MpvObject::sync, Qt::DirectConnection);
+    connect(win, &QQuickWindow::sceneGraphInvalidated,
+            this, &MpvObject::cleanup, Qt::DirectConnection);
+    connect(win, &QQuickWindow::frameSwapped,
+            this, &MpvObject::swapped, Qt::DirectConnection);
+    win->setClearBeforeRendering(false);
+}
+
+void MpvObject::sync()
+{
+    if (!renderer) {
+        renderer = new MpvRenderer(mpv, mpv_gl);
+        connect(window(), &QQuickWindow::beforeRendering,
+                renderer, &MpvRenderer::paint, Qt::DirectConnection);
+    }
+    renderer->window = window();
+    renderer->size = window()->size() * window()->devicePixelRatio();
+}
+
+void MpvObject::swapped()
+{
+    mpv_opengl_cb_report_flip(mpv_gl, 0);
+}
+
+void MpvObject::cleanup()
+{
+    if (renderer) {
+        delete renderer;
+        renderer = 0;
+    }
+}
+
+void MpvObject::on_update(void *ctx)
+{
+    MpvObject *self = (MpvObject *)ctx;
+    emit self->onUpdate();
+}
+
+// connected to onUpdate(); signal makes sure it runs on the GUI thread
+void MpvObject::doUpdate()
+{
+    window()->update();
+}
+
+void MpvObject::command(const QVariant& params)
+{
+    mpv::qt::command_variant(mpv, params);
+}
+
+int main(int argc, char **argv)
+{
+    QGuiApplication app(argc, argv);
+
+    // Qt sets the locale in the QGuiApplication constructor, but libmpv
+    // requires the LC_NUMERIC category to be set to "C", so change it back.
+    std::setlocale(LC_NUMERIC, "C");
+
+    qmlRegisterType<MpvObject>("mpvtest", 1, 0, "MpvObject");
+
+    QQuickView view;
+    view.setResizeMode(QQuickView::SizeRootObjectToView);
+    view.setSource(QUrl("qrc:///mpvtest/main.qml"));
+    view.show();
+
+    return app.exec();
+}
@@ -0,0 +1,51 @@
+#ifndef MPVRENDERER_H_
+#define MPVRENDERER_H_
+
+#include <QtQuick/QQuickItem>
+
+#include <mpv/client.h>
+#include <mpv/opengl_cb.h>
+#include <mpv/qthelper.hpp>
+
+class MpvRenderer : public QObject
+{
+    Q_OBJECT
+    mpv::qt::Handle mpv;
+    mpv_opengl_cb_context *mpv_gl;
+    QQuickWindow *window;
+    QSize size;
+
+    friend class MpvObject;
+public:
+    MpvRenderer(mpv::qt::Handle a_mpv, mpv_opengl_cb_context *a_mpv_gl);
+    virtual ~MpvRenderer();
+public slots:
+    void paint();
+};
+
+class MpvObject : public QQuickItem
+{
+    Q_OBJECT
+
+    mpv::qt::Handle mpv;
+    mpv_opengl_cb_context *mpv_gl;
+    MpvRenderer *renderer;
+
+public:
+    MpvObject(QQuickItem * parent = 0);
+    virtual ~MpvObject();
+public slots:
+    void command(const QVariant& params);
+    void sync();
+    void swapped();
+    void cleanup();
+signals:
+    void onUpdate();
+private slots:
+    void doUpdate();
+    void handleWindowChanged(QQuickWindow *win);
+private:
+    static void on_update(void *ctx);
+};
+
+#endif
@@ -0,0 +1,49 @@
+import QtQuick 2.0
+import QtQuick.Controls 1.0
+
+import mpvtest 1.0
+
+Item {
+    width: 1280
+    height: 720
+
+    MpvObject {
+        id: renderer
+
+        // This object isn't real and not visible; it just renders into the
+        // background of the containing Window.
+        width: 0
+        height: 0
+    }
+
+    MouseArea {
+        anchors.fill: parent
+        onClicked: renderer.command(["loadfile", "../../../test.mkv"])
+    }
+
+    Rectangle {
+        id: labelFrame
+        anchors.margins: -50
+        radius: 5
+        color: "white"
+        border.color: "black"
+        opacity: 0.8
+        anchors.fill: box
+    }
+
+    Row {
+        id: box
+        anchors.bottom: parent.bottom
+        anchors.left: parent.left
+        anchors.right: parent.right
+        anchors.margins: 100
+
+        Text {
+            anchors.margins: 10
+            wrapMode: Text.WordWrap
+            text: "QtQuick and mpv are both rendering stuff.\n
+                   In this example, mpv is always in the background.\n
+                   Click to load ../../../test.mkv"
+        }
+    }
+}
@@ -0,0 +1,12 @@
+QT += qml quick
+
+HEADERS += main.h
+SOURCES += main.cpp
+
+QT_CONFIG -= no-pkg-config
+CONFIG += link_pkgconfig debug
+PKGCONFIG += mpv
+
+RESOURCES += mpvtest.qrc
+
+OTHER_FILES += main.qml
@@ -0,0 +1,5 @@
+<RCC>
+    <qresource prefix="/mpvtest">
+        <file>main.qml</file>
+    </qresource>
+</RCC>
@@ -0,0 +1,225 @@
+// This example can be built with: qmake && make
+
+#include <clocale>
+#include <sstream>
+#include <stdexcept>
+
+#include <QtGlobal>
+#include <QFileDialog>
+#include <QStatusBar>
+#include <QMenuBar>
+#include <QMenu>
+#include <QGridLayout>
+#include <QApplication>
+#include <QTextEdit>
+
+#if QT_VERSION >= 0x050000
+#include <QJsonDocument>
+#endif
+
+#include <mpv/qthelper.hpp>
+
+#include "qtexample.h"
+
+static void wakeup(void *ctx)
+{
+    // This callback is invoked from any mpv thread (but possibly also
+    // recursively from a thread that is calling the mpv API). Just notify
+    // the Qt GUI thread to wake up (so that it can process events with
+    // mpv_wait_event()), and return as quickly as possible.
+    MainWindow *mainwindow = (MainWindow *)ctx;
+    emit mainwindow->mpv_events();
+}
+
+MainWindow::MainWindow(QWidget *parent) :
+    QMainWindow(parent)
+{
+    setWindowTitle("Qt embedding demo");
+    setMinimumSize(640, 480);
+
+    QMenu *menu = menuBar()->addMenu(tr("&File"));
+    QAction *on_open = new QAction(tr("&Open"), this);
+    on_open->setShortcuts(QKeySequence::Open);
+    on_open->setStatusTip(tr("Open a file"));
+    connect(on_open, &QAction::triggered, this, &MainWindow::on_file_open);
+    menu->addAction(on_open);
+
+    QAction *on_new = new QAction(tr("&New window"), this);
+    connect(on_new, &QAction::triggered, this, &MainWindow::on_new_window);
+    menu->addAction(on_new);
+
+    statusBar();
+
+    QMainWindow *log_window = new QMainWindow(this);
+    log = new QTextEdit(log_window);
+    log->setReadOnly(true);
+    log_window->setCentralWidget(log);
+    log_window->setWindowTitle("mpv log window");
+    log_window->setMinimumSize(500, 50);
+    log_window->show();
+
+    mpv = mpv_create();
+    if (!mpv)
+        throw std::runtime_error("can't create mpv instance");
+
+    // Create a video child window. Force Qt to create a native window, and
+    // pass the window ID to the mpv wid option. Works on: X11, win32, Cocoa
+    mpv_container = new QWidget(this);
+    setCentralWidget(mpv_container);
+    mpv_container->setAttribute(Qt::WA_DontCreateNativeAncestors);
+    mpv_container->setAttribute(Qt::WA_NativeWindow);
+    // If you have a HWND, use: int64_t wid = (intptr_t)hwnd;
+    int64_t wid = mpv_container->winId();
+    mpv_set_option(mpv, "wid", MPV_FORMAT_INT64, &wid);
+
+    // Enable default bindings, because we're lazy. Normally, a player using
+    // mpv as backend would implement its own key bindings.
+    mpv_set_option_string(mpv, "input-default-bindings", "yes");
+
+    // Enable keyboard input on the X11 window. For the messy details, see
+    // --input-vo-keyboard on the manpage.
+    mpv_set_option_string(mpv, "input-vo-keyboard", "yes");
+
+    // Let us receive property change events with MPV_EVENT_PROPERTY_CHANGE if
+    // this property changes.
+    mpv_observe_property(mpv, 0, "time-pos", MPV_FORMAT_DOUBLE);
+
+    mpv_observe_property(mpv, 0, "track-list", MPV_FORMAT_NODE);
+    mpv_observe_property(mpv, 0, "chapter-list", MPV_FORMAT_NODE);
+
+    // Request log messages with level "info" or higher.
+    // They are received as MPV_EVENT_LOG_MESSAGE.
+    mpv_request_log_messages(mpv, "info");
+
+    // From this point on, the wakeup function will be called. The callback
+    // can come from any thread, so we use the QueuedConnection mechanism to
+    // relay the wakeup in a thread-safe way.
+    connect(this, &MainWindow::mpv_events, this, &MainWindow::on_mpv_events,
+            Qt::QueuedConnection);
+    mpv_set_wakeup_callback(mpv, wakeup, this);
+
+    if (mpv_initialize(mpv) < 0)
+        throw std::runtime_error("mpv failed to initialize");
+}
+
+void MainWindow::handle_mpv_event(mpv_event *event)
+{
+    switch (event->event_id) {
+    case MPV_EVENT_PROPERTY_CHANGE: {
+        mpv_event_property *prop = (mpv_event_property *)event->data;
+        if (strcmp(prop->name, "time-pos") == 0) {
+            if (prop->format == MPV_FORMAT_DOUBLE) {
+                double time = *(double *)prop->data;
+                std::stringstream ss;
+                ss << "At: " << time;
+                statusBar()->showMessage(QString::fromStdString(ss.str()));
+            } else if (prop->format == MPV_FORMAT_NONE) {
+                // The property is unavailable, which probably means playback
+                // was stopped.
+                statusBar()->showMessage("");
+            }
+        } else if (strcmp(prop->name, "chapter-list") == 0 ||
+                   strcmp(prop->name, "track-list") == 0)
+        {
+            // Dump the properties as JSON for demo purposes.
+#if QT_VERSION >= 0x050000
+            if (prop->format == MPV_FORMAT_NODE) {
+                QVariant v = mpv::qt::node_to_variant((mpv_node *)prop->data);
+                // Abuse JSON support for easily printing the mpv_node contents.
+                QJsonDocument d = QJsonDocument::fromVariant(v);
+                append_log("Change property " + QString(prop->name) + ":\n");
+                append_log(d.toJson().data());
+            }
+#endif
+        }
+        break;
+    }
+    case MPV_EVENT_VIDEO_RECONFIG: {
+        // Retrieve the new video size.
+        int64_t w, h;
+        if (mpv_get_property(mpv, "dwidth", MPV_FORMAT_INT64, &w) >= 0 &&
+            mpv_get_property(mpv, "dheight", MPV_FORMAT_INT64, &h) >= 0 &&
+            w > 0 && h > 0)
+        {
+            // Note that the MPV_EVENT_VIDEO_RECONFIG event doesn't necessarily
+            // imply a resize, and you should check yourself if the video
+            // dimensions really changed.
+            // mpv itself will scale/letter box the video to the container size
+            // if the video doesn't fit.
+            std::stringstream ss;
+            ss << "Reconfig: " << w << " " << h;
+            statusBar()->showMessage(QString::fromStdString(ss.str()));
+        }
+        break;
+    }
+    case MPV_EVENT_LOG_MESSAGE: {
+        struct mpv_event_log_message *msg = (struct mpv_event_log_message *)event->data;
+        std::stringstream ss;
+        ss << "[" << msg->prefix << "] " << msg->level << ": " << msg->text;
+        append_log(QString::fromStdString(ss.str()));
+        break;
+    }
+    case MPV_EVENT_SHUTDOWN: {
+        mpv_terminate_destroy(mpv);
+        mpv = NULL;
+        break;
+    }
+    default: ;
+        // Ignore uninteresting or unknown events.
+    }
+}
+
+// This slot is invoked by wakeup() (through the mpv_events signal).
+void MainWindow::on_mpv_events()
+{
+    // Process all events, until the event queue is empty.
+    while (mpv) {
+        mpv_event *event = mpv_wait_event(mpv, 0);
+        if (event->event_id == MPV_EVENT_NONE)
+            break;
+        handle_mpv_event(event);
+    }
+}
+
+void MainWindow::on_file_open()
+{
+    QString filename = QFileDialog::getOpenFileName(this, "Open file");
+    if (mpv) {
+        const QByteArray c_filename = filename.toUtf8();
+        const char *args[] = {"loadfile", c_filename.data(), NULL};
+        mpv_command_async(mpv, 0, args);
+    }
+}
+
+void MainWindow::on_new_window()
+{
+    (new MainWindow())->show();
+}
+
+void MainWindow::append_log(const QString &text)
+{
+    QTextCursor cursor = log->textCursor();
+    cursor.movePosition(QTextCursor::End);
+    cursor.insertText(text);
+    log->setTextCursor(cursor);
+}
+
+MainWindow::~MainWindow()
+{
+    if (mpv)
+        mpv_terminate_destroy(mpv);
+}
+
+int main(int argc, char *argv[])
+{
+    QApplication a(argc, argv);
+
+    // Qt sets the locale in the QApplication constructor, but libmpv requires
+    // the LC_NUMERIC category to be set to "C", so change it back.
+    std::setlocale(LC_NUMERIC, "C");
+
+    MainWindow w;
+    w.show();
+
+    return a.exec();
+}
@@ -0,0 +1,37 @@
+#ifndef QTEXAMPLE_H
+#define QTEXAMPLE_H
+
+#include <QMainWindow>
+
+#include <mpv/client.h>
+
+class QTextEdit;
+
+class MainWindow : public QMainWindow
+{
+    Q_OBJECT
+
+public:
+    explicit MainWindow(QWidget *parent = 0);
+    ~MainWindow();
+
+private slots:
+    void on_file_open();
+    void on_new_window();
+    void on_mpv_events();
+
+signals:
+    void mpv_events();
+
+private:
+    QWidget *mpv_container;
+    mpv_handle *mpv;
+    QTextEdit *log;
+
+    void append_log(const QString &text);
+
+    void create_player();
+    void handle_mpv_event(mpv_event *event);
+};
+
+#endif // QTEXAMPLE_H
@@ -0,0 +1,13 @@
+QT       += core gui
+
+greaterThan(QT_MAJOR_VERSION, 4): QT += widgets
+
+TARGET = qtexample
+TEMPLATE = app
+
+QT_CONFIG -= no-pkg-config
+CONFIG += link_pkgconfig debug
+PKGCONFIG += mpv
+
+SOURCES += qtexample.cpp
+HEADERS += qtexample.h
@@ -0,0 +1,13 @@
+#include <QApplication>
+#include "mainwindow.h"
+
+int main(int argc, char *argv[])
+{
+    QApplication a(argc, argv);
+    // Qt sets the locale in the QApplication constructor, but libmpv requires
+    // the LC_NUMERIC category to be set to "C", so change it back.
+    setlocale(LC_NUMERIC, "C");
+    MainWindow w;
+    w.show();
+    return a.exec();
+}
@@ -0,0 +1,52 @@
+#include "mainwindow.h"
+#include "mpvwidget.h"
+#include <QPushButton>
+#include <QSlider>
+#include <QLayout>
+#include <QFileDialog>
+
+MainWindow::MainWindow(QWidget *parent) : QWidget(parent)
+{
+    m_mpv = new MpvWidget(this);
+    m_slider = new QSlider();
+    m_slider->setOrientation(Qt::Horizontal);
+    m_openBtn = new QPushButton("Open");
+    m_playBtn = new QPushButton("Pause");
+    QHBoxLayout *hb = new QHBoxLayout();
+    hb->addWidget(m_openBtn);
+    hb->addWidget(m_playBtn);
+    QVBoxLayout *vl = new QVBoxLayout();
+    vl->addWidget(m_mpv);
+    vl->addWidget(m_slider);
+    vl->addLayout(hb);
+    setLayout(vl);
+    connect(m_slider, SIGNAL(sliderMoved(int)), SLOT(seek(int)));
+    connect(m_openBtn, SIGNAL(clicked()), SLOT(openMedia()));
+    connect(m_playBtn, SIGNAL(clicked()), SLOT(pauseResume()));
+    connect(m_mpv, SIGNAL(positionChanged(int)), m_slider, SLOT(setValue(int)));
+    connect(m_mpv, SIGNAL(durationChanged(int)), this, SLOT(setSliderRange(int)));
+}
+
+void MainWindow::openMedia()
+{
+    QString file = QFileDialog::getOpenFileName(0, "Open a video");
+    if (file.isEmpty())
+        return;
+    m_mpv->command(QStringList() << "loadfile" << file);
+}
+
+void MainWindow::seek(int pos)
+{
+    m_mpv->command(QVariantList() << "seek" << pos << "absolute");
+}
+
+void MainWindow::pauseResume()
+{
+    const bool paused = m_mpv->getProperty("pause").toBool();
+    m_mpv->setProperty("pause", !paused);
+}
+
+void MainWindow::setSliderRange(int duration)
+{
+    m_slider->setRange(0, duration);
+}
@@ -0,0 +1,27 @@
+#ifndef MainWindow_H
+#define MainWindow_H
+
+#include <QtWidgets/QWidget>
+
+class MpvWidget;
+class QSlider;
+class QPushButton;
+class MainWindow : public QWidget
+{
+    Q_OBJECT
+public:
+    explicit MainWindow(QWidget *parent = 0);
+public Q_SLOTS:
+    void openMedia();
+    void seek(int pos);
+    void pauseResume();
+private Q_SLOTS:
+    void setSliderRange(int duration);
+private:
+    MpvWidget *m_mpv;
+    QSlider *m_slider;
+    QPushButton *m_openBtn;
+    QPushButton *m_playBtn;
+};
+
+#endif // MainWindow_H
@@ -0,0 +1,129 @@
+#include "mpvwidget.h"
+#include <stdexcept>
+#include <QtGui/QOpenGLContext>
+#include <QtCore/QMetaObject>
+
+static void wakeup(void *ctx)
+{
+    QMetaObject::invokeMethod((MpvWidget*)ctx, "on_mpv_events", Qt::QueuedConnection);
+}
+
+static void *get_proc_address(void *ctx, const char *name) {
+    Q_UNUSED(ctx);
+    QOpenGLContext *glctx = QOpenGLContext::currentContext();
+    if (!glctx)
+        return NULL;
+    return (void *)glctx->getProcAddress(QByteArray(name));
+}
+
+MpvWidget::MpvWidget(QWidget *parent, Qt::WindowFlags f)
+    : QOpenGLWidget(parent, f)
+{
+    mpv = mpv::qt::Handle::FromRawHandle(mpv_create());
+    if (!mpv)
+        throw std::runtime_error("could not create mpv context");
+
+    mpv_set_option_string(mpv, "terminal", "yes");
+    mpv_set_option_string(mpv, "msg-level", "all=v");
+    if (mpv_initialize(mpv) < 0)
+        throw std::runtime_error("could not initialize mpv context");
+
+    // Make use of the MPV_SUB_API_OPENGL_CB API.
+    mpv::qt::set_option_variant(mpv, "vo", "opengl-cb");
+
+    // Request hw decoding, just for testing.
+    mpv::qt::set_option_variant(mpv, "hwdec", "auto");
+
+    mpv_gl = (mpv_opengl_cb_context *)mpv_get_sub_api(mpv, MPV_SUB_API_OPENGL_CB);
+    if (!mpv_gl)
+        throw std::runtime_error("OpenGL not compiled in");
+    mpv_opengl_cb_set_update_callback(mpv_gl, MpvWidget::on_update, (void *)this);
+    connect(this, SIGNAL(frameSwapped()), SLOT(swapped()));
+
+    mpv_observe_property(mpv, 0, "duration", MPV_FORMAT_DOUBLE);
+    mpv_observe_property(mpv, 0, "time-pos", MPV_FORMAT_DOUBLE);
+    mpv_set_wakeup_callback(mpv, wakeup, this);
+}
+
+MpvWidget::~MpvWidget()
+{
+    makeCurrent();
+    if (mpv_gl)
+        mpv_opengl_cb_set_update_callback(mpv_gl, NULL, NULL);
+    // Until this call is done, we need to make sure the player remains
+    // alive. This is done implicitly with the mpv::qt::Handle instance
+    // in this class.
+    mpv_opengl_cb_uninit_gl(mpv_gl);
+}
+
+void MpvWidget::command(const QVariant& params)
+{
+    mpv::qt::command_variant(mpv, params);
+}
+
+void MpvWidget::setProperty(const QString& name, const QVariant& value)
+{
+    mpv::qt::set_property_variant(mpv, name, value);
+}
+
+QVariant MpvWidget::getProperty(const QString &name) const
+{
+    return mpv::qt::get_property_variant(mpv, name);
+}
+
+void MpvWidget::initializeGL()
+{
+    int r = mpv_opengl_cb_init_gl(mpv_gl, NULL, get_proc_address, NULL);
+    if (r < 0)
+        throw std::runtime_error("could not initialize OpenGL");
+}
+
+void MpvWidget::paintGL()
+{
+    mpv_opengl_cb_draw(mpv_gl, defaultFramebufferObject(), width(), -height());
+}
+
+void MpvWidget::swapped()
+{
+    mpv_opengl_cb_report_flip(mpv_gl, 0);
+}
+
+void MpvWidget::on_mpv_events()
+{
+    // Process all events, until the event queue is empty.
+    while (mpv) {
+        mpv_event *event = mpv_wait_event(mpv, 0);
+        if (event->event_id == MPV_EVENT_NONE) {
+            break;
+        }
+        handle_mpv_event(event);
+    }
+}
+
+void MpvWidget::handle_mpv_event(mpv_event *event)
+{
+    switch (event->event_id) {
+    case MPV_EVENT_PROPERTY_CHANGE: {
+        mpv_event_property *prop = (mpv_event_property *)event->data;
+        if (strcmp(prop->name, "time-pos") == 0) {
+            if (prop->format == MPV_FORMAT_DOUBLE) {
+                double time = *(double *)prop->data;
+                Q_EMIT positionChanged(time);
+            }
+        } else if (strcmp(prop->name, "duration") == 0) {
+            if (prop->format == MPV_FORMAT_DOUBLE) {
+                double time = *(double *)prop->data;
+                Q_EMIT durationChanged(time);
+            }
+        }
+        break;
+    }
+    default: ;
+        // Ignore uninteresting or unknown events.
+    }
+}
+
+void MpvWidget::on_update(void *ctx)
+{
+    QMetaObject::invokeMethod((MpvWidget*)ctx, "update");
+}
@@ -0,0 +1,38 @@
+#ifndef PLAYERWINDOW_H
+#define PLAYERWINDOW_H
+
+#include <QtWidgets/QOpenGLWidget>
+#include <mpv/client.h>
+#include <mpv/opengl_cb.h>
+#include <mpv/qthelper.hpp>
+
+class MpvWidget Q_DECL_FINAL: public QOpenGLWidget
+{
+    Q_OBJECT
+public:
+    MpvWidget(QWidget *parent = 0, Qt::WindowFlags f = 0);
+    ~MpvWidget();
+    void command(const QVariant& params);
+    void setProperty(const QString& name, const QVariant& value);
+    QVariant getProperty(const QString& name) const;
+    QSize sizeHint() const { return QSize(480, 270);}
+Q_SIGNALS:
+    void durationChanged(int value);
+    void positionChanged(int value);
+protected:
+    void initializeGL() Q_DECL_OVERRIDE;
+    void paintGL() Q_DECL_OVERRIDE;
+private Q_SLOTS:
+    void swapped();
+    void on_mpv_events();
+private:
+    void handle_mpv_event(mpv_event *event);
+    static void on_update(void *ctx);
+
+    mpv::qt::Handle mpv;
+    mpv_opengl_cb_context *mpv_gl;
+};
+
+
+
+#endif // PLAYERWINDOW_H
@@ -0,0 +1,13 @@
+CONFIG -= app_bundle
+QT += widgets
+
+QT_CONFIG -= no-pkg-config
+CONFIG += link_pkgconfig debug
+PKGCONFIG += mpv
+
+HEADERS = \
+    mpvwidget.h \
+    mainwindow.h
+SOURCES = main.cpp \
+    mpvwidget.cpp \
+    mainwindow.cpp
@@ -0,0 +1,158 @@
+// Build with: gcc -o main main.c `pkg-config --libs --cflags mpv sdl2`
+
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#include <SDL.h>
+
+#include <mpv/client.h>
+#include <mpv/opengl_cb.h>
+
+static Uint32 wakeup_on_mpv_redraw, wakeup_on_mpv_events;
+
+static void die(const char *msg)
+{
+    fprintf(stderr, "%s\n", msg);
+    exit(1);
+}
+
+static void *get_proc_address_mpv(void *fn_ctx, const char *name)
+{
+    return SDL_GL_GetProcAddress(name);
+}
+
+static void on_mpv_events(void *ctx)
+{
+    SDL_Event event = {.type = wakeup_on_mpv_events};
+    SDL_PushEvent(&event);
+}
+
+static void on_mpv_redraw(void *ctx)
+{
+    SDL_Event event = {.type = wakeup_on_mpv_redraw};
+    SDL_PushEvent(&event);
+}
+
+int main(int argc, char *argv[])
+{
+    if (argc != 2)
+        die("pass a single media file as argument");
+
+    mpv_handle *mpv = mpv_create();
+    if (!mpv)
+        die("context init failed");
+
+    // Some minor options can only be set before mpv_initialize().
+    if (mpv_initialize(mpv) < 0)
+        die("mpv init failed");
+
+    if (SDL_Init(SDL_INIT_VIDEO) < 0)
+        die("SDL init failed");
+
+    SDL_Window *window =
+        SDL_CreateWindow("hi", SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED,
+                         1000, 500, SDL_WINDOW_OPENGL | SDL_WINDOW_SHOWN |
+                                    SDL_WINDOW_RESIZABLE);
+    if (!window)
+        die("failed to create SDL window");
+
+    // The OpenGL API is somewhat separate from the normal mpv API. This only
+    // returns NULL if no OpenGL support is compiled.
+    mpv_opengl_cb_context *mpv_gl = mpv_get_sub_api(mpv, MPV_SUB_API_OPENGL_CB);
+    if (!mpv_gl)
+        die("failed to create mpv GL API handle");
+
+    SDL_GLContext glcontext = SDL_GL_CreateContext(window);
+    if (!glcontext)
+        die("failed to create SDL GL context");
+
+    // This makes mpv use the currently set GL context. It will use the callback
+    // to resolve GL builtin functions, as well as extensions.
+    if (mpv_opengl_cb_init_gl(mpv_gl, NULL, get_proc_address_mpv, NULL) < 0)
+        die("failed to initialize mpv GL context");
+
+    // Actually using the opengl_cb state has to be explicitly requested.
+    // Otherwise, mpv will create a separate platform window.
+    if (mpv_set_option_string(mpv, "vo", "opengl-cb") < 0)
+        die("failed to set VO");
+
+    // We use events for thread-safe notification of the SDL main loop.
+    // Generally, the wakeup callbacks (set further below) should do as least
+    // work as possible, and merely wake up another thread to do actual work.
+    // On SDL, waking up the mainloop is the ideal course of action. SDL's
+    // SDL_PushEvent() is thread-safe, so we use that.
+    wakeup_on_mpv_redraw = SDL_RegisterEvents(1);
+    wakeup_on_mpv_events = SDL_RegisterEvents(1);
+    if (wakeup_on_mpv_redraw == (Uint32)-1 || wakeup_on_mpv_events == (Uint32)-1)
+        die("could not register events");
+
+    // When normal mpv events are available.
+    mpv_set_wakeup_callback(mpv, on_mpv_events, NULL);
+
+    // When a new frame should be drawn with mpv_opengl_cb_draw().
+    // (Separate from the normal event handling mechanism for the sake of
+    //  users which run OpenGL on a different thread.)
+    mpv_opengl_cb_set_update_callback(mpv_gl, on_mpv_redraw, NULL);
+
+    // Play this file. Note that this starts playback asynchronously.
+    const char *cmd[] = {"loadfile", argv[1], NULL};
+    mpv_command(mpv, cmd);
+
+    while (1) {
+        SDL_Event event;
+        if (SDL_WaitEvent(&event) != 1)
+            die("event loop error");
+        int redraw = 0;
+        switch (event.type) {
+        case SDL_QUIT:
+            goto done;
+        case SDL_WINDOWEVENT:
+            if (event.window.event == SDL_WINDOWEVENT_EXPOSED)
+                redraw = 1;
+            break;
+        case SDL_KEYDOWN:
+            if (event.key.keysym.sym == SDLK_SPACE)
+                mpv_command_string(mpv, "cycle pause");
+            break;
+        default:
+            // Happens when a new video frame should be rendered, or if the
+            // current frame has to be redrawn e.g. due to OSD changes.
+            if (event.type == wakeup_on_mpv_redraw)
+                redraw = 1;
+            // Happens when at least 1 new event is in the mpv event queue.
+            if (event.type == wakeup_on_mpv_events) {
+                // Handle all remaining mpv events.
+                while (1) {
+                    mpv_event *mp_event = mpv_wait_event(mpv, 0);
+                    if (mp_event->event_id == MPV_EVENT_NONE)
+                        break;
+                    printf("event: %s\n", mpv_event_name(mp_event->event_id));
+                }
+            }
+        }
+        if (redraw) {
+            int w, h;
+            SDL_GetWindowSize(window, &w, &h);
+            // Note:
+            // - The 0 is the FBO to use; 0 is the default framebuffer (i.e.
+            //   render to the window directly.
+            // - The negative height tells mpv to flip the coordinate system.
+            // - If you do not want the video to cover the whole screen, or want
+            //   to apply any form of fancy transformation, you will have to
+            //   render to a FBO.
+            // - See opengl_cb.h on what OpenGL environment mpv expects, and
+            //   other API details.
+            mpv_opengl_cb_draw(mpv_gl, 0, w, -h);
+            SDL_GL_SwapWindow(window);
+        }
+    }
+done:
+
+    // Destroy the GL renderer and all of the GL objects it allocated. If video
+    // is still running, the video track will be deselected.
+    mpv_opengl_cb_uninit_gl(mpv_gl);
+
+    mpv_terminate_destroy(mpv);
+    return 0;
+}
@@ -0,0 +1,54 @@
+// Build with: gcc -o simple simple.c `pkg-config --libs --cflags mpv`
+
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#include <mpv/client.h>
+
+static inline void check_error(int status)
+{
+    if (status < 0) {
+        printf("mpv API error: %s\n", mpv_error_string(status));
+        exit(1);
+    }
+}
+
+int main(int argc, char *argv[])
+{
+    if (argc != 2) {
+        printf("pass a single media file as argument\n");
+        return 1;
+    }
+
+    mpv_handle *ctx = mpv_create();
+    if (!ctx) {
+        printf("failed creating context\n");
+        return 1;
+    }
+
+    // Enable default key bindings, so the user can actually interact with
+    // the player (and e.g. close the window).
+    check_error(mpv_set_option_string(ctx, "input-default-bindings", "yes"));
+    mpv_set_option_string(ctx, "input-vo-keyboard", "yes");
+    int val = 1;
+    check_error(mpv_set_option(ctx, "osc", MPV_FORMAT_FLAG, &val));
+
+    // Done setting up options.
+    check_error(mpv_initialize(ctx));
+
+    // Play this file.
+    const char *cmd[] = {"loadfile", argv[1], NULL};
+    check_error(mpv_command(ctx, cmd));
+
+    // Let it play, and wait until the user quits.
+    while (1) {
+        mpv_event *event = mpv_wait_event(ctx, 10000);
+        printf("event: %s\n", mpv_event_name(event->event_id));
+        if (event->event_id == MPV_EVENT_SHUTDOWN)
+            break;
+    }
+
+    mpv_terminate_destroy(ctx);
+    return 0;
+}
@@ -1,177 +0,0 @@
-CLI and API compatibility policy
-================================
-
-Human users and API users rely on the mpv/libmpv/scripting/IPC interface not
-breaking their use case. On the other hand, active development occasionally
-requires breaking things, such as removing old options or changing options in
-a way that may break.
-
-This document lists rules when, what, and how incompatible changes can be made.
-It's interesting both for mpv developers, who want to change user-visible parts,
-and mpv users, who want to know what is guaranteed to remain stable.
-
-Any of the rules below may be overridden by statements in more specific
-documentation (for example, if the manpage says that a particular option may be
-removed any time, it means that, and the option probably won't even go through
-deprecation).
-
-Additions
---------
-
-Additions are basically always allowed. API users etc. are supposed to deal with
-the possibility that for example new API functions are added. Some parts of the
-API may document how they are extended.
-
-Options, commands, properties, events, hooks (command interface)
----------------------------------------------------------------
-
-All of these are important for interfacing both with end users and API users
-(which include Lua scripts, libmpv, and the JSON IPC). As such, they constitute
-a large part of the user interface and APIs.
-
-All incompatible changes to this must be declared in interface-changes.rst.
-(This may also list compatible additions, but it's not a requirement.)
-
-Degrees of importance and compatibility preservation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Critical and central parts of the command interface have the strictest
-requirements. It may not be reasonable to break them, and other means to achieve
-some change have to be found. For example, the "seek" command is a bit of a
-mess, but since changing it would likely affect almost every user, it may be
-impossible to break at least the commonly used syntax. If changed anyway, there
-should be a deprecation period of at least 1 year, during which the command
-still works, and possibly a warning should remain even after this.
-
-Important/often used parts must be deprecated for at least 2 releases before
-they can be broken. There must be at least 1 release where the deprecated
-functionality still works, and a replacement is available (if technically
-reasonable). For example, a feature deprecated in mpv 0.30.0 may be removed in
-mpv 0.32.0. Minor releases do not count towards this.
-
-Less useful parts can be broken immediately, but must come with some sort of
-removal warning-
-
-Parts for debugging and testing may be removed any time, potentially even
-without any sort of documentation.
-
-Currently, the importance of a part is not documented and not even well-defined,
-which is probably a mistake.
-
-Renaming or removing options
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Typically, renaming an option can be done in a compatible way with OPT_REPLACED.
-You may need to check whether the corresponding properties still work (including
-messy details like observing properties for changes).
-
-OPT_REMOVED can be used to inform the user of alternatives or reasons for the
-removal, which is better than an option not found error. Likewise,
-m_option.deprecation_message should be set to something helpful.
-
-Both OPT_REPLACED and OPT_REMOVED can remain in the code for a long time, since
-they're unintrusive and hopefully make incompatible changes less painful for
-users.
-
-Scripting APIs
--------------
-
-This affects internal scripting APIs (currently Lua and JavaScript).
-
-Vaguely the same rules as with the command interface apply. Since there is a
-large number of scripts, an effort should be made to provide compatibility
-for old scripts, but it does not need to be stronger than that of the command
-interface.
-
-Undocumented parts of the scripting APIs are _not_ guaranteed for compatibility.
-This applies especially for internals. Languages like Lua do not have strict
-access control (nor does the mpv code try to emulate any), so if a script
-accesses private parts, and breaks on the next mpv release, it's not mpv's
-problem.
-
-JSON IPC
--------
-
-The JSON IPC is a thin protocol wrapping the libmpv API and the command
-interface. Compatibility-wise, it's about the same as the scripting APIs.
-The JSON protocol commands should remain as compatible as possible, and it
-should probably accept the current way commands are delimited (line breaks)
-forever.
-
-The protocol may accept non-standard JSON extensions, but only standard JSON
-(possibly with restrictions) is guaranteed for compatibility. Clients which want
-to remain compatible should not use any extensions.
-
-CLI
---
-
-Things such as default key bindings do not necessarily require compatibility.
-However, the release notes should be extremely clear on changes to "important"
-key bindings. Bindings which restore the old behavior should be added to
-restore-old-bindings.conf.
-
-Some option parsing is CLI-only and not available from libmpv or scripting. No
-compatibility guarantees come with them. However, the rules which mpv uses to
-distinguish between options and filenames must remain consistent (if the
-non-deprecated options syntax is used).
-
-Terminal and log output
-----------------------
-
-There are no compatibility guarantees for the terminal output, or the text
-logged via ``MPV_EVENT_LOG_MESSAGE`` and similar APIs. In particular, scripts
-invoking mpv CLI are extremely discouraged from trying to parse text output,
-and should use other mechanisms such as the JSON IPC.
-
-Protocols, filters, demuxers, etc.
----------------------------------
-
-Which of these are present is generally not guaranteed, and can even depend
-on compile time settings.
-
-The filter list and their sub-options are considered part of the
-command-interface.
-
-libmpv C API
------------
-
-The libmpv client API (such as ``<libmpv/client.h>``) mostly gives access to
-the command interface. The API itself (if looked at as a component separate
-from the command interface) is intended to be extremely stable.
-
-All API changes are documented in client-api-changes.rst.
-
-API compatibility
-^^^^^^^^^^^^^^^^^
-
-The API is *always* compatible. Incompatible changes are only allowed on major
-API version changes (see ``MPV_CLIENT_API_VERSION``). A major version change is
-an extremely rare event, which means usually no API symbols are ever removed.
-
-Essentially removing API functions by making them always return an error, or
-making it do nothing is allowed in cases where it is unlikely to break most
-clients, but requires a deprecation period of 2 releases. (This has happened to
-``mpv_suspend()`` for example.)
-
-API symbols can be deprecated. This should be clearly marked in the doxygen
-with ``@deprecated``, and if possible, the affected API symbols should not be
-visible if the API user defines ``MPV_ENABLE_DEPRECATED`` to 0.
-
-ABI compatibility
-^^^^^^^^^^^^^^^^^
-
-The ABI must never be broken, except on major API version changes. For example,
-constants don't change their values.
-
-Structs are tricky. If a struct can be allocated by a user (such as ``mpv_node``),
-no fields can be added. (Unless it's an union, and the addition does not change
-the offset or alignment of any of the fields or the struct itself. This has
-happened to ``mpv_node`` in the past.) If a struct is allocated by libmpv only,
-new fields can be appended to the end (for example ``mpv_event``).
-
-The ABI is only backward compatible. This means if a host application is linked
-to an older libmpv, and libmpv is updated to a newer version, it will still
-work (as in not causing any undefined behavior).
-
-Forward compatibility (an application would work with an older libmpv than it
-was linked to) is not required.
@@ -22,7 +22,7 @@ When cross-compiling, you have to run mpv's configure with these arguments:
 DEST_OS=win32 TARGET=i686-w64-mingw32 ./waf configure
 ```

-[MXE](https://mxe.cc) makes it very easy to bootstrap a complete MingGW-w64
+[MXE](http://mxe.cc) makes it very easy to bootstrap a complete MingGW-w64
 environment from a Linux machine. See a working example below.

 Alternatively, you can try [mingw-w64-cmake](https://github.com/lachs0r/mingw-w64-cmake),
@@ -38,7 +38,7 @@ Example with MXE
 #
 # Refer to
 #
-#    https://mxe.cc/#requirements
+#    http://mxe.cc/#requirements
 #
 # Scroll down for disto/OS-specific instructions to install them.

@@ -68,7 +68,7 @@ echo "MXE_TARGETS := i686-w64-mingw32.static" >> settings.mk
 # Build required packages. The following provide a minimum required to build
 # a reasonable mpv binary (though not an absolute minimum).

-make gcc ffmpeg libass jpeg lua luajit
+make gcc ffmpeg libass jpeg lua

 # Add MXE binaries to $PATH
 export PATH=/opt/mxe/usr/bin/:$PATH
@@ -101,27 +101,25 @@ Installing MSYS2

 1. Download an installer from https://msys2.github.io/

-   Both the i686 and the x86_64 version of MSYS2 can build 32-bit and 64-bit
-   mpv binaries when running on a 64-bit version of Windows, but the x86_64
-   version is preferred since the larger address space makes it less prone to
-   fork() errors.
+   It doesn't matter whether the i686 or the x86_64 version is used. Both can
+   build 32-bit and 64-bit binaries when running on a 64-bit version of Windows.

-2. Start a MinGW-w64 shell (``mingw64.exe``). **Note:** This is different from
-   the MSYS2 shell that is started from the final installation dialog. You must
-   close that shell and open a new one.
+2. Add ``C:\msys64\mingw64\bin`` to your ``%PATH%``. mpv will depend on several
+   DLLs in this folder.

-   For a 32-bit build, use ``mingw32.exe``.
+3. Start a MinGW-w64 shell (``mingw64_shell.bat``). For a 32-bit build, use
+   ``mingw32_shell.bat``.

 Updating MSYS2
 --------------

-To prevent errors during post-install, the MSYS2 core runtime must be updated
-separately.
+To prevent errors during post-install, ``msys2-runtime`` and ``pacman`` must be
+updated first.

 ```bash
-# Check for core updates. If instructed, close the shell window and reopen it
-# before continuing.
-pacman -Syu
+# Check for updates to msys2-runtime and pacman. If there were updates, restart
+# MSYS2 before continuing.
+pacman -Sy --needed msys2-runtime pacman

 # Update everything else
 pacman -Su
@@ -132,82 +130,46 @@ Installing mpv dependencies

 ```bash
 # Install MSYS2 build dependencies and a MinGW-w64 compiler
-pacman -S git python $MINGW_PACKAGE_PREFIX-{pkg-config,gcc}
+pacman -S git pkg-config python3 mingw-w64-x86_64-gcc

-# Install the most important MinGW-w64 dependencies. libass and lcms2 are also
-# pulled in as dependencies of ffmpeg.
-pacman -S $MINGW_PACKAGE_PREFIX-{ffmpeg,libjpeg-turbo,lua51}
+# Install the most important MinGW-w64 dependencies. libass, libbluray and
+# lcms2 are also pulled in as dependencies of ffmpeg.
+pacman -S mingw-w64-x86_64-ffmpeg mingw-w64-x86_64-libjpeg-turbo mingw-w64-x86_64-lua51
+
+# Install additional (optional) dependencies
+pacman -S mingw-w64-x86_64-libdvdnav mingw-w64-x86_64-libguess
 ```

+For a 32-bit build, install ``mingw-w64-i686-*`` packages instead.
+
 Building mpv
 ------------

-Clone the latest mpv from git and install waf. **Note:** ``/usr/bin/python3``
-is invoked directly here, since an MSYS2 version of Python is required.
+Clone the latest mpv from git and install waf:

 ```bash
 git clone https://github.com/mpv-player/mpv.git && cd mpv
-/usr/bin/python3 bootstrap.py
+./bootstrap.py
 ```

 Finally, compile and install mpv. Binaries will be installed to
-``/mingw64/bin`` or ``/mingw32/bin``.
+``/mingw64/bin``.

 ```bash
-/usr/bin/python3 waf configure CC=gcc.exe --check-c-compiler=gcc --prefix=$MSYSTEM_PREFIX
-/usr/bin/python3 waf install
+# For a 32-bit build, use --prefix=/mingw32 instead
+./waf configure CC=gcc --prefix=/mingw64
+./waf install
 ```

 Or, compile and install both libmpv and mpv:

 ```bash
-/usr/bin/python3 waf configure CC=gcc.exe --check-c-compiler=gcc --enable-libmpv-shared --prefix=$MSYSTEM_PREFIX
-/usr/bin/python3 waf install
+./waf configure CC=gcc --enable-libmpv-shared --prefix=/mingw64
+./waf install
+
+# waf installs libmpv to the wrong directory, so fix it up
+mv -f /mingw64/bin/pkgconfig/mpv.pc /mingw64/lib/pkgconfig/
+mv -f /mingw64/bin/libmpv.dll.a /mingw64/lib/
+sed -i 's_/mingw64/bin_/mingw64/lib_' /mingw64/lib/pkgconfig/mpv.pc
+rmdir /mingw64/bin/pkgconfig
 ```
-
-Linking libmpv with MSVC programs
---------------------------------
-
-mpv/libmpv cannot be built with Visual Studio (Microsoft is too incompetent to
-support C99/C11 properly and/or hates open source and Linux too much to
-seriously do it). But you can build C++ programs in Visual Studio and link them
-with a libmpv built with MinGW.
-
-To do this, you need a Visual Studio which supports ``stdint.h`` (recent ones do),
-and you need to create a import library for the mpv DLL:
-
-```bash
-lib /def:mpv.def /name:mpv-1.dll /out:mpv.lib /MACHINE:X64
-```
-
-The string in the ``/name:`` parameter must match the filename of the DLL (this
-is simply the filename the MSVC linker will use). The ``mpv.def`` can be
-retrieved from the mpv build directory, or can be produced by MingGW's
-gendef.exe helper from the mpv DLL.
-
-Static linking is not possible.
-
-Running mpv
-----------
-
-If you want to run mpv from the MinGW-w64 shell, you will find the experience
-much more pleasant if you use the ``winpty`` utility
-
-```bash
-pacman -S winpty
-winpty mpv.com ToS-4k-1920.mov
-```
-
-If you want to move / copy ``mpv.exe`` and ``mpv.com`` to somewhere other than
-``/mingw64/bin/`` for use outside the MinGW-w64 shell, they will still depend on
-DLLs in that folder. The simplest solution is to add ``C:\msys64\mingw64\bin``
-to the windows system ``%PATH%``. Beware though that this can cause problems or
-confusion in Cygwin if that is also installed on the machine.
-
-Use of the ANGLE OpenGL backend requires a copy of the D3D compiler DLL that
-matches the version of the D3D SDK that ANGLE was built with
-(``d3dcompiler_43.dll`` in case of MinGW-built ANGLE) in the path or in the
-same folder as mpv. It must be of the same architecture (x86_64 / i686) as the
-mpv you compiled. You can find copies here:
-
-https://mpv.srsfckn.biz/d3dcompiler.7z
@@ -5,61 +5,27 @@ General
 -------

 The main contact for mpv development is IRC, specifically #mpv
-and #mpv-devel on Libera.chat. Github is used for code review and
-long term discussions.
+and #mpv-devel on Freenode.

 Sending patches
 ---------------

 - Make a github pull request, or send a link to a plaintext patch created with
-  ``git format-patch``.
- Plain diffs posted as pastebins are not acceptable! (Especially if the http
-  link returns HTML.) They only cause extra work for everyone, because they lack
-  commit message and authorship information.
- Never send patches to any of the developers email addresses.
- If your changes are not supposed to be merged immediately, mark them as
-  "[RFC]" in the commit message or the pull request title.
- Be sure to test your changes. If you didn't, please say so in the commit
-  message and the pull request text.
-
-Copyright of contributions
--------------------------
-
- The copyright belongs to contributors. The project is a collaborative work. By
-  sending your changes, you agree to license your contributions according to the
-  requirements of this project.
+  ``git format-patch``. diffs posted as pastebins (especially if the http link
+  returns HTML) just cause extra work for everyone, because they lack commit
+  message and authorship information.
 - All new code must be LGPLv2.1+ licensed, or come with the implicit agreement
  that it will be relicensed to LGPLv2.1+ later (see ``Copyright`` in the
  repository root directory).
- 100% compatible licenses are allowed too.
- Changes in files with more liberal licenses (such as BSD, MIT, or ISC) are
-  assumed to be dual-licensed under LGPLv2.1+ and the license indicated in the
-  file header.
- You must be either the exclusive author of the patch, or acknowledge all
-  authors involved in the commit message. If you take 3rd party code, authorship
-  and copyright must be properly acknowledged. If you're making changes on
-  behalf of your employer, and the employer owns the copyright, you must mention
-  this. If the license of the code is not LGPLv2.1+, you must mention this.
- These license statements are legally binding.
- Don't use fake names (something that looks like an actual name, and may be
-  someone else's name, but is not your legal name). Using a pseudonyms is
-  allowed if it can be used to identify or contact you, even if whatever
-  account you used to submit the patch dies.
- Do not add your name to the license header. This convention is not used by
-  this project, and neither copyright law nor any of the used licenses require
-  it.
-
-Write good commit messages
--------------------------
-
+- When creating pull requests, be sure to test your changes. If you didn't,
+  please say so in the pull request message.
 - Write informative commit messages. Use present tense to describe the
  situation with the patch applied, and past tense for the situation before
  the change.
- The subject line (the first line in a commit message) must contain a
+- The subject line (the first line in a commit message) should contain a
  prefix identifying the sub system, followed by a short description what
-  impact this commit has. This subject line and the commit message body
-  must not be longer than 72 characters per line, because it messes up the
-  output of many git tools otherwise.
+  impact this commit has. This subject line shouldn't be longer than 72
+  characters, because it messes up the output of many git tools otherwise.

  For example, you fixed a crash in af_volume.c:

@@ -68,16 +34,7 @@ Write good commit messages

  Having a prefix gives context, and is especially useful when trying to find
  a specific change by looking at the history, or when running ``git blame``.
-
-  Sample prefixes: ``vo_gpu: ...``, ``command: ...``, ``DOCS/input: ...``,
-  ``TOOLS/osxbundle: ...``, ``osc.lua: ...``, etc. You can always check the git
-  log for commits which modify specific files to see which prefixes are used.
-
- The first word after the ``:`` is lower case.
- Don't end the subject line with a ``.``.
- Put an empty line between the subject line and the commit message.
-  If this is missing, it will break display in common git tools.
- The body of the commit message (everything else after the subject line) must
+- The body of the commit message (everything else after the subject line) should
  be as informative as possible and contain everything that isn't obvious. Don't
  hesitate to dump as much information as you can - it doesn't cost you
  anything. Put some effort into it. If someone finds a bug months or years
@@ -86,56 +43,22 @@ Write good commit messages
  information to test the original bug. The old bug might be reintroduced while
  fixing the new bug.

-  The commit message must be wrapped on 72 characters per line, because git
+  The commit message should be wrapped on 72 characters per line, because git
  tools usually do not break text automatically. On the other hand, you do not
  need to break text that would be unnatural to break (like data for test cases,
  or long URLs).
- Another summary of good conventions: https://chris.beams.io/posts/git-commit/

-Split changes into multiple commits
-----------------------------------
-
- Follow git good practices, and split independent changes into several commits.
-  It's usually OK to put them into a single pull request.
+  Important: put an empty line between the subject line and the commit message.
+  If this is missing, it will break display in common git tools.
 - Try to separate cosmetic and functional changes. It's ok to make a few
  additional cosmetic changes in the same file you're working on. But don't do
  something like reformatting a whole file, and hiding an actual functional
  change in the same commit.
- Splitting changes does _not_ mean that you should make them as fine-grained
-  as possible. Commits should form logical steps in development. The way you
-  split changes is important for code review and analyzing bugs.
-
-Always squash fixup commits when making changes to pull requests
----------------------------------------------------------------
-
- If you make fixup commits to your pull request, you should generally squash
-  them with "git rebase -i". We prefer to have pull requests in a merge
-  ready state.
- We don't squash-merge (nor do we use github's feature that does this) because
-  pull requests with multiple commits are perfectly legitimate, and the only
-  thing that makes sense in non-trivial cases.
- With complex pull requests, it *may* make sense to keep them separate, but
-  they should be clearly marked as such. Reviewing commits is generally easier
-  with fixups squashed.
- Reviewers are encouraged to look at individual commits instead of github's
-  "changes from all commits" view (which just encourages bad git and review
-  practices).
-
-Touching user-visible parts may require updating the mpv docs
-------------------------------------------------------------
-
- Most user-visible things are normally documented in DOCS/man/. If your commit
-  touches documented behavior, list of sub-options, etc., you need to adjust the
-  documentation.
- These changes usually go into the same commit that changes the code.
- Changes to command line options (addition/modification/removal) must be
-  documented in options.rst.
- Changes to input properties or input commands must be documented in input.rst.
- All incompatible changes to the user interface (options, properties, commands)
-  must be documented with a small note in interface-changes.rst. (Additions may
-  be documented there as well, but this isn't required.)
- Changes to the libmpv API must be reflected in the libmpv's headers doxygen,
-  and in client-api-changes.rst.
+- If you add a new command line option, document it in options.rst. If you
+  add a new input property, document it in input.rst. Changes to the user
+  interface (options, properties, commands) should be documented in
+  interface-changes.rst. Changes to libmpv should be documented in
+  client-api-changes.rst.

 Code formatting
 ---------------
@@ -145,7 +68,7 @@ mpv uses C99 with K&R formatting, with some exceptions.
 - Use the K&R indent style.
 - Use 4 spaces of indentation, never use tabs (except in Makefiles).
 - Add a single space between keywords and binary operators. There are some other
-  cases where spaces must be added. Example:
+  cases where spaces should be added. Example:

    ```C
    if ((a * b) > c) {
@@ -178,16 +101,18 @@ mpv uses C99 with K&R formatting, with some exceptions.
            do_something();
    }
    ```
- If the if has an else branch, both branches must use braces, even if they're
-  technically redundant.
+- If the body of an if statement uses braces, the else branch should also
+  use braces (and reverse).

  Example:

    ```C
    if (a) {
-        one_line();
+        // do something
+        something();
+        something_else();
    } else {
-        one_other_line();
+        one_line();
    }
    ```
 - If an if condition spans multiple physical lines, then put the opening brace
@@ -205,76 +130,28 @@ mpv uses C99 with K&R formatting, with some exceptions.
        ...
    }
    ```
-
-  (If the if body is simple enough, this rule can be skipped.)
 - Remove any trailing whitespace.
- Do not make stray whitespaces changes.
-
-Header #include statement order
-------------------------------
-
-The order of ``#include`` statements in the source code is not very consistent.
-New code must follow the following conventions:
-
- Put standard includes (``#include <stdlib.h>`` etc.) on the top,
- then after a blank line, add library includes (``#include <zlib.h>`` etc.)
- then after a blank line, add internal includes (``#include "player/core.h"``)
- sort them alphabetically within these sections
+- If the file you're editing uses formatting different from from what is
+  described here, it's probably an old file from times when nobody followed a
+  consistent style. You're free to use the existing style, or the new style, or
+  to send a patch to reformat the file to the new style before making functional
+  changes.

 General coding
 --------------

 - Use C99. Also freely make use of C99 features if it's appropriate, such as
-  stdbool.h. (Except VLA and complex number types.)
- Don't use non-standard language (such as GNU C-only features). In some cases
-  they may be warranted, if they are optional (such as attributes enabling
-  printf-like format string checks). "#pragma once" is allowed as an exception.
-  But in general, standard C99 must be used.
+  stdbool.h.
+- Don't use GNU-only features. In some cases they may be warranted, if they
+  are optional (such as attributes enabling printf-like format string checks).
+  But in general, standard C99 should be used.
 - The same applies to libc functions. We have to be Windows-compatible too. Use
  functions guaranteed by C99 or POSIX only, unless your use is guarded by a
-  configure check. There is some restricted use of C11 (ask on IRC for details).
+  configure check.
 - Prefer fusing declaration and initialization, rather than putting declarations
  on the top of a block. Obvious data flow is more important than avoiding
  mixing declarations and statements, which is just a C90 artifact.
+- tech-overview.txt might help to get an overview how mpv is structured.
 - If you add features that require intrusive changes, discuss them on the dev
  channel first. There might be a better way to add a feature and it can avoid
  wasted work.
-
-Code of Conduct
---------------
-
-Please note that this project is released with a Contributor Code of Conduct.
-By participating in this project you agree to abide by its terms.
-The Contributor Code of Conduct can be found here:
-https://www.contributor-covenant.org/version/2/0/code_of_conduct/
-
-Rules for git push access
-------------------------
-
-Push access to the main git repository is handed out on an arbitrary basis. If
-you got access, the following rules must be followed:
-
- You are expected to follow the general development rules as outlined in this
-  whole document.
- You must be present on the IRC dev channel when you push something.
- Anyone can push small fixes: typo corrections, small/obvious/uncontroversial
-  bug fixes, edits to the user documentation or code comments, and so on.
- You can freely make changes to parts of the code which you maintain. For
-  larger changes, it's recommended to let others review the changes first.
- You automatically maintain code if you wrote or modified most of it before
-  (e.g. you made larger changes to it before, did partial or full rewrites, did
-  major bug fixes, or you're the original author of the code). If there is more
-  than one maintainer, you may need to come to an agreement with the others how
-  to handle this to avoid conflict.
- If you make a pull requests (especially if it's to code you maintain), and you
-  want reviews, explicitly ping the people from which you expect reviews.
- As a maintainer, you can approve pull requests by others to "your" code.
- If you approve or merge 3rd party changes, make sure they follow the general
-  development rules.
- Changes to user interface and public API must always be approved by the
-  project leader.
- Seasoned project members are allowed to revert commits that broke the build,
-  or broke basic functionality in a catastrophic way, and the developer who
-  broke it is unavailable. (Depending on severity.)
- Adhere to the CoC.
- The project leader is not bound by these rules.
@@ -51,8 +51,7 @@ The rest of the lines belong to one of these classes:
 1) An empty or commented line. A comment starts with ``#``, which must be the
   first character in the line. The rest of the line (up until the next line
   break) is ignored. An empty line has 0 bytes between two line feed bytes.
-2) A header entry if the line starts with ``!``.
-3) A segment entry in all other cases.
+2) A segment entry in all other cases.

 Each segment entry consists of a list of named or unnamed parameters.
 Parameters are separated with ``,``. Named parameters consist of a name,
@@ -64,8 +63,8 @@ Syntax::
    segment_entry ::= <param> ( <param> ',' )*
    param         ::= [ <name> '=' ] ( <value> | '%' <number> '%' <valuebytes> )

-The ``name`` string can consist of any characters, except ``=%,;\n!``. The
-``value`` string can consist of any characters except of ``,;\n!``.
+The ``name`` string can consist of any characters, except ``=%,;\n``. The
+``value`` string can consist of any characters except of ``,;\n``.

 The construct starting with ``%`` allows defining any value with arbitrary
 contents inline, where ``number`` is an integer giving the number of bytes in
@@ -95,232 +94,6 @@ to ``20``, ``param3`` to ``value,escaped``, ``param4`` to ``value2``.
 Instead of line breaks, the character ``;`` can be used. Line feed bytes and
 ``;`` are treated equally.

-Header entries start with ``!`` as first character after a line break. Header
-entries affect all other file entries in the EDL file. Their format is highly
-implementation specific. They should generally follow the file header, and come
-before any file entries.
-
-Disabling chapter generation and copying
-========================================
-
-By default, chapters from the source ranges are copied to the virtual file's
-chapters. Also, a chapter is inserted after each range. This can be disabled
-with the ``no_chapters`` header.
-
-Example::
-
-    !no_chapters
-
-
-MP4 DASH
-========
-
-This is a header that helps implementing DASH, although it only provides a low
-level mechanism.
-
-If this header is set, the given url designates an mp4 init fragment. It's
-downloaded, and every URL in the EDL is prefixed with the init fragment on the
-byte stream level. This is mostly for use by mpv's internal ytdl support. The
-ytdl script will call youtube-dl, which in turn actually processes DASH
-manifests. It may work only for this very specific purpose and fail to be
-useful in other scenarios. It can be removed or changed in incompatible ways
-at any times.
-
-Example::
-
-    !mp4_dash,init=url
-
-The ``url`` is encoded as parameter value as defined in the general EDL syntax.
-It's expected to point to an "initialization fragment", which will be prefixed
-to every entry in the EDL on the byte stream level.
-
-The current implementation will
-
- ignore stream start times
- use durations as hint for seeking only
- not adjust source timestamps
- open and close segments (i.e. fragments) as needed
- not add segment boundaries as chapter points
- require full compatibility between all segments (same codec etc.)
-
-Another header part of this mechanism is ``no_clip``. This header is similar
-to ``mp4_dash``, but does not include on-demand opening/closing of segments,
-and does not support init segments. It also exists solely to support internal
-ytdl requirements. Using ``no_clip`` with segments is not recommended and
-probably breaks. ``mp4_dash`` already implicitly does a variant of ``no_clip``.
-
-The ``mp4_dash`` and ``no_clip`` headers are not part of the core EDL format.
-They may be changed or removed at any time, depending on mpv's internal
-requirements.
-
-Separate files for tracks
-=========================
-
-The special ``new_stream`` header lets you specify separate parts and time
-offsets for separate tracks. This can for example be used to source audio and
-video track from separate files.
-
-Example::
-
-    # mpv EDL v0
-    video.mkv
-    !new_stream
-    audio.mkv
-
-This adds all tracks from both files to the virtual track list. Upon playback,
-the tracks will be played at the same time, instead of appending them. The files
-can contain more than 1 stream; the apparent effect is the same as if the second
-part after the ``!new_stream`` part were in a separate ``.edl`` file and added
-with ``--external-file``.
-
-Note that all metadata between the stream sets created by ``new_stream`` is
-disjoint. Global metadata is taken from the first part only.
-
-In context of mpv, this is redundant to the ``--audio-file`` and
-``--external-file`` options, but (as of this writing) has the advantage that
-this will use a unified cache for all streams.
-
-The ``new_stream`` header is not part of the core EDL format. It may be changed
-or removed at any time, depending on mpv's internal requirements.
-
-If the first ``!new_stream`` is redundant, it is ignored. This is the same
-example as above::
-
-    # mpv EDL v0
-    !new_stream
-    video.mkv
-    !new_stream
-    audio.mkv
-
-Note that ``!new_stream`` must be the first header. Whether the parser accepts
-(i.e. ignores) or rejects other headers before that is implementation specific.
-
-Track metadata
-==============
-
-The special ``track_meta`` header can set some specific metadata fields of the
-current ``!new_stream`` partition. The tags are applied to all tracks within
-the partition. It is not possible to set the metadata for individual tracks (the
-feature was needed only for single-track media).
-
-It provides following parameters change track metadata:
-
-``lang``
-    Set the language tag.
-
-``title``
-    Set the title tag.
-
-``byterate``
-    Number of bytes per second this stream uses. (Purely informational.)
-
-``index``
-    The numeric index of the track this should map to (default: -1). This is
-    the 0-based index of the virtual stream as seen by the player, enumerating
-    all audio/video/subtitle streams. If nothing matches, this is silently
-    discarded. The special index -1 (the default) has two meanings: if there
-    was a previous meta data entry (either ``!track_meta`` or ``!delay_open``
-    element since the last ``!new_stream``), then this element manipulates
-    the previous meta data entry. If there was no previous entry, a new meta
-    data entry that matches all streams is created.
-
-Example::
-
-    # mpv EDL v0
-    !track_meta,lang=bla,title=blabla
-    file.mkv
-    !new_stream
-    !track_meta,title=ducks
-    sub.srt
-
-If ``file.mkv`` has an audio and a video stream, both will use ``blabla`` as
-title. The subtitle stream will use ``ducks`` as title.
-
-The ``track_meta`` header is not part of the core EDL format. It may be changed
-or removed at any time, depending on mpv's internal requirements.
-
-Global metadata
-===============
-
-The special ``global_tags`` header can set metadata fields (aka tags) of the EDL
-file. This metadata is supposed to be informational, much like for example ID3
-tags in audio files. Due to lack of separation of different kinds of metadata it
-is unspecified what names are allowed, how they are interpreted, and whether
-some of them affect playback functionally. (Much of this is unfortunately
-inherited from FFmpeg. Another consequence of this is that FFmpeg "normalized"
-tags are recognized, or stuff like replaygain tags.)
-
-Example::
-
-    !global_tags,title=bla,something_arbitrary=even_more_arbitrary
-
-Any parameter names are allowed. Repeated use of this adds to the tag list. If
-``!new_stream`` is used, the location doesn't matter.
-
-May possibly be ignored in some cases, such as delayed media opening.
-
-Delayed media opening
-=====================
-
-The special ``delay_open`` header can be used to open the media URL of the
-stream only when the track is selected for the first time. This is supposed to
-be an optimization to speed up opening of a remote stream if there are many
-tracks for whatever reasons.
-
-This has various tricky restrictions, and also will defer failure to open a
-stream to "later". By design, it's supposed to be used for single-track streams.
-
-Using multiple segments requires you to specify all offsets and durations (also
-it was never tested whether it works at all). Interaction with ``mp4_dash`` may
-be strange.
-
-You can describe multiple sub-tracks by using multiple ``delay_open`` headers
-before the same source URL. (If there are multiple sub-tracks of the same media
-type, then the mapping to the real stream is probably rather arbitrary.) If the
-source contains tracks not described, a warning is logged when the delayed
-opening happens, and the track is hidden.
-
-This has the following parameters:
-
-``media_type``
-    Required. Must be set to ``video``, ``audio``, or ``sub``. (Other tracks in
-    the opened URL are ignored.)
-
-``codec``
-    The mpv codec name that is expected. Although mpv tries to initialize a
-    decoder with it currently (and will fail track selection if it does not
-    initialize successfully), it is not used for decoding - decoding still uses
-    the information retrieved from opening the actual media information, and may
-    be a different codec (you should try to avoid this, of course). Defaults to
-    ``null``.
-
-    Above also applies for similar fields such as ``w``.  These fields are
-    mostly to help with user track pre-selection.
-
-``flags``
-    A ``+`` separated list of boolean flags. Currently defined flags:
-
-        ``default``
-            Set the default track flag.
-
-        ``forced``
-            Set the forced track flag.
-
-    Other values are ignored after triggering a warning.
-
-``w``, ``h``
-    For video codecs: expected video size. See ``codec`` for details.
-
-``fps``
-    For video codecs: expected video framerate, as integer. (The rate is usually
-    only crudely reported, and it makes no sense to expect exact values.)
-
-``samplerate``
-    For audio codecs: expected sample rate, as integer.
-
-The ``delay_open`` header is not part of the core EDL format. It may be changed
-or removed at any time, depending on mpv's internal requirements.
-
 Timestamp format
 ================

@@ -328,8 +101,7 @@ Currently, time values are floating point values in seconds.

 As an extension, you can set the ``timestamps=chapters`` option. If this option
 is set, timestamps have to be integers, and refer to chapter numbers, starting
-with 0. The default value for this parameter is ``seconds``, which means the
-time is as described in the previous paragraph.
+with 0.

 Example::

@@ -338,54 +110,6 @@ Example::

 Plays chapter 3 and ends with the start of chapter 7 (4 chapters later).

-Implicit chapters
-=================
-
-mpv will add one chapter per segment entry to the virtual timeline.
-
-By default, the chapter's titles will match the entries' filenames.
-You can override set the ``title`` option to override the chapter title for
-that segment.
-
-Example::
-
-    # mpv EDL v0
-    cap.ts,5,240
-    OP.mkv,0,90,title=Show Opening
-
-The virtual timeline will have two chapters, one called "cap.ts" from 0-240s
-and a second one called "Show Opening" from 240-330s.
-
-Entry which defines the track layout
-====================================
-
-Normally, you're supposed to put only files with compatible layouts into an EDL
-file. However, at least the mpv implementation accepts entries that use
-different codecs, or even have a different number of audio/video/subtitle
-tracks. In this case, it's not obvious, which virtual tracks the EDL show should
-expose when being played.
-
-Currently, mpv will apply an arbitrary heuristic which tracks the EDL file
-should expose. (Before mpv 0.30.0, it always used the first source file in the
-segment list.)
-
-You can set the ``layout`` option to ``this`` to make a specific entry define
-the track layout.
-
-Example::
-
-    # mpv EDL v0
-    file_with_2_streams.ts,5,240
-    file_with_5_streams.mkv,0,90,layout=this
-
-The way the different virtual EDL tracks are associated with the per-segment
-ones is highly implementation-defined, and uses a heuristic. If a segment is
-missing a track, there will be a "hole", and bad behavior may result. Improving
-this is subject to further development (due to being fringe cases, they don't
-have a high priority).
-
-If future versions of mpv change this again, this option may be ignored.
-
 Syntax of EDL URIs
 ==================

@@ -3,26 +3,27 @@ General usage

 ::

-  mpv infile --o=outfile [--of=outfileformat] [--ofopts=formatoptions] [--orawts] \
+  mpv infile -o outfile [-of outfileformat] [-ofopts formatoptions] \
+    [-ofps outfps | -oautofps] [-oharddup] [-ocopyts | -orawts] [-oneverdrop] \
    [(any other mpv options)] \
-    --ovc=outvideocodec [--ovcopts=outvideocodecoptions] \
-    --oac=outaudiocodec [--oacopts=outaudiocodecoptions]
+    -ovc outvideocodec [-ovcopts outvideocodecoptions] \
+    -oac outaudiocodec [-oacopts outaudiocodecoptions]

 Help for these options is provided if giving help as parameter, as in::

-  mpv --ovc=help
+  mpv -ovc help

 The suboptions of these generally are identical to ffmpeg's (as option parsing
-is simply delegated to ffmpeg). The option --ocopyts enables copying timestamps
+is simply delegated to ffmpeg). The option -ocopyts enables copying timestamps
 from the source as-is, instead of fixing them to match audio playback time
-(note: this doesn't work with all output container formats); --orawts even turns
+(note: this doesn't work with all output container formats); -orawts even turns
 off discontinuity fixing.

-Note that if neither --ofps nor --oautofps is specified, VFR encoding is assumed
-and the time base is 24000fps. --oautofps sets --ofps to a guessed fps number
+Note that if neither -ofps nor -oautofps is specified, VFR encoding is assumed
+and the time base is 24000fps. -oautofps sets -ofps to a guessed fps number
 from the input video. Note that not all codecs and not all formats support VFR
 encoding, and some which do have bugs when a target bitrate is specified - use
--ofps or --oautofps to force CFR encoding in these cases.
+-ofps or -oautofps to force CFR encoding in these cases.

 Of course, the options can be stored in a profile, like this .config/mpv/mpv.conf
 section::
@@ -30,13 +31,9 @@ section::
  [myencprofile]
  vf-add = scale=480:-2
  ovc = libx264
-  ovcopts-add = preset=medium
-  ovcopts-add = tune=fastdecode
+  ovcopts-add = preset=medium,tune=fastdecode
  ovcopts-add = crf=23
-  ovcopts-add = maxrate=1500k
-  ovcopts-add = bufsize=1000k
-  ovcopts-add = rc_init_occupancy=900k
-  ovcopts-add = refs=2
+  ovcopts-add = maxrate=1500k,bufsize=1000k,rc_init_occupancy=900k,refs=2
  ovcopts-add = profile=baseline
  oac = aac
  oacopts-add = b=96k
@@ -48,7 +45,7 @@ to encoding. This is not the case anymore.)

 One can then encode using this profile using the command::

-  mpv infile --o=outfile.mp4 --profile=myencprofile
+  mpv infile -o outfile.mp4 -profile myencprofile

 Some example profiles are provided in a file
 etc/encoding-profiles.conf; as for this, see below.
@@ -62,33 +59,33 @@ for.

 Typical MPEG-4 Part 2 ("ASP", "DivX") encoding, AVI container::

-  mpv infile --o=outfile.avi \
-    --vf=fps=25 \
-    --ovc=mpeg4 --ovcopts=qscale=4 \
-    --oac=libmp3lame --oacopts=b=128k
+  mpv infile -o outfile.avi \
+    -ofps 25 \
+    -ovc mpeg4 -ovcopts qscale=4 \
+    -oac libmp3lame -oacopts ab=128k

-Note: AVI does not support variable frame rate, so the fps filter must be used.
-The frame rate should ideally match the input (25 for PAL, 24000/1001 or
-30000/1001 for NTSC)
+Note: AVI does not support variable frame rate, so -ofps must be used. The
+frame rate should ideally match the input (25 for PAL, 24000/1001 or 30000/1001
+for NTSC)

 Typical MPEG-4 Part 10 ("AVC", "H.264") encoding, Matroska (MKV) container::

-  mpv infile --o=outfile.mkv \
-    --ovc=libx264 --ovcopts=preset=medium,crf=23,profile=baseline \
-    --oac=libopus --oacopts=qscale=3
+  mpv infile -o outfile.mkv \
+    -ovc libx264 -ovcopts preset=medium,crf=23,profile=baseline \
+    -oac libvorbis -oacopts qscale=3

 Typical MPEG-4 Part 10 ("AVC", "H.264") encoding, MPEG-4 (MP4) container::

-  mpv infile --o=outfile.mp4 \
-    --ovc=libx264 --ovcopts=preset=medium,crf=23,profile=baseline \
-    --oac=aac --oacopts=b=128k
+  mpv infile -o outfile.mp4 \
+    -ovc libx264 -ovcopts preset=medium,crf=23,profile=baseline \
+    -oac aac -oacopts ab=128k

 Typical VP8 encoding, WebM (restricted Matroska) container::

  mpv infile -o outfile.mkv \
-    --of=webm \
-    --ovc=libvpx --ovcopts=qmin=6,b=1000000k \
-    --oac=libopus --oacopts=qscale=3
+    -of webm \
+    -ovc libvpx -ovcopts qmin=6,b=1000000k \
+    -oac libvorbis -oacopts qscale=3


 Device targets
@@ -98,31 +95,27 @@ As the options for various devices can get complex, profiles can be used.

 An example profile file for encoding is provided in
 etc/encoding-profiles.conf in the source tree. This file is installed and loaded
-by default. If you want to modify it, you can replace and it with your own copy
-by doing::
+by default (if libavfilter is enabled at compilation). If you want to modify
+it, you can replace and it with your own copy by doing::

  mkdir -p ~/.mpv
  cp /etc/mpv/encoding-profiles.conf ~/.mpv/encoding-profiles.conf

-Keep in mind that the default profile is the playback one. If you want to add
-options that apply only in encoding mode, put them into a ``[encoding]``
-section.
-
 Refer to the top of that file for more comments - in a nutshell, the following
 options are added by it::

-  --profile=enc-to-dvdpal      # DVD-Video PAL, use dvdauthor -v pal+4:3 -a ac3+en
-  --profile=enc-to-dvdntsc     # DVD-Video NTSC, use dvdauthor -v ntsc+4:3 -a ac3+en
-  --profile=enc-to-bb-9000     # MP4 for Blackberry Bold 9000
-  --profile=enc-to-nok-6300    # 3GP for Nokia 6300
-  --profile=enc-to-psp         # MP4 for PlayStation Portable
-  --profile=enc-to-iphone      # MP4 for iPhone
-  --profile=enc-to-iphone-4    # MP4 for iPhone 4 (double res)
-  --profile=enc-to-iphone-5    # MP4 for iPhone 5 (even larger res)
+  -profile enc-to-dvdpal      DVD-Video PAL, use dvdauthor -v pal+4:3 -a ac3+en
+  -profile enc-to-dvdntsc     DVD-Video NTSC, use dvdauthor -v ntsc+4:3 -a ac3+en
+  -profile enc-to-bb-9000     MP4 for Blackberry Bold 9000
+  -profile enc-to-nok-6300    3GP for Nokia 6300
+  -profile enc-to-psp         MP4 for PlayStation Portable
+  -profile enc-to-iphone      MP4 for iPhone
+  -profile enc-to-iphone-4    MP4 for iPhone 4 (double res)
+  -profile enc-to-iphone-5    MP4 for iPhone 5 (even larger res)

 You can encode using these with a command line like::

-  mpv infile --o=outfile.mp4 --profile=enc-to-bb-9000
+  mpv infile -o outfile.mp4 -profile enc-to-bb-9000

 Of course, you are free to override options set by these profiles by specifying
 them after the -profile option.
@@ -132,20 +125,20 @@ What works
 ==========

 * Encoding at variable frame rate (default)
-* Encoding at constant frame rate using --vf=fps=RATE
-* 2-pass encoding (specify flags=+pass1 in the first pass's --ovcopts, specify
+* Encoding at constant frame rate using -ofps framerate -oharddup
+* 2-pass encoding (specify flags=+pass1 in the first pass's -ovcopts, specify
  flags=+pass2 in the second pass)
 * Hardcoding subtitles using vobsub, ass or srt subtitle rendering (just
  configure mpv for the subtitles as usual)
-* Hardcoding any other mpv OSD (e.g. time codes, using --osdlevel=3 and
-  --vf=expand=::::1)
+* Hardcoding any other mpv OSD (e.g. time codes, using -osdlevel 3 and -vf
+  expand=::::1)
 * Encoding directly from a DVD, network stream, webcam, or any other source
  mpv supports
 * Using x264 presets/tunings/profiles (by using profile=, tune=, preset= in the
-  --ovcopts)
+  -ovcopts)
 * Deinterlacing/Inverse Telecine with any of mpv's filters for that
-* Audio file converting: mpv --o=outfile.m4a infile.flac --no-video
-  --oac=aac --oacopts=b=320k
+* Audio file converting: mpv -o outfile.mp3 infile.flac -no-video -oac
+  libmp3lame -oacopts ab=320k

 What does not work yet
 ======================
@@ -7,711 +7,18 @@ mpv provides access to its internals via the following means:
 - commands
 - properties
 - events
- hooks
-
-The sum of these mechanisms is sometimes called command interface.

 All of these are important for interfacing both with end users and API users
 (which include Lua scripts, libmpv, and the JSON IPC). As such, they constitute
 a large part of the user interface and APIs.

-Also see compatibility.rst.
-
-This document lists changes to them. New changes are added to the top. Usually,
-only incompatible or important changes are mentioned. New options/commands/etc.
-are not always listed.
+This document lists changes to them. New changes are added to the top.

 Interface changes
 =================

 ::

- --- mpv 0.35.0 ---
-    - add the `--vo=gpu-next` video output driver, as well as the options
-      `--allow-delayed-peak-detect`, `--builtin-scalers`,
-      `--interpolation-preserve` `--lut`, `--lut-type`, `--image-lut`,
-      `--image-lut-type` and `--target-lut` along with it.
-    - add `--target-colorspace-hint`
-    - add `--tone-mapping-crosstalk`
-    - add `--tone-mapping` options `auto`, `spline` and `bt.2446a`
-    - add `--inverse-tone-mapping`
-    - add `--gamut-mapping-mode`, replacing `--gamut-clipping` and `--gamut-warning`
-    - add `--tone-mapping-mode`, replacing `--tone-mapping-desaturate` and
-      `--tone-mapping-desaturate-exponent`.
-    - add `dolbyvision` sub-parameter to `format` video filter
-    - `--sub-visibility` no longer has any effect on secondary subtitles
-    - add `film-grain` sub-parameter to `format` video filter
-    - add experimental `--vo=dmabuf-wayland` video output driver
-    - add `--x11-present` for controlling whether to use xorg's present extension
-    - add `engine` option to the `rubberband` audio filter to support the new
-      engine introduced in rubberband 3.0.0. Defaults to `finer` (new engine).
-    - add `--wayland-configure-bounds` option
-    - deprecate `--gamma-factor`
-    - deprecate `--gamma-auto`
-    - remove `--vulkan-disable-events`
-    - add `--glsl-shader-opts`
- --- mpv 0.34.0 ---
-    - deprecate selecting by card number with `--drm-connector`, add
-      `--drm-device` which can be used instead
-    - add `--screen-name` and `--fs-screen-name` flags to allow selecting the
-      screen by its name instead of the index
-    - add `--macos-geometry-calculation` to change the rectangle used for screen
-      position and size calculation. the old behavior used the whole screen,
-      which didn't take the menu bar and Dock into account. The new default
-      behaviour includes both. To revert to the old behavior set this to
-      `whole`.
-    - add an additional optional `albumart` argument to the `video-add` command,
-      which tells mpv to load the given video as album art.
-    - undeprecate `--cache-secs` option
-    - remove `--icc-contrast` and introduce `--icc-force-contrast`. The latter
-      defaults to the equivalent of the old `--icc-contrast=inf`, and can
-      instead be used to specifically set the contrast to any value.
-    - add a `--watch-later-options` option to allow configuring which
-      options quit-watch-later saves
-    - make `current-window-scale` writeable and use it in the default input.conf
-    - add `--input-builtin-bindings` flag to control loading of built-in key
-      bindings during start-up (default: yes).
-    - add ``track-list/N/image`` sub-property
-    - remove `--opengl-restrict` option
-    - js custom-init: use filename ~~/init.js instead of ~~/.init.js (dot)
- --- mpv 0.33.0 ---
-    - add `--d3d11-exclusive-fs` flag to enable D3D11 exclusive fullscreen mode
-      when the player enters fullscreen.
-    - directories in ~/.mpv/scripts/ (or equivalent) now have special semantics
-      (see mpv Lua scripting docs)
-    - names starting with "." in ~/.mpv/scripts/ (or equivalent) are now ignored
-    - js modules: ~~/scripts/modules.js/ is no longer used, global paths can be
-      set with custom init (see docs), dir-scripts first look at <dir>/modules/
-    - the OSX bundle now logs to "~/Library/Logs/mpv.log" by default
-    - deprecate the --cache-secs option (once removed, the cache cannot be
-      limited by time anymore)
-    - remove deprecated legacy hook API ("hook-add", "hook-ack"). Use either the
-      libmpv API (mpv_hook_add(), mpv_hook_continue()), or the Lua scripting
-      wrappers (mp.add_hook()).
-    - improve how property change notifications are delivered on events and on
-      hooks. In particular, a hook event is only returned to a client after all
-      changes initiated before the hook point were delivered to the same client.
-      In addition, it should no longer happen that events and property change
-      notifications were interleaved in bad ways (it could happen that a
-      property notification delivered after an event contained a value that was
-      valid only before the event happened).
-    - the playlist-pos and playlist-pos-1 properties now can return and accept
-      -1, and are never unavailable. Out of range indexes are now accepted, but
-      behave like writing -1.
-    - the playlist-pos and playlist-pos-1 properties deprecate the current
-      behavior when writing back the current value to the property: currently,
-      this restarts playback, but in the future, it will do nothing.
-      Using the "playlist-play-index" command is recommended instead.
-    - add "playlist-play-index" command
-    - add playlist-current-pos, playlist-playing-pos properties
-    - Lua end-file events set the "error" field; this is deprecated; use the
-      "file_error" instead for this specific event. Scripts relying on the
-      "error" field for end-file will silently break at some point in the
-      future.
-    - remove deprecated --input-file option, add --input-ipc-client, which is
-      vaguely a replacement of the removed option, but not the same
-    - change another detail for track selection options (see --aid manpage
-      entry)
-    - reading loop-file property as native property or mpv_node will now return
-      "inf" instead of boolean true (also affects loop option)
-    - remove some --vo-direct3d-... options (it got dumbed down; use --vo=gpu)
-    - remove video-params/plane-depth property (was too vaguely defined)
-    - remove --video-sync-adrop-size option (implementation was changed, no
-      replacement for what this option did)
-    - undeprecate --video-sync=display-adrop
-    - deprecate legacy auto profiles (profiles starting with "extension." and
-      "protocol."). Use conditional auto profiles instead.
-    - the "subprocess" command does not connect spawned processes' stdin to
-      mpv's stdin anymore. Instead, stdin is connected to /dev/null by default.
-      To get the old behavior, set the "passthrough_stdin" argument to true.
-    - key/value list options do not accept ":" as item separator anymore,
-      only ",". This means ":" is always considered part of the value.
-    - remove deprecated --vo-vdpau-deint option
-    - add `delete-watch-later-config` command to complement
-      `write-watch-later-config`
- --- mpv 0.32.0 ---
-    - change behavior when using legacy option syntax with options that start
-      with two dashes (``--`` instead of a ``-``). Now, using the recommended
-      syntax is required for options starting with ``--``, which means an option
-      value must be strictly passed after a ``=``, instead of as separate
-      argument. For example, ``--log-file f.txt`` was previously accepted and
-      behaved like ``--log-file=f.txt``, but now causes an error. Use of legacy
-      syntax that is still supported now prints a deprecation warning.
- --- mpv 0.31.0 ---
-    - add `--resume-playback-check-mtime` to check consistent mtime when
-      restoring playback state.
-    - add `--d3d11-output-csp` to enable explicit selection of a D3D11
-      swap chain color space.
-    - the --sws- options and similar now affect vo_image and screenshot
-      conversion (does not matter as much for vo_gpu, which does most of this
-      with shaders)
-    - add a builtin "sw-fast" profile, which restores performance settings
-      for software video conversion. These were switched to higher quality since
-      mpv 0.30.0 (related to the previous changelog entry). This affects video
-      outputs like vo_x11 and vo_drm, and screenshots, but not much else.
-    - deprecate --input-file (there are no plans to remove this short-term,
-      but it will probably eventually go away <- that was a lie)
-    - deprecate --video-sync=display-adrop (might be removed if it's in the way;
-      undeprecated or readded if it's not too much of a problem)
-    - deprecate all input section commands (these will be changed/removed, as
-      soon as mpv internals do not require them anymore)
-    - remove deprecated --playlist-pos alias (use --playlist-start)
-    - deprecate --display-fps, introduce --override-display-fps. The display-fps
-      property now is unavailable if no VO exists (or the VO did not return a
-      display FPS), instead of returning the option value in this case. The
-      property will keep existing, but writing to it is deprecated.
-    - the vf/af properties now do not reject the set value anymore, even if
-      filter chain initialization fails. Instead, the vf/af options are always
-      set to the user's value, even if it does not reflect the "runtime" vf/af
-      chain.
-    - the vid/aid/sid/secondary-sid properties (and their aliases: "audio",
-      "video", "sub") will now allow setting any track ID; before this change,
-      only IDs of actually existing tracks could be set (the restriction was
-      active the MPV_EVENT_FILE_LOADED/"file-loaded" event was sent). Setting
-      an ID for which no track exists is equivalent to disabling it. Note that
-      setting the properties to non-existing tracks may report it as selected
-      track for a small time window, until it's forced back to "no". The exact
-      details how this is handled may change in the future.
-    - remove old Apple Remote support, including --input-appleremote
-    - add MediaPlayer support and remove the old Media Key event tap on macOS.
-      this possibly also re-adds the Apple Remote support
-    - the "edition" property now strictly returns the value of the option,
-      instead of the runtime value. The new "current-edition" property needs to
-      be queried to read the runtime-chosen edition. This is a breaking change
-      for any users which expected "edition" to return the runtime-chosen
-      edition at default settings (--edition=auto).
-    - the "window-scale" property now strictly returns the value of the option,
-      instead of the actual size of the window. The new "current-window-scale"
-      property needs to be queried to read the value as indicated by the current
-      window size. This is a breaking change.
-    - explicitly deprecate passing more than 1 item to "-add" suffix in key/value
-      options (for example --script-opts-add). This was actually always
-      deprecated, like with other list options, but the option parser did not
-      print a warning in this particular case.
-    - deprecate -del for list options (use -remove instead, which is by content
-      instead of by integer index)
-    - if `--fs` is used but `--fs-screen` is not set, mpv will now use `--screen`
-      instead.
-    - change the default of --hwdec to "no" on RPI. The default used to be "mmal"
-      specifically if 'Raspberry Pi support' was enabled at configure time
-      (equivalent to --enable-rpi). Use --hwdec=mmal to get the old behavior.
- --- mpv 0.30.0 ---
-    - add `--d3d11-output-format` to enable explicit selection of a D3D11
-      swap chain format.
-    - rewrite DVB channel switching to use an integer value
-      `--dvbin-channel-switch-offset` for switching instead of the old
-      stream controls which are now gone. Cycling this property up or down will
-      change the offset to the channel which was initially tuned to.
-      Example for `input.conf`: `H cycle dvbin-channel-switch-offset up`,
-      `K cycle dvbin-channel-switch-offset down`.
-    - adapt `stream_dvb` to support writing to `dvbin-prog` at runtime
-      and also to consistently use dvbin-configuration over URI parameters
-      when provided
-    - add `--d3d11-adapter` to enable explicit selection of a D3D11 rendering
-      adapter by name.
-    - rename `--drm-osd-plane-id` to `--drm-draw-plane`, `--drm-video-plane-id` to
-      `--drm-drmprime-video-plane` and `--drm-osd-size` to `--drm-draw-surface-size`
-      to better reflect what the options actually control, that the values they
-      accept aren't actually internal DRM ID's (like with similar options in
-      ffmpeg's KMS support), and that the video plane is only used when the drmprime
-      overlay hwdec interop is active, with the video being drawn to the draw plane
-      otherwise.
-    - in addition to the above, the `--drm-draw-plane` and `--drm-drmprime-video-plane`
-      options now accept either an integer index, or the values primary or overlay.
-      `--drm-draw-plane` now defaults to primary and `--drm-drmprime-video-plane`
-      defaults to overlay. This should be similar to previous behavior on most drivers
-      due to how planes are usually sorted.
-    - rename --opensles-frames-per-buffer to --opensles-frames-per-enqueue to
-      better reflect its purpose. In the past it overrides the buffer size the AO
-      requests (but not the default/value of the generic --audio-buffer option).
-      Now it only guarantees that the soft buffer size will not be smaller than
-      itself while setting the size per Enqueue.
-    - add --opensles-buffer-size-in-ms, allowing user to tune the soft buffer size.
-      It overrides the --audio-buffer option unless it's set to 0 (with the default
-      being 250).
-    - remove `--linear-scaling`, replaced by `--linear-upscaling` and
-      `--linear-downscaling`. This means that `--sigmoid-upscaling` no longer
-      implies linear light downscaling as well, which was confusing.
-    - the built-in `gpu-hq` profile now includes` --linear-downscaling`.
-    - support for `--spirv-compiler=nvidia` has been removed, leaving `shaderc`
-      as the only option. The `--spirv-compiler` option itself has been marked
-      as deprecated, and may be removed in the future.
-    - split up `--tone-mapping-desaturate`` into strength + exponent, instead of
-      only using a single value (which previously just controlled the exponent).
-      The strength now linearly blends between the linear and nonlinear tone
-      mapped versions of a color.
-    - add --hdr-peak-decay-rate and --hdr-scene-threshold-low/high
-    - add --tone-mapping-max-boost
-    - ipc: require that "request_id" fields are integers. Other types are still
-      accepted for compatibility, but this will stop in the future. Also, if no
-      request_id is provided, 0 will be assumed.
-    - mpv_command_node() and mp.command_native() now support named arguments
-      (see manpage). If you want to use them, use a new version of the manpage
-      as reference, which lists the definitive names.
-    - edition and disc title switching will now fully reload playback (may have
-      consequences for scripts, client API, or when using file-local options)
-    - with the removal of the stream cache, the following properties and options were
-      dropped: `cache`, `cache-size`, `cache-free`, `cache-used`, `--cache-default`,
-      `--cache-initial`, `--cache-seek-min`, `--cache-backbuffer`, `--cache-file`,
-      `--cache-file-size`
-    - the --cache option does not take a number value anymore
-    - remove async playback abort hack. This may make it impossible to abort
-      playback if --demuxer-thread=no is forced.
-    - remove `--macos-title-bar-style`, replaced by `--macos-title-bar-material`
-      and `--macos-title-bar-appearance`.
-    - The default for `--vulkan-async-compute` has changed to `yes` from `no`
-      with the move to libplacebo as the back-end for vulkan rendering.
-    - Remove "disc-titles", "disc-title", "disc-title-list", and "angle"
-      properties. dvd:// does not support title ranges anymore.
-    - Remove all "tv-..." options and properties, along with the classic Linux
-      analog TV support.
-    - remove "program" property (no replacement)
-    - always prefer EGL over GLX, which helps with AMD/vaapi, but will break
-      vdpau with --vo=gpu - use --gpu-context=x11 to be able to use vdpau. This
-      does not affect --vo=vdpau or --hwdec=vdpau-copy.
-    - remove deprecated --chapter option
-    - deprecate --record-file
-    - add `--demuxer-cue-codepage`
-    - add ``track-list/N/demux-bitrate``, ``track-list/N/demux-rotation`` and
-      ``track-list/N/demux-par`` property
-    - Deprecate ``--video-aspect`` and add ``--video-aspect-override`` to
-      replace it. (The `video-aspect` option remains unchanged.)
- --- mpv 0.29.0 ---
-    - drop --opensles-sample-rate, as --audio-samplerate should be used if desired
-    - drop deprecated --videotoolbox-format, --ff-aid, --ff-vid, --ff-sid,
-      --ad-spdif-dtshd, --softvol options
-    - fix --external-files: strictly never select any tracks from them, unless
-      explicitly selected (this may or may not be expected)
-    - --ytdl is now always enabled, even for libmpv
-    - add a number of --audio-resample-* options, which should from now on be
-      used instead of --af-defaults=lavrresample:...
-    - deprecate --vf-defaults and --af-defaults. These didn't work with the
-      lavfi bridge, so they have very little use left. The only potential use
-      is with af_lavrresample (going to be deprecated, --audio-resample-... set
-      its defaults), and various hw deinterlacing filters (like vf_vavpp), for
-      which you will have to stop using --deinterlace=yes, and instead use the
-      vf toggle commands and the filter enable/disable flag to customize it.
-    - deprecate --af=lavrresample. Use the ``--audio-resample-...`` options to
-      customize resampling, or the libavfilter ``--af=aresample`` filter.
-    - add --osd-on-seek
-    - remove outfmt sub-parameter from "format" video filter (no replacement)
-    - some behavior changes in the video filter chain, including:
-        - before, using an incompatible filter with hwdec would disable hwdec;
-          now it disables the filter at runtime instead
-        - inserting an incompatible filter with hwdec at runtime would refuse
-          to insert the filter; now it will add it successfully, but disables
-          the filter slightly later
-    - some behavior changes in the audio filter chain, including:
-        - a manually inserted lavrresample filter is not necessarily used for
-          sample format conversion anymore, so it's pretty useless
-        - changing playback speed will not respect --af-defaults anymore
-        - having libavfilter based filters after the scaletempo or rubberband
-          filters is not supported anymore, and may desync if playback speed is
-          changed (libavfilter does not support the metadata for playback speed)
-        - the lavcac3enc filter does not auto detach itself anymore; instead it
-          passes through the data after converting it to the sample rate and
-          channel configuration the ac3 encoder expects; also, if the audio
-          format changes midstream in a way that causes the filter to switch
-          between PCM and AC3 output, the audio output won't be reconfigured,
-          and audio playback will fail due to libswresample being unable to
-          convert between PCM and AC3 (Note: the responsible developer didn't
-          give a shit. Later changes might have improved or worsened this.)
-        - inserting a filter that changes the output sample format will not
-          reconfigure the AO - you need to run an additional "ao-reload"
-          command to force this if you want that
-        - using "strong" gapless audio (--gapless-audio=yes) can fail if the
-          audio formats are not convertible (such as switching between PCM and
-          AC3 passthrough)
-        - if filters do not pass through PTS values correctly, A/V sync can
-          result over time. Some libavfilter filters are known to be affected by
-          this, such as af_loudnorm, which can desync over time, depending on
-          how the audio track was muxed (af_lavfi's fix-pts suboption can help).
-    - remove out-format sub-parameter from "format" audio filter (no replacement)
-    - --lavfi-complex now requires uniquely named filter pads. In addition,
-      unconnected filter pads are not allowed anymore (that means every filter
-      pad must be connected either to another filter, or to a video/audio track
-      or video/audio output). If they are disconnected at runtime, the stream
-      will probably stall.
-    - rename --vo=opengl-cb to --vo=libmpv (goes in hand with the opengl-cb
-      API deprecation, see client-api-changes.rst)
-    - deprecate the OpenGL cocoa backend, option choice --gpu-context=cocoa
-      when used with --gpu-api=opengl (use --vo=libmpv)
-    - make --deinterlace=yes always deinterlace, instead of trying to check
-      certain unreliable video metadata. Also flip the defaults of all builtin
-      HW deinterlace filters to always deinterlace.
-    - change vf_vavpp default to use the best deinterlace algorithm by default
-    - remove a compatibility hack that allowed CLI aliases to be set as property
-      (such as "sub-file"), deprecated in mpv 0.26.0
-    - deprecate the old command based hook API, and introduce a proper C API
-      (the high level Lua API for this does not change)
-    - rename the the lua-settings/ config directory to script-opts/
-    - the way the player waits for scripts getting loaded changes slightly. Now
-      scripts are loaded in parallel, and block the player from continuing
-      playback only in the player initialization phase. It could change again in
-      the future. (This kind of waiting was always a feature to prevent that
-      playback is started while scripts are only half-loaded.)
-    - deprecate --ovoffset, --oaoffset, --ovfirst, --oafirst
-    - remove the following encoding options: --ocopyts (now the default, old
-      timestamp handling is gone), --oneverdrop (now default), --oharddup (you
-      need to use --vf=fps=VALUE), --ofps, --oautofps, --omaxfps
-    - remove --video-stereo-mode. This option was broken out of laziness, and
-      nobody wants to fix it. Automatic 3D down-conversion to 2D is also broken,
-      although you can just insert the stereo3d filter manually. The obscurity
-      of 3D content doesn't justify such an option anyway.
-    - change cycle-values command to use the current value, instead of an
-      internal counter that remembered the current position.
-    - remove deprecated ao/vo auto profiles. Consider using scripts like
-      auto-profiles.lua instead.
-    - --[c]scale-[w]param[1|2] and --tone-mapping-param now accept "default",
-      and if set to that value, reading them as property will also return
-      "default", instead of float nan as in previous versions
- --- mpv 0.28.0 ---
-    - rename --hwdec=mediacodec option to mediacodec-copy, to reflect
-      conventions followed by other hardware video decoding APIs
-    - drop previously deprecated --heartbeat-cmd and --heartbeat--interval
-      options
-    - rename --vo=opengl to --vo=gpu
-    - rename --opengl-backend to --gpu-context
-    - rename --opengl-shaders to --glsl-shaders
-    - rename --opengl-shader-cache-dir to --gpu-shader-cache-dir
-    - rename --opengl-tex-pad-x/y to --gpu-tex-pad-x/y
-    - rename --opengl-fbo-format to --fbo-format
-    - rename --opengl-gamma to --gamma-factor
-    - rename --opengl-debug to --gpu-debug
-    - rename --opengl-sw to --gpu-sw
-    - rename --opengl-vsync-fences to --swapchain-depth, and the interpretation
-      slightly changed. Now defaults to 3.
-    - rename the built-in profile `opengl-hq` to `gpu-hq`
-    - the semantics of --opengl-es=yes are slightly changed -> now requires GLES
-    - remove the (deprecated) alias --gpu-context=drm-egl
-    - remove the (deprecated) --vo=opengl-hq
-    - remove --opengl-es=force2 (use --opengl-es=yes --opengl-restrict=300)
-    - the --msg-level option now affects --log-file
-    - drop "audio-out-detected-device" property - this was unavailable on all
-      audio output drivers for quite a while (coreaudio used to provide it)
-    - deprecate --videotoolbox-format (use --hwdec-image-format, which affects
-      most other hwaccels)
-    - remove deprecated --demuxer-max-packets
-    - remove most of the deprecated audio and video filters
-    - remove the deprecated --balance option/property
-    - rename the --opengl-hwdec-interop option to --gpu-hwdec-interop, and
-      change some of its semantics: extend it take the strings "auto" and
-      "all". "all" loads all backends. "auto" behaves like "all" for
-      vo_opengl_cb, while on vo_gpu it loads nothing, but allows on demand
-      loading by the decoder. The empty string as option value behaves like
-      "auto". Old --hwdec values do not work anymore.
-      This option is hereby declared as unstable and may change any time - its
-      old use is deprecated, and it has very little use outside of debugging
-      now.
-    - change the --hwdec option from a choice to a plain string (affects
-      introspection of the option/property), also affects some properties
-    - rename --hwdec=rpi to --hwdec=mmal, same for the -copy variant (no
-      backwards compatibility)
-    - deprecate the --ff-aid, --ff-vid, --ff-sid options and properties (there is
-      no replacement, but you can manually query the track property and use the
-      "ff-index" field to find the mpv track ID to imitate this behavior)
-    - rename --no-ometadata to --no-ocopy-metadata
- --- mpv 0.27.0 ---
-    - drop previously deprecated --field-dominance option
-    - drop previously deprecated "osd" command
-    - remove client API compatibility handling for "script", "sub-file",
-      "audio-file", "external-file" (these cases used to log a deprecation
-      warning)
-    - drop deprecated --video-aspect-method=hybrid option choice
-    - rename --hdr-tone-mapping to --tone-mapping (and generalize it)
-    - --opengl-fbo-format changes from a choice to a string. Also, its value
-      will be checked only on renderer initialization, rather than when the
-      option is set.
-    - Using opengl-cb now always assumes 8 bit per component depth, and dithers
-      to this size. Before, it tried to figure out the depth of the first
-      framebuffer that was ever passed to the renderer. Having GL framebuffers
-      with a size larger than 8 bit per component is quite rare. If you need
-      it, set the --dither-depth option instead.
-    - --lavfi-complex can now be set during runtime. If you set this in
-      expectation it would be applied only after a reload, you might observe
-      weird behavior.
-    - add --track-auto-selection to help with scripts/applications that
-      make exclusive use of --lavfi-complex.
-    - undeprecate --loop, and map it from --loop-playlist to --loop-file (the
-      deprecation was to make sure no API user gets broken by a sudden behavior
-      change)
-    - remove previously deprecated vf_eq
-    - remove that hardware deinterlace filters (vavpp, d3d11vpp, vdpaupp)
-      changed their deinterlacing-enabled setting depending on what the
-      --deinterlace option or property was set to. Now, a filter always does
-      what its filter options and defaults imply. The --deinterlace option and
-      property strictly add/remove its own filters. For example, if you run
-      "mpv --vf=vavpp --deinterlace=yes", this will insert another, redundant
-      filter, which is probably not what you want. For toggling a deinterlace
-      filter manually, use the "vf toggle" command, and do not set the
-      deinterlace option/property. To customize the filter that will be
-      inserted automatically, use --vf-defaults. Details how this works will
-      probably change in the future.
-    - remove deinterlace=auto (this was not deprecated, but had only a very
-      obscure use that stopped working with the change above. It was also
-      prone to be confused with a feature not implemented by it: auto did _not_
-      mean that deinterlacing was enabled on demand.)
-    - add shortened mnemonic names for mouse button bindings, eg. mbtn_left
-      the old numeric names (mouse_btn0) are deprecated
-    - remove mouse_btn3_dbl and up, since they are only generated for buttons
-      0-2 (these now print an error when sent from the 'mouse' command)
-    - rename the axis bindings to wheel_up/down/etc. axis scrolling and mouse
-      wheel scrolling are now conceptually the same thing
-      the old axis_up/down names remain as deprecated aliases
- --- mpv 0.26.0 ---
-    - remove remaining deprecated audio device options, like --alsa-device
-      Some of them were removed in earlier releases.
-    - introduce --replaygain... options, which replace the same functionality
-      provided by the deprecated --af=volume:replaygain... mechanism.
-    - drop the internal "mp-rawvideo" codec (used by --demuxer=rawvideo)
-    - rename --sub-ass-style-override to --sub-ass-override, and rename the
-      `--sub-ass-override=signfs` setting to `--sub-ass-override=scale`.
-    - change default of --video-aspect-method to "bitstream". The "hybrid"
-      method (old default) is deprecated.
-    - remove property "video-params/nom-peak"
-    - remove option --target-brightness
-    - replace vf_format's `peak` suboption by `sig-peak`, which is relative to
-      the reference white level instead of in cd/m^2
-    - renamed the TRCs `st2084` and `std-b67` to `pq` and `hlg` respectively
-    - the "osd" command is deprecated (use "cycle osd-level")
-    - --field-dominance is deprecated (use --vf=setfield=bff or tff)
-    - --really-quiet subtle behavior change
-    - the deprecated handling of setting "no-" options via client API is dropped
-    - the following options change to append-by-default (and possibly separator):
-        --script
-      also, the following options are deprecated:
-        --sub-paths => --sub-file-paths
-      the following options are deprecated for setting via API:
-        "script" (use "scripts")
-        "sub-file" (use "sub-files")
-        "audio-file" (use "audio-files")
-        "external-file" (use "external-files")
-        (the compatibility hacks for this will be removed after this release)
-    - remove property `vo-performance`, and add `vo-passes` as a more general
-      replacement
-    - deprecate passing multiple arguments to -add/-pre options (affects the
-      vf/af commands too)
-    - remove --demuxer-lavf-cryptokey. Use --demux-lavf-o=cryptokey=<hex> or
-      --demux-lavf-o=decryption_key=<hex> instead (whatever fits your situation).
-    - rename --opengl-dumb-mode=no to --opengl-dumb-mode=auto, and make `no`
-      always disable it (unless forced on by hardware limitation).
-    - generalize --scale-clamp, --cscale-clamp etc. to accept a float between
-      0.0 and 1.0 instead of just being a flag. A value of 1.0 corresponds to
-      the old `yes`, and a value of 0.0 corresponds to the old `no`.
- --- mpv 0.25.0 ---
-    - remove opengl-cb dxva2 dummy hwdec interop
-      (see git "vo_opengl: remove dxva2 dummy hwdec backend")
-    - remove ppm, pgm, pgmyuv, tga choices from the --screenshot-format and
-      --vo-image-format options
-    - the "jpeg" choice in the option above now leads to a ".jpg" file extension
-    - --af=drc is gone (you can use e.g. lavfi/acompressor instead)
-    - remove image_size predefined uniform from OpenGL user shaders. Use
-      input_size instead
-    - add --sub-filter-sdh
-    - add --sub-filter-sdh-harder
-    - remove --input-app-events option (macOS)
-    - deprecate most --vf and --af filters. Only some filters not in libavfilter
-      will be kept.
-      Also, you can use libavfilter filters directly (e.g. you can use
-      --vf=name=opts instead of --vf=lavfi=[name=opts]), as long as the
-      libavfilter filter's name doesn't clash with a mpv builtin filter.
-      In the long term, --vf/--af syntax might change again, but if it does, it
-      will switch to libavfilter's native syntax. (The above mentioned direct
-      support for lavfi filters still has some differences, such as how strings
-      are escaped.) If this happens, the non-deprecated builtin filters might be
-      moved to "somewhere else" syntax-wise.
-    - deprecate --loop - after a deprecation period, it will be undeprecated,
-      but changed to alias --loop-file
-    - add --keep-open-pause=no
-    - deprecate --demuxer-max-packets
-    - change --audio-file-auto default from "exact" to "no" (mpv won't load
-      files with the same filename as the video, but different extension, as
-      audio track anymore)
- --- mpv 0.24.0 ---
-    - deprecate --hwdec-api and replace it with --opengl-hwdec-interop.
-      The new option accepts both --hwdec values, as well as named backends.
-      A minor difference is that --hwdec-api=no (which used to be the default)
-      now actually does not preload any interop layer, while the new default
-      ("") uses the value of --hwdec.
-    - drop deprecated --ad/--vd features
-    - drop deprecated --sub-codepage syntax
-    - rename properties:
-        - "drop-frame-count" to "decoder-frame-drop-count"
-        - "vo-drop-frame-count" to "frame-drop-count"
-      The old names still work, but are deprecated.
-    - remove the --stream-capture option and property. No replacement.
-      (--record-file might serve as alternative)
-    - add --sub-justify
-    - add --sub-ass-justify
-    - internally there's a different way to enable the demuxer cache now
-      it can be auto-enabled even if the stream cache remains disabled
- --- mpv 0.23.0 ---
-    - remove deprecated vf_vdpaurb (use "--hwdec=vdpau-copy" instead)
-    - the following properties now have new semantics:
-        - "demuxer" (use "current-demuxer")
-        - "fps" (use "container-fps")
-        - "idle" (use "idle-active")
-        - "cache" (use "cache-percent")
-        - "audio-samplerate" (use "audio-params/samplerate")
-        - "audio-channels" (use "audio-params/channel-count")
-        - "audio-format" (use "audio-codec-name")
-      (the properties equivalent to the old semantics are in parentheses)
-    - remove deprecated --vo and --ao sub-options (like --vo=opengl:...), and
-      replace them with global options. A somewhat complete list can be found
-      here: https://github.com/mpv-player/mpv/wiki/Option-replacement-list#mpv-0210
-    - remove --vo-defaults and --ao-defaults as well
-    - remove deprecated global sub-options (like -demuxer-rawaudio format=...),
-      use flat options (like --demuxer-rawaudio-format=...)
-    - the --sub-codepage option changes in incompatible ways:
-        - detector-selection and fallback syntax is deprecated
-        - enca/libguess are removed and deprecated (behaves as if they hadn't
-          been compiled-in)
-        - --sub-codepage=<codepage> does not force the codepage anymore
-          (this requires different and new syntax)
-    - remove --fs-black-out-screens option for macOS
-    - change how spdif codecs are selected. You can't enable spdif passthrough
-      with --ad anymore. This was deprecated; use --audio-spdif instead.
-    - deprecate the "family" selection with --ad/--vd
-      forcing/excluding codecs with "+", "-", "-" is deprecated as well
-    - explicitly mark --ad-spdif-dtshd as deprecated (it was done so a long time
-      ago, but it didn't complain when using the option)
- --- mpv 0.22.0 ---
-    - the "audio-device-list" property now sets empty device description to the
-      device name as a fallback
-    - add --hidpi-window-scale option for macOS
-    - add audiounit audio output for iOS
-    - make --start-time work with --rebase-start-time=no
-    - add --opengl-early-flush=auto mode
-    - add --hwdec=vdpau-copy, deprecate vf_vdpaurb
-    - add tct video output for true-color and 256-color terminals
- --- mpv 0.21.0 ---
-    - unlike in older versions, setting options at runtime will now take effect
-      immediately (see for example issue #3281). On the other hand, it will also
-      do runtime verification and reject option changes that do not work
-      (example: setting the "vf" option to a filter during playback, which fails
-      to initialize - the option value will remain at its old value). In general,
-      "set name value" should be mostly equivalent to "set options/name value"
-      in cases where the "name" property is not deprecated and "options/name"
-      exists - deviations from this are either bugs, or documented as caveats
-      in the "Inconsistencies between options and properties" manpage section.
-    - deprecate _all_ --vo and --ao suboptions. Generally, all suboptions are
-      replaced by global options, which do exactly the same. For example,
-      "--vo=opengl:scale=nearest" turns into "--scale=nearest". In some cases,
-      the global option is prefixed, e.g. "--vo=opengl:pbo" turns into
-      "--opengl-pbo".
-      Most of the exact replacements are documented here:
-        https://github.com/mpv-player/mpv/wiki/Option-replacement-list
-    - remove --vo=opengl-hq. Set --profile=opengl-hq instead. Note that this
-      profile does not force the VO. This means if you use the --vo option to
-      set another VO, it won't work. But this also means it can be used with
-      opengl-cb.
-    - remove the --vo=opengl "pre-shaders", "post-shaders" and "scale-shader"
-      sub-options: they were deprecated in favor of "user-shaders"
-    - deprecate --vo-defaults (no replacement)
-    - remove the vo-cmdline command. You can set OpenGL renderer options
-      directly via properties instead.
-    - deprecate the device/sink options on all AOs. Use --audio-device instead.
-    - deprecate "--ao=wasapi:exclusive" and "--ao=coreaudio:exclusive",
-      use --audio-exclusive instead.
-    - subtle changes in how "--no-..." options are treated mean that they are
-      not accessible under "options/..." anymore (instead, these are resolved
-      at parsing time). This does not affect options which start with "--no-",
-      but do not use the mechanism for negation options.
-      (Also see client API change for API version 1.23.)
-    - rename the following properties
-        - "demuxer" -> "current-demuxer"
-        - "fps" -> "container-fps"
-        - "idle" -> "idle-active"
-        - "cache" -> "cache-percent"
-      the old names are deprecated and will change behavior in mpv 0.23.0.
-    - remove deprecated "hwdec-active" and "hwdec-detected" properties
-    - deprecate the ao and vo auto-profiles (they never made any sense)
-    - deprecate "--vo=direct3d_shaders" - use "--vo=direct3d" instead.
-      Change "--vo=direct3d" to always use shaders by default.
-    - deprecate --playlist-pos option, renamed to --playlist-start
-    - deprecate the --chapter option, as it is redundant with --start/--end,
-      and conflicts with the semantics of the "chapter" property
-    - rename --sub-text-* to --sub-* and --ass-* to --sub-ass-* (old options
-      deprecated)
-    - incompatible change to cdda:// protocol options: the part after cdda://
-      now always sets the device, not the span or speed to be played. No
-      separating extra "/" is needed. The hidden --cdda-device options is also
-      deleted (it was redundant with the documented --cdrom-device).
-    - deprecate --vo=rpi. It will be removed in mpv 0.23.0. Its functionality
-      was folded into --vo=opengl, which now uses RPI hardware decoding by
-      treating it as a hardware overlay (without applying GL filtering). Also
-      to be changed in 0.23.0: the --fs flag will be reset to "no" by default
-      (like on the other platforms).
-    - deprecate --mute=auto (informally has been since 0.18.1)
-    - deprecate "resume" and "suspend" IPC commands. They will be completely
-      removed in 0.23.0.
-    - deprecate mp.suspend(), mp.resume(), mp.resume_all() Lua scripting
-      commands, as well as setting mp.use_suspend. They will be completely
-      removed in 0.23.0.
-    - the "seek" command's absolute seek mode will now interpret negative
-      seek times as relative from the end of the file (and clamps seeks that
-      still go before 0)
-    - add almost all options to the property list, meaning you can change
-      options without adding "options/" to the property name (a new section
-      has been added to the manpage describing some conflicting behavior
-      between options and properties)
-    - implement changing sub-speed during playback
-    - make many previously fixed options changeable at runtime (for example
-      --terminal, --osc, --ytdl, can all be enable/disabled after
-      mpv_initialize() - this can be extended to other still fixed options
-      on user requests)
- --- mpv 0.20.0 ---
-    - add --image-display-duration option - this also means that image duration
-      is not influenced by --mf-fps anymore in the general case (this is an
-      incompatible change)
- --- mpv 0.19.0 ---
-    - deprecate "balance" option/property (no replacement)
- --- mpv 0.18.1 ---
-    - deprecate --heartbeat-cmd
-    - remove --softvol=no capability:
-        - deprecate --softvol, it now does nothing
-        - --volume, --mute, and the corresponding properties now always control
-          softvol, and behave as expected without surprises (e.g. you can set
-          them normally while no audio is initialized)
-        - rename --softvol-max to --volume-max (deprecated alias is added)
-        - the --volume-restore-data option and property are removed without
-          replacement. They were _always_ internal, and used for watch-later
-          resume/restore. Now --volume/--mute are saved directly instead.
-        - the previous point means resuming files with older watch-later configs
-          will print an error about missing --volume-restore-data (which you can
-          ignore), and will not restore the previous value
-        - as a consequence, volume controls will no longer control PulseAudio
-          per-application value, or use the system mixer's per-application
-          volume processing
-        - system or per-application volume can still be controlled with the
-          ao-volume and ao-mute properties (there are no command line options)
- --- mpv 0.18.0 ---
-    - now ab-loops are active even if one of the "ab-loop-a"/"-b" properties is
-      unset ("no"), in which case the start of the file is used if the A loop
-      point is unset, and the end of the file for an unset B loop point
-    - deprecate --sub-ass=no option by --ass-style-override=strip
-      (also needs --embeddedfonts=no)
-    - add "hwdec-interop" and "hwdec-current" properties
-    - deprecated "hwdec-active" and "hwdec-detected" properties (to be removed
-      in mpv 0.20.0)
-    - choice option/property values that are "yes" or "no" will now be returned
-      as booleans when using the mpv_node functions in the client API, the
-      "native" property accessors in Lua, and the JSON API. They can be set as
-      such as well.
-    - the VO opengl fbo-format sub-option does not accept "rgb" or "rgba"
-      anymore
-    - all VO opengl prescalers have been removed (replaced by user scripts)
- --- mpv 0.17.0 ---
-    - deprecate "track-list/N/audio-channels" property (use
-      "track-list/N/demux-channel-count" instead)
-    - remove write access to "stream-pos", and change semantics for read access
-    - Lua scripts now don't suspend mpv by default while script code is run
-    - add "cache-speed" property
-    - rename --input-unix-socket to --input-ipc-server, and make it work on
-      Windows too
-    - change the exact behavior of the "video-zoom" property
-    - --video-unscaled no longer disables --video-zoom and --video-aspect
-      To force the old behavior, set --video-zoom=0 and --video-aspect=0
 --- mpv 0.16.0 ---
    - change --audio-channels default to stereo (use --audio-channels=auto to
      get the old default)
@@ -4,9 +4,8 @@ AUDIO FILTERS
 Audio filters allow you to modify the audio stream and its properties. The
 syntax is:

-``--af=...``
-    Setup a chain of audio filters. See ``--vf`` (`VIDEO FILTERS`_) for the
-    full syntax.
+``--af=<filter1[=parameter1:parameter2:...],filter2,...>``
+    Setup a chain of audio filters.

 .. note::

@@ -16,15 +15,62 @@ syntax is:
    wrapper, which gives you access to most of libavfilter's filters. This
    includes all filters that have been ported from MPlayer to libavfilter.

-    The ``--vf`` description describes how libavfilter can be used and how to
-    workaround deprecated mpv filters.
+You can also set defaults for each filter. The defaults are applied before the
+normal filter parameters.

-See ``--vf`` group of options for info on how ``--af-defaults``, ``--af-add``,
-``--af-pre``, ``--af-del``, ``--af-clr``, and possibly others work.
+``--af-defaults=<filter1[=parameter1:parameter2:...],filter2,...>``
+    Set defaults for each filter.
+
+Audio filters are managed in lists. There are a few commands to manage the
+filter list:
+
+``--af-add=<filter1[,filter2,...]>``
+    Appends the filters given as arguments to the filter list.
+
+``--af-pre=<filter1[,filter2,...]>``
+    Prepends the filters given as arguments to the filter list.
+
+``--af-del=<index1[,index2,...]>``
+    Deletes the filters at the given indexes. Index numbers start at 0,
+    negative numbers address the end of the list (-1 is the last).
+
+``--af-clr``
+    Completely empties the filter list.

 Available filters are:

-``lavcac3enc[=options]``
+``lavrresample[=option1:option2:...]``
+    This filter uses libavresample (or libswresample, depending on the build)
+    to change sample rate, sample format, or channel layout of the audio stream.
+    This filter is automatically enabled if the audio output does not support
+    the audio configuration of the file being played.
+
+    It supports only the following sample formats: u8, s16, s32, float.
+
+    ``filter-size=<length>``
+        Length of the filter with respect to the lower sampling rate. (default:
+        16)
+    ``phase-shift=<count>``
+        Log2 of the number of polyphase entries. (..., 10->1024, 11->2048,
+        12->4096, ...) (default: 10->1024)
+    ``cutoff=<cutoff>``
+        Cutoff frequency (0.0-1.0), default set depending upon filter length.
+    ``linear``
+        If set then filters will be linearly interpolated between polyphase
+        entries. (default: no)
+    ``no-detach``
+        Do not detach if input and output audio format/rate/channels match.
+        (If you just want to set defaults for this filter that will be used
+        even by automatically inserted lavrresample instances, you should
+        prefer setting them with ``--af-defaults=lavrresample:...``.)
+    ``normalize=<yes|no|auto>``
+        Whether to normalize when remixing channel layouts (default: auto).
+        ``auto`` uses the value set by ``--audio-normalize-downmix``.
+    ``o=<string>``
+        Set AVOptions on the SwrContext or AVAudioResampleContext. These should
+        be documented by FFmpeg or Libav.
+
+``lavcac3enc[=tospdif[:bitrate[:minch]]]``
    Encode multi-channel audio to AC-3 at runtime using libavcodec. Supports
    16-bit native-endian input format, maximum 6 channels. The output is
    big-endian when outputting a raw AC-3 stream, native-endian when
@@ -57,11 +103,82 @@ Available filters are:
        If the input channel number is less than ``<minch>``, the filter will
        detach itself (default: 3).

-    ``encoder=<name>``
-        Select the libavcodec encoder used. Currently, this should be an AC-3
-        encoder, and using another codec will fail horribly.
+``equalizer=g1:g2:g3:...:g10``
+    10 octave band graphic equalizer, implemented using 10 IIR band-pass
+    filters. This means that it works regardless of what type of audio is
+    being played back. The center frequencies for the 10 bands are:

-``format=format:srate:channels:out-srate:out-channels``
+    === ==========
+    No. frequency
+    === ==========
+    0    31.25  Hz
+    1    62.50  Hz
+    2   125.00  Hz
+    3   250.00  Hz
+    4   500.00  Hz
+    5     1.00 kHz
+    6     2.00 kHz
+    7     4.00 kHz
+    8     8.00 kHz
+    9    16.00 kHz
+    === ==========
+
+    If the sample rate of the sound being played is lower than the center
+    frequency for a frequency band, then that band will be disabled. A known
+    bug with this filter is that the characteristics for the uppermost band
+    are not completely symmetric if the sample rate is close to the center
+    frequency of that band. This problem can be worked around by upsampling
+    the sound using a resampling filter before it reaches this filter.
+
+    ``<g1>:<g2>:<g3>:...:<g10>``
+        floating point numbers representing the gain in dB for each frequency
+        band (-12-12)
+
+    .. admonition:: Example
+
+        ``mpv --af=equalizer=11:11:10:5:0:-12:0:5:12:12 media.avi``
+            Would amplify the sound in the upper and lower frequency region
+            while canceling it almost completely around 1 kHz.
+
+``channels=nch[:routes]``
+    Can be used for adding, removing, routing and copying audio channels. If
+    only ``<nch>`` is given, the default routing is used. It works as follows:
+    If the number of output channels is greater than the number of input
+    channels, empty channels are inserted (except when mixing from mono to
+    stereo; then the mono channel is duplicated). If the number of output
+    channels is less than the number of input channels, the exceeding
+    channels are truncated.
+
+    ``<nch>``
+        number of output channels (1-8)
+    ``<routes>``
+        List of ``,`` separated routes, in the form ``from1-to1,from2-to2,...``.
+        Each pair defines where to route each channel. There can be at most
+        8 routes. Without this argument, the default routing is used. Since
+        ``,`` is also used to separate filters, you must quote this argument
+        with ``[...]`` or similar.
+
+    .. admonition:: Examples
+
+        ``mpv --af=channels=4:[0-1,1-0,2-2,3-3] media.avi``
+            Would change the number of channels to 4 and set up 4 routes that
+            swap channel 0 and channel 1 and leave channel 2 and 3 intact.
+            Observe that if media containing two channels were played back,
+            channels 2 and 3 would contain silence but 0 and 1 would still be
+            swapped.
+
+        ``mpv --af=channels=6:[0-0,0-1,0-2,0-3] media.avi``
+            Would change the number of channels to 6 and set up 4 routes that
+            copy channel 0 to channels 0 to 3. Channel 4 and 5 will contain
+            silence.
+
+    .. note::
+
+        You should probably not use this filter. If you want to change the
+        output channel layout, try the ``format`` filter, which can make mpv
+        automatically up- and downmix standard channel layouts.
+
+``format=format:srate:channels:out-format:out-srate:out-channels``
    Does not do any format conversion itself. Rather, it may cause the
    filter system to insert necessary conversion filters before or after this
    filter if needed. It is primarily useful for controlling the audio format
@@ -90,6 +207,8 @@ Available filters are:
        Force mixing to a specific channel layout. See ``--audio-channels`` option
        for possible values.

+    ``<out-format>``
+
    ``<out-srate>``

    ``<out-channels>``
@@ -98,6 +217,148 @@ Available filters are:
    used to do conversion itself, unlike this one which lets the filter system
    handle the conversion.

+``volume[=<volumedb>[:...]]``
+    Implements software volume control. Use this filter with caution since it
+    can reduce the signal to noise ratio of the sound. In most cases it is
+    best to use the *Master* volume control of your sound card or the volume
+    knob on your amplifier.
+
+    *NOTE*: This filter is not reentrant and can therefore only be enabled
+    once for every audio stream.
+
+    ``<volumedb>``
+        Sets the desired gain in dB for all channels in the stream from -200 dB
+        to +60 dB, where -200 dB mutes the sound completely and +60 dB equals a
+        gain of 1000 (default: 0).
+    ``replaygain-track``
+        Adjust volume gain according to the track-gain replaygain value stored
+        in the file metadata.
+    ``replaygain-album``
+        Like replaygain-track, but using the album-gain value instead.
+    ``replaygain-preamp``
+        Pre-amplification gain in dB to apply to the selected replaygain gain
+        (default: 0).
+    ``replaygain-clip=yes|no``
+        Prevent clipping caused by replaygain by automatically lowering the
+        gain (default). Use ``replaygain-clip=no`` to disable this.
+    ``replaygain-fallback``
+        Gain in dB to apply if the file has no replay gain tags. This option
+        is always applied if the replaygain logic is somehow inactive. If this
+        is applied, no other replaygain options are applied.
+    ``softclip``
+        Turns soft clipping on. Soft-clipping can make the
+        sound more smooth if very high volume levels are used. Enable this
+        option if the dynamic range of the loudspeakers is very low.
+
+        *WARNING*: This feature creates distortion and should be considered a
+        last resort.
+    ``s16``
+        Force S16 sample format if set. Lower quality, but might be faster
+        in some situations.
+    ``detach``
+        Remove the filter if the volume is not changed at audio filter config
+        time. Useful with replaygain: if the current file has no replaygain
+        tags, then the filter will be removed if this option is enabled.
+        (If ``--softvol=yes`` is used and the player volume controls are used
+        during playback, a different volume filter will be inserted.)
+
+    .. admonition:: Example
+
+        ``mpv --af=volume=10.1 media.avi``
+            Would amplify the sound by 10.1 dB and hard-clip if the sound level
+            is too high.
+
+``pan=n:[<matrix>]``
+    Mixes channels arbitrarily. Basically a combination of the volume and the
+    channels filter that can be used to down-mix many channels to only a few,
+    e.g. stereo to mono, or vary the "width" of the center speaker in a
+    surround sound system. This filter is hard to use, and will require some
+    tinkering before the desired result is obtained. The number of options for
+    this filter depends on the number of output channels. An example how to
+    downmix a six-channel file to two channels with this filter can be found
+    in the examples section near the end.
+
+    ``<n>``
+        Number of output channels (1-8).
+    ``<matrix>``
+        A list of values ``[L00,L01,L02,...,L10,L11,L12,...,Ln0,Ln1,Ln2,...]``,
+        where each element ``Lij`` means how much of input channel i is mixed
+        into output channel j (range 0-1). So in principle you first have n
+        numbers saying what to do with the first input channel, then n numbers
+        that act on the second input channel etc. If you do not specify any
+        numbers for some input channels, 0 is assumed.
+        Note that the values are separated by ``,``, which is already used
+        by the option parser to separate filters. This is why you must quote
+        the value list with ``[...]`` or similar.
+
+    .. admonition:: Examples
+
+        ``mpv --af=pan=1:[0.5,0.5] media.avi``
+            Would downmix from stereo to mono.
+
+        ``mpv --af=pan=3:[1,0,0.5,0,1,0.5] media.avi``
+            Would give 3 channel output leaving channels 0 and 1 intact, and mix
+            channels 0 and 1 into output channel 2 (which could be sent to a
+            subwoofer for example).
+
+    .. note::
+
+        If you just want to force remixing to a certain output channel layout,
+        it is easier to use the ``format`` filter. For example,
+        ``mpv '--af=format=channels=5.1' '--audio-channels=5.1'`` would always force
+        remixing audio to 5.1 and output it like this.
+
+``delay[=[ch1,ch2,...]]``
+    Delays the sound to the loudspeakers such that the sound from the
+    different channels arrives at the listening position simultaneously. It is
+    only useful if you have more than 2 loudspeakers.
+
+    ``[ch1,ch2,...]``
+        The delay in ms that should be imposed on each channel (floating point
+        number between 0 and 1000).
+
+    To calculate the required delay for the different channels, do as follows:
+
+    1. Measure the distance to the loudspeakers in meters in relation to your
+       listening position, giving you the distances s1 to s5 (for a 5.1
+       system). There is no point in compensating for the subwoofer (you will
+       not hear the difference anyway).
+
+    2. Subtract the distances s1 to s5 from the maximum distance, i.e.
+       ``s[i] = max(s) - s[i]; i = 1...5``.
+
+    3. Calculate the required delays in ms as ``d[i] = 1000*s[i]/342; i =
+       1...5``.
+
+    .. admonition:: Example
+
+        ``mpv --af=delay=[10.5,10.5,0,0,7,0] media.avi``
+            Would delay front left and right by 10.5 ms, the two rear channels
+            and the subwoofer by 0 ms and the center channel by 7 ms.
+
+``drc[=method:target]``
+    Applies dynamic range compression. This maximizes the volume by compressing
+    the audio signal's dynamic range. (Formerly called ``volnorm``.)
+
+    ``<method>``
+        Sets the used method.
+
+        1
+            Use a single sample to smooth the variations via the standard
+            weighted mean over past samples (default).
+        2
+            Use several samples to smooth the variations via the standard
+            weighted mean over past samples.
+
+    ``<target>``
+        Sets the target amplitude as a fraction of the maximum for the sample
+        type (default: 0.25).
+
+    .. note::
+
+        This filter can cause distortion with audio signals that have a very
+        large dynamic range.
+
 ``scaletempo[=option1:option2:...]``
    Scales audio tempo without altering pitch, optionally synced to playback
    speed (default).
@@ -157,64 +418,29 @@ Available filters are:
        ``mpv --af=scaletempo=stride=30:overlap=.50:search=10 media.ogg``
            Would tweak the quality and performance parameters.

+        ``mpv --af=format=float,scaletempo media.ogg``
+            Would make scaletempo use float code. Maybe faster on some
+            platforms.
+
        ``mpv --af=scaletempo=scale=1.2:speed=pitch audio.ogg``
            Would play media at 1.2x normal speed, with audio at normal pitch.
            Changing playback speed would change pitch, leaving audio tempo at
            1.2x.

-``scaletempo2[=option1:option2:...]``
-    Scales audio tempo without altering pitch.
-    The algorithm is ported from chromium and uses the
-    Waveform Similarity Overlap-and-add (WSOLA) method.
-    It seems to achieve a higher audio quality than scaletempo and rubberband.
-
-    By default, the ``search-interval`` and ``window-size`` parameters
-    have the same values as in chromium.
-
-    ``min-speed=<speed>``
-        Mute audio if the playback speed is below ``<speed>``. (default: 0.25)
-
-    ``max-speed=<speed>``
-        Mute audio if the playback speed is above ``<speed>``
-        and ``<speed> != 0``. (default: 4.0)
-
-    ``search-interval=<amount>``
-        Length in milliseconds to search for best overlap position. (default: 30)
-
-    ``window-size=<amount>``
-        Length in milliseconds of the overlap-and-add window. (default: 20)
-
 ``rubberband``
    High quality pitch correction with librubberband. This can be used in place
    of ``scaletempo``, and will be used to adjust audio pitch when playing
-    at speed different from normal. It can also be used to adjust audio pitch
-    without changing playback speed.
+    at speed different from normal.

-    ``<pitch-scale>``
-        Sets the pitch scaling factor. Frequencies are multiplied by this value.
-
-    This filter has a number of additional sub-options. You can list them with
+    This filter has a number of sub-options. You can list them with
    ``mpv --af=rubberband=help``. This will also show the default values
    for each option. The options are not documented here, because they are
    merely passed to librubberband. Look at the librubberband documentation
    to learn what each option does:
-    https://breakfastquay.com/rubberband/code-doc/classRubberBand_1_1RubberBandStretcher.html
+    http://breakfastquay.com/rubberband/code-doc/classRubberBand_1_1RubberBandStretcher.html
    (The mapping of the mpv rubberband filter sub-option names and values to
    those of librubberband follows a simple pattern: ``"Option" + Name + Value``.)

-    This filter supports the following ``af-command`` commands:
-
-    ``set-pitch``
-        Set the ``<pitch-scale>`` argument dynamically. This can be used to
-        change the playback pitch at runtime. Note that speed is controlled
-        using the standard ``speed`` property, not ``af-command``.
-
-    ``multiply-pitch <factor>``
-        Multiply the current value of ``<pitch-scale>`` dynamically.  For
-        example: 0.5 to go down by an octave, 1.5 to go up by a perfect fifth.
-        If you want to go up or down by semi-tones, use 1.059463094352953 and
-        0.9438743126816935
-
 ``lavfi=graph``
    Filter audio using FFmpeg's libavfilter.

@@ -229,23 +455,3 @@ Available filters are:

    ``o=<string>``
        AVOptions.
-
-    ``fix-pts=<yes|no>``
-        Determine PTS based on sample count (default: no). If this is enabled,
-        the player won't rely on libavfilter passing through PTS accurately.
-        Instead, it pass a sample count as PTS to libavfilter, and compute the
-        PTS used by mpv based on that and the input PTS. This helps with filters
-        which output a recomputed PTS instead of the original PTS (including
-        filters which require the PTS to start at 0). mpv normally expects
-        filters to not touch the PTS (or only to the extent of changing frame
-        boundaries), so this is not the default, but it will be needed to use
-        broken filters. In practice, these broken filters will either cause slow
-        A/V desync over time (with some files), or break playback completely if
-        you seek or start playback from the middle of a file.
-
-``drop``
-    This filter drops or repeats audio frames to adapt to playback speed. It
-    always operates on full audio frames, because it was made to handle SPDIF
-    (compressed audio passthrough). This is used automatically if the
-    ``--video-sync=display-adrop`` option is used. Do not use this filter (or
-    the given option); they are extremely low quality.
@@ -4,34 +4,108 @@ AUDIO OUTPUT DRIVERS
 Audio output drivers are interfaces to different audio output facilities. The
 syntax is:

-``--ao=<driver1,driver2,...[,]>``
+``--ao=<driver1[:suboption1[=value]:...],driver2,...[,]>``
    Specify a priority list of audio output drivers to be used.

 If the list has a trailing ',', mpv will fall back on drivers not contained
-in the list.
+in the list. Suboptions are optional and can mostly be omitted.
+
+You can also set defaults for each driver. The defaults are applied before the
+normal driver parameters.
+
+``--ao-defaults=<driver1[:parameter1:parameter2:...],driver2,...>``
+    Set defaults for each driver.

 .. note::

    See ``--ao=help`` for a list of compiled-in audio output drivers. The
    driver ``--ao=alsa`` is preferred. ``--ao=pulse`` is preferred on systems
-    where PulseAudio is used. On BSD systems, ``--ao=oss`` is preferred.
+    where PulseAudio is used. On BSD systems, ``--ao=oss`` or ``--ao=sndio``
+    may work (the latter being experimental).
+
+.. admonition:: Examples
+
+    - ``--ao=alsa,oss,`` Try the ALSA driver, then the OSS driver, then others.
+    - ``--ao=alsa:resample=yes:device=[plughw:0,3]`` Lets ALSA resample and
+      sets the device-name as first card, fourth device.

 Available audio output drivers are:

 ``alsa`` (Linux only)
    ALSA audio output driver

-    See `ALSA audio output options`_ for options specific to this AO.
+    ``device=<device>``
+        Sets the device name. For ac3 output via S/PDIF, use an "iec958" or
+        "spdif" device, unless you really know how to set it correctly.
+    ``resample=yes``
+        Enable ALSA resampling plugin. (This is disabled by default, because
+        some drivers report incorrect audio delay in some cases.)
+    ``mixer-device=<device>``
+        Set the mixer device used with ``--no-softvol`` (default: ``default``).
+    ``mixer-name=<name>``
+        Set the name of the mixer element (default: ``Master``). This is for
+        example ``PCM`` or ``Master``.
+    ``mixer-index=<number>``
+        Set the index of the mixer channel (default: 0). Consider the output of
+        "``amixer scontrols``", then the index is the number that follows the
+        name of the element.
+    ``non-interleaved``
+        Allow output of non-interleaved formats (if the audio decoder uses
+        this format). Currently disabled by default, because some popular
+        ALSA plugins are utterly broken with non-interleaved formats.
+    ``ignore-chmap``
+        Don't read or set the channel map of the ALSA device - only request the
+        required number of channels, and then pass the audio as-is to it. This
+        option most likely should not be used. It can be useful for debugging,
+        or for static setups with a specially engineered ALSA configuration (in
+        this case you should always force the same layout with ``--audio-channels``,
+        or it will work only for files which use the layout implicit to your
+        ALSA device).
+
+    .. note::
+
+        MPlayer and mplayer2 required you to replace any ',' with '.' and
+        any ':' with '=' in the ALSA device name. mpv does not do this anymore.
+        Instead, quote the device name:
+
+            ``--ao=alsa:device=[plug:surround50]``
+
+        Note that the ``[`` and ``]`` simply quote the device name. With some
+        shells (like zsh), you have to quote the option string to prevent the
+        shell from interpreting the brackets instead of passing them to mpv.
+
+        Actually, you should use the ``--audio-device`` option, instead of
+        setting the device directly.

    .. warning::

-        To get multichannel/surround audio, use ``--audio-channels=auto``. The
-        default for this option is ``auto-safe``, which makes this audio output
-        explicitly reject multichannel output, as there is no way to detect
-        whether a certain channel layout is actually supported.
+        Handling of multichannel/surround audio changed in mpv 0.8.0 from the
+        behavior in MPlayer/mplayer2 and older versions of mpv.

-        You can also try `using the upmix plugin
-        <https://github.com/mpv-player/mpv/wiki/ALSA-Surround-Sound-and-Upmixing>`_.
+        The old behavior is that the player always downmixed to stereo by
+        default. The ``--audio-channels`` (or ``--channels`` before that) option
+        had to be set to get multichannel audio. Then playing stereo would
+        use the ``default`` device (which typically allows multiple programs
+        to play audio at the same time via dmix), while playing anything with
+        more channels would open one of the hardware devices, e.g. via the
+        ``surround51`` alias (typically with exclusive access). Whether the
+        player would use exclusive access or not would depend on the file
+        being played.
+
+        The new behavior since mpv 0.8.0 always enables multichannel audio,
+        i.e. ``--audio-channels=auto`` is the default. However, since ALSA
+        provides no good way to play multichannel audio in a non-exclusive
+        way (without blocking other applications from using audio), the player
+        is restricted to the capabilities of the ``default`` device by default,
+        which means it supports only stereo and mono (at least with current
+        typical ALSA configurations). But if a hardware device is selected,
+        then multichannel audio will typically work.
+
+        The short story is: if you want multichannel audio with ALSA, use
+        ``--audio-device`` to select the device (use ``--audio-device=help``
+        to get a list of all devices and their mpv name).
+
+        You can also try `using the upmix plugin <http://git.io/vfuAy>`_.
        This setup enables multichannel audio on the ``default`` device
        with automatic upmixing with shared access, so playing stereo
        and multichannel audio at the same time will work as expected.
@@ -39,24 +113,31 @@ Available audio output drivers are:
 ``oss``
    OSS audio output driver

+    ``<dsp-device>``
+        Sets the audio output device (default: ``/dev/dsp``).
+    ``<mixer-device>``
+        Sets the audio mixer device (default: ``/dev/mixer``).
+    ``<mixer-channel>``
+        Sets the audio mixer channel (default: ``pcm``). Other valid values
+        include **vol, pcm, line**. For a complete list of options look for
+        ``SOUND_DEVICE_NAMES`` in ``/usr/include/linux/soundcard.h``.
+
 ``jack``
-    JACK (Jack Audio Connection Kit) audio output driver.
+    JACK (Jack Audio Connection Kit) audio output driver

-    The following global options are supported by this audio output:
-
-    ``--jack-port=<name>``
+    ``port=<name>``
        Connects to the ports with the given name (default: physical ports).
-    ``--jack-name=<client>``
+    ``name=<client>``
        Client name that is passed to JACK (default: ``mpv``). Useful
        if you want to have certain connections established automatically.
-    ``--jack-autostart=<yes|no>``
+    ``(no-)autostart``
        Automatically start jackd if necessary (default: disabled). Note that
        this tends to be unreliable and will flood stdout with server messages.
-    ``--jack-connect=<yes|no>``
+    ``(no-)connect``
        Automatically create connections to output ports (default: enabled).
        When enabled, the maximum number of output channels will be limited to
        the number of available output ports.
-    ``--jack-std-channel-layout=<waveext|any>``
+    ``std-channel-layout=waveext|any``
        Select the standard channel layout (default: waveext). JACK itself has no
        notion of channel layouts (i.e. assigning which speaker a given
        channel is supposed to map to) - it just takes whatever the application
@@ -69,16 +150,14 @@ Available audio output drivers are:
        mode is probably not very useful, other than for debugging or when used
        with fixed setups.

-``coreaudio`` (macOS only)
-    Native macOS audio output driver using AudioUnits and the CoreAudio
+``coreaudio`` (Mac OS X only)
+    Native Mac OS X audio output driver using AudioUnits and the CoreAudio
    sound server.

    Automatically redirects to ``coreaudio_exclusive`` when playing compressed
    formats.

-    The following global options are supported by this audio output:
-
-    ``--coreaudio-change-physical-format=<yes|no>``
+    ``change-physical-format=<yes|no>``
        Change the physical format to one similar to the requested audio format
        (default: no). This has the advantage that multichannel audio output
        will actually work. The disadvantage is that it will change the
@@ -86,51 +165,36 @@ Available audio output drivers are:
        setting in the ``Audio Devices`` dialog in the ``Audio MIDI Setup``
        utility. Note that this does not affect the selected speaker setup.

-    ``--coreaudio-spdif-hack=<yes|no>``
-        Try to pass through AC3/DTS data as PCM. This is useful for drivers
-        which do not report AC3 support. It converts the AC3 data to float,
-        and assumes the driver will do the inverse conversion, which means
-        a typical A/V receiver will pick it up as compressed IEC framed AC3
-        stream, ignoring that it's marked as PCM. This disables normal AC3
-        passthrough (even if the device reports it as supported). Use with
-        extreme care.
+    ``exclusive``
+        Use exclusive mode access. This merely redirects to
+        ``coreaudio_exclusive``, but should be preferred over using that AO
+        directly.

-
-``coreaudio_exclusive`` (macOS only)
-    Native macOS audio output driver using direct device access and
+``coreaudio_exclusive`` (Mac OS X only)
+    Native Mac OS X audio output driver using direct device access and
    exclusive mode (bypasses the sound server).

 ``openal``
-    OpenAL audio output driver.
+    Experimental OpenAL audio output driver

-    ``--openal-num-buffers=<2-128>``
-        Specify the number of audio buffers to use. Lower values are better for
-        lower CPU usage. Default: 4.
-
-    ``--openal-num-samples=<256-32768>``
-        Specify the number of complete samples to use for each buffer. Higher
-        values are better for lower CPU usage. Default: 8192.
-
-    ``--openal-direct-channels=<yes|no>``
-        Enable OpenAL Soft's direct channel extension when available to avoid
-        tinting the sound with ambisonics or HRTF. Default: yes.
+    .. note:: This driver is not very useful. Playing multi-channel audio with
+              it is slow.

 ``pulse``
    PulseAudio audio output driver

-    The following global options are supported by this audio output:
+    ``[<host>][:<output sink>]``
+        Specify the host and optionally output sink to use. An empty <host>
+        string uses a local connection, "localhost" uses network transfer
+        (most likely not what you want).

-    ``--pulse-host=<host>``
-        Specify the host to use. An empty <host> string uses a local connection,
-        "localhost" uses network transfer (most likely not what you want).
-
-    ``--pulse-buffer=<1-2000|native>``
+    ``buffer=<1-2000|native>``
        Set the audio buffer size in milliseconds. A higher value buffers
        more data, and has a lower probability of buffer underruns. A smaller
        value makes the audio stream react faster, e.g. to playback speed
-        changes.
+        changes. Default: 250.

-    ``--pulse-latency-hacks=<yes|no>``
+    ``latency-hacks=<yes|no>``
        Enable hacks to workaround PulseAudio timing bugs (default: no). If
        enabled, mpv will do elaborate latency calculations on its own. If
        disabled, it will use PulseAudio automatically updated timing
@@ -141,26 +205,6 @@ Available audio output drivers are:
        If you have stuttering video when using pulse, try to enable this
        option. (Or try to update PulseAudio.)

-    ``--pulse-allow-suspended=<yes|no>``
-        Allow mpv to use PulseAudio even if the sink is suspended (default: no).
-        Can be useful if PulseAudio is running as a bridge to jack and mpv has its sink-input set to the one jack is using.
-
-``pipewire``
-    PipeWire audio output driver
-
-    The following global options are supported by this audio output:
-
-    ``--pipewire-buffer=<1-2000|native>``
-        Set the audio buffer size in milliseconds. A higher value buffers
-        more data, and has a lower probability of buffer underruns. A smaller
-        value makes the audio stream react faster, e.g. to playback speed
-        changes.
-
-    ``--pipewire-remote=<remote>``
-        Specify the PipeWire remote daemon name to connect to via local UNIX
-        sockets.
-        An empty <remote> string uses the default remote named ``pipewire-0``.
-
 ``sdl``
    SDL 1.2+ audio output driver. Should work on any platform supported by SDL
    1.2, but may require the ``SDL_AUDIODRIVER`` environment variable to be set
@@ -170,75 +214,107 @@ Available audio output drivers are:
              environments, such as systems where none of the other drivers
              are available.

-    The following global options are supported by this audio output:
-
-    ``--sdl-buflen=<length>``
+    ``buflen=<length>``
        Sets the audio buffer length in seconds. Is used only as a hint by the
        sound system. Playing a file with ``-v`` will show the requested and
        obtained exact buffer size. A value of 0 selects the sound system
        default.

+    ``bufcnt=<count>``
+        Sets the number of extra audio buffers in mpv. Usually needs not be
+        changed.
+
 ``null``
-    Produces no audio output but maintains video playback speed. You can use
-    ``--ao=null --ao-null-untimed`` for benchmarking.
+    Produces no audio output but maintains video playback speed. Use
+    ``--ao=null:untimed`` for benchmarking.

-    The following global options are supported by this audio output:
-
-    ``--ao-null-untimed``
+    ``untimed``
        Do not simulate timing of a perfect audio device. This means audio
        decoding will go as fast as possible, instead of timing it to the
        system clock.

-    ``--ao-null-buffer``
+    ``buffer``
        Simulated buffer length in seconds.

-    ``--ao-null-outburst``
+    ``outburst``
        Simulated chunk size in samples.

-    ``--ao-null-speed``
+    ``speed``
        Simulated audio playback speed as a multiplier. Usually, a real audio
        device will not go exactly as fast as the system clock. It will deviate
        just a little, and this option helps to simulate this.

-    ``--ao-null-latency``
+    ``latency``
        Simulated device latency. This is additional to EOF.

-    ``--ao-null-broken-eof``
+    ``broken-eof``
        Simulate broken audio drivers, which always add the fixed device
        latency to the reported audio playback position.

-    ``--ao-null-broken-delay``
+    ``broken-delay``
        Simulate broken audio drivers, which don't report latency correctly.

-    ``--ao-null-channel-layouts``
+    ``channel-layouts``
        If not empty, this is a ``,`` separated list of channel layouts the
        AO allows. This can be used to test channel layout selection.

-    ``--ao-null-format``
-        Force the audio output format the AO will accept. If unset accepts any.
-
 ``pcm``
    Raw PCM/WAVE file writer audio output

-    The following global options are supported by this audio output:
-
-    ``--ao-pcm-waveheader=<yes|no>``
+    ``(no-)waveheader``
        Include or do not include the WAVE header (default: included). When
        not included, raw PCM will be generated.
-    ``--ao-pcm-file=<filename>``
+    ``file=<filename>``
        Write the sound to ``<filename>`` instead of the default
        ``audiodump.wav``. If ``no-waveheader`` is specified, the default is
        ``audiodump.pcm``.
-    ``--ao-pcm-append=<yes|no>``
+    ``(no-)append``
        Append to the file, instead of overwriting it. Always use this with the
        ``no-waveheader`` option - with ``waveheader`` it's broken, because
        it will write a WAVE header every time the file is opened.

+``rsound``
+    Audio output to an RSound daemon
+
+    .. note:: Completely useless, unless you intend to run RSound. Not to be
+              confused with RoarAudio, which is something completely
+              different.
+
+    ``host=<name/path>``
+        Set the address of the server (default: localhost).  Can be either a
+        network hostname for TCP connections or a Unix domain socket path
+        starting with '/'.
+    ``port=<number>``
+        Set the TCP port used for connecting to the server (default: 12345).
+        Not used if connecting to a Unix domain socket.
+
 ``sndio``
    Audio output to the OpenBSD sndio sound system

+    .. note:: Experimental. There are known bugs and issues.
+
    (Note: only supports mono, stereo, 4.0, 5.1 and 7.1 channel
    layouts.)

+    ``device=<device>``
+        sndio device to use (default: ``$AUDIODEVICE``, resp. ``snd0``).
+
 ``wasapi``
    Audio output to the Windows Audio Session API.
+
+    ``exclusive``
+        Requests exclusive, direct hardware access. By definition prevents
+        sound playback of any other program until mpv exits.
+    ``device=<id>``
+        Uses the requested endpoint instead of the system's default audio
+        endpoint. Both an ordinal number (0,1,2,...) and the GUID
+        String are valid; the GUID string is guaranteed to not change
+        unless the driver is uninstalled.
+
+        Also supports searching active devices by human-readable name. If more
+        than one device matches the name, refuses loading it.
+
+        This option is mostly deprecated in favour of the more general
+        ``--audio-device`` option. That said, ``--audio-device=help`` will give
+        a list of valid device GUIDs (prefixed with ``wasapi/``), as well as
+        their human readable names, which should work here.
@@ -8,13 +8,6 @@ There is no real changelog, but you can look at the following things:

  https://github.com/mpv-player/mpv/releases
 * The git log, which is the "real" changelog
-* The file https://github.com/mpv-player/mpv/blob/master/DOCS/interface-changes.rst
-  documents changes to the command and user interface, such as options and
-  properties. (It usually documents breaking changes only, additions and
-  enhancements are often not listed.)
-* C API changes are listed in
-  https://github.com/mpv-player/mpv/blob/master/DOCS/client-api-changes.rst
 * The file ``mplayer-changes.rst`` in the ``DOCS`` sub directory on the git
  repository, which used to be in place of this section. It documents some
-  changes that happened since mplayer2 forked off MPlayer. (Not updated
-  anymore.)
+  changes that happened since mplayer2 forked off MPlayer.
@@ -1,150 +0,0 @@
-CONSOLE
-=======
-
-The console is a REPL for mpv input commands. It is displayed on the video
-window. It also shows log messages. It can be disabled entirely using the
-``--load-osd-console=no`` option.
-
-Keybindings
-----------
-
-\`
-    Show the console.
-
-ESC
-    Hide the console.
-
-ENTER, Ctrl+J and Ctrl+M
-    Run the typed command.
-
-Shift+ENTER
-    Type a literal newline character.
-
-LEFT and Ctrl+B
-    Move the cursor to the previous character.
-
-RIGHT and Ctrl+F
-    Move the cursor to the next character.
-
-Ctrl+LEFT and Alt+B
-    Move the cursor to the beginning of the current word, or if between words,
-    to the beginning of the previous word.
-
-Ctrl+RIGHT and Alt+F
-    Move the cursor to the end of the current word, or if between words, to the
-    end of the next word.
-
-HOME and Ctrl+A
-    Move the cursor to the start of the current line.
-
-END and Ctrl+E
-    Move the cursor to the end of the current line.
-
-BACKSPACE and Ctrl+H
-    Delete the previous character.
-
-Ctrl+D
-    Hide the console if the current line is empty, otherwise delete the next
-    character.
-
-Ctrl+BACKSPACE and Ctrl+W
-    Delete text from the cursor to the beginning of the current word, or if
-    between words, to the beginning of the previous word.
-
-Ctrl+DEL and Alt+D
-    Delete text from the cursor to the end of the current word, or if between
-    words, to the end of the next word.
-
-Ctrl+U
-    Delete text from the cursor to the beginning of the current line.
-
-Ctrl+K
-    Delete text from the cursor to the end of the current line.
-
-Ctrl+C
-    Clear the current line.
-
-UP and Ctrl+P
-    Move back in the command history.
-
-DOWN and Ctrl+N
-    Move forward in the command history.
-
-PGUP
-    Go to the first command in the history.
-
-PGDN
-    Stop navigating the command history.
-
-INSERT
-    Toggle insert mode.
-
-Ctrl+V
-    Paste text (uses the clipboard on X11 and Wayland).
-
-Shift+INSERT
-    Paste text (uses the primary selection on X11 and Wayland).
-
-TAB and Ctrl+I
-    Complete the command or property name at the cursor.
-
-Ctrl+L
-    Clear all log messages from the console.
-
-Commands
--------
-
-``script-message-to console type <text> [<cursor_pos>]``
-    Show the console and pre-fill it with the provided text, optionally
-    specifying the initial cursor position as a positive integer starting from
-    1.
-
-    .. admonition:: Example for input.conf
-
-        ``% script-message-to console type "seek  absolute-percent" 6``
-
-Known issues
------------
-
- Pasting text is slow on Windows
- Non-ASCII keyboard input has restrictions
- The cursor keys move between Unicode code-points, not grapheme clusters
-
-Configuration
-------------
-
-This script can be customized through a config file ``script-opts/console.conf``
-placed in mpv's user directory and through the ``--script-opts`` command-line
-option. The configuration syntax is described in `ON SCREEN CONTROLLER`_.
-
-Key bindings can be changed in a standard way, see for example stats.lua
-documentation.
-
-Configurable Options
-~~~~~~~~~~~~~~~~~~~~
-
-``scale``
-    Default: 1
-
-    All drawing is scaled by this value, including the text borders and the
-    cursor.
-
-    If the VO backend in use has HiDPI scale reporting implemented, the option
-    value is scaled with the reported HiDPI scale.
-
-``font``
-    Default: unset (picks a hardcoded font depending on detected platform)
-
-    Set the font used for the REPL and the console. This probably doesn't
-    have to be a monospaced font.
-
-``font_size``
-    Default: 16
-
-    Set the font size used for the REPL and the console. This will be
-    multiplied by "scale".
-
-``history_dedup``
-    Default: true
-
-    Remove duplicate entries in history as to only keep the latest one.
@@ -8,29 +8,64 @@ You can encode files from one format/codec to another using this facility.

 ``--of=<format>``
    Specifies the output format (overrides autodetection by the file name
-    extension of the file specified by ``-o``). See ``--of=help`` for a full
-    list of supported formats.
+    extension of the file specified by ``-o``). This can be a comma separated
+    list of possible formats to try. See ``--of=help`` for a full list of
+    supported formats.

 ``--ofopts=<options>``
    Specifies the output format options for libavformat.
    See ``--ofopts=help`` for a full list of supported options.

-    This is a key/value list option. See `List Options`_ for details.
+    Options are managed in lists. There are a few commands to manage the
+    options list.

-    ``--ofopts-add=<option>``
-        Appends the option given as an argument to the options list. (Passing
-        multiple options is currently still possible, but deprecated.)
+    ``--ofopts-add=<options1[,options2,...]>``
+        Appends the options given as arguments to the options list.

-    ``--ofopts=""``
+    ``--ofopts-pre=<options1[,options2,...]>``
+        Prepends the options given as arguments to the options list.
+
+    ``--ofopts-del=<index1[,index2,...]>``
+        Deletes the options at the given indexes. Index numbers start at 0,
+        negative numbers address the end of the list (-1 is the last).
+
+    ``--ofopts-clr``
        Completely empties the options list.

+``--ofps=<float value>``
+    Specifies the output format time base (default: 24000). Low values like 25
+    limit video fps by dropping frames.
+
+``--oautofps``
+    Sets the output format time base to the guessed frame rate of the input
+    video (simulates MEncoder behavior, useful for AVI; may cause frame drops).
+    Note that not all codecs and not all formats support VFR encoding, and some
+    which do have bugs when a target bitrate is specified - use ``--ofps`` or
+    ``--oautofps`` to force CFR encoding in these cases.
+
+``--omaxfps=<float value>``
+    Specifies the minimum distance of adjacent frames (default: 0, which means
+    unset). Content of lower frame rate is not readjusted to this frame rate;
+    content of higher frame rate is decimated to this frame rate.
+
+``--oharddup``
+    If set, the frame rate given by ``--ofps`` is attained not by skipping time
+    codes, but by duplicating frames (constant frame rate mode).
+
+``--oneverdrop``
+    If set, frames are never dropped. Instead, time codes of video are
+    readjusted to always increase. This may cause AV desync, though; to work
+    around this, use a high-fps time base using ``--ofps`` and absolutely
+    avoid ``--oautofps``.
+
 ``--oac=<codec>``
-    Specifies the output audio codec. See ``--oac=help`` for a full list of
-    supported codecs.
+    Specifies the output audio codec. This can be a comma separated list of
+    possible codecs to try. See ``--oac=help`` for a full list of supported
+    codecs.

 ``--oaoffset=<value>``
    Shifts audio data by the given time (in seconds) by adding/removing
-    samples at the start. Deprecated.
+    samples at the start.

 ``--oacopts=<options>``
    Specifies the output audio codec options for libavcodec.
@@ -41,28 +76,36 @@ You can encode files from one format/codec to another using this facility.
        "``--oac=libmp3lame --oacopts=b=128000``"
            selects 128 kbps MP3 encoding.

-    This is a key/value list option. See `List Options`_ for details.
+    Options are managed in lists. There are a few commands to manage the
+    options list.

-    ``--oacopts-add=<option>``
-        Appends the option given as an argument to the options list. (Passing
-        multiple options is currently still possible, but deprecated.)
+    ``--oacopts-add=<options1[,options2,...]>``
+        Appends the options given as arguments to the options list.

-    ``--oacopts=""``
+    ``--oacopts-pre=<options1[,options2,...]>``
+        Prepends the options given as arguments to the options list.
+
+    ``--oacopts-del=<index1[,index2,...]>``
+        Deletes the options at the given indexes. Index numbers start at 0,
+        negative numbers address the end of the list (-1 is the last).
+
+    ``--oacopts-clr``
        Completely empties the options list.

 ``--oafirst``
    Force the audio stream to become the first stream in the output.
-    By default, the order is unspecified. Deprecated.
+    By default, the order is unspecified.

 ``--ovc=<codec>``
-    Specifies the output video codec. See ``--ovc=help`` for a full list of
-    supported codecs.
+    Specifies the output video codec. This can be a comma separated list of
+    possible codecs to try. See ``--ovc=help`` for a full list of supported
+    codecs.

 ``--ovoffset=<value>``
    Shifts video data by the given time (in seconds) by shifting the pts
-    values. Deprecated.
+    values.

-``--ovcopts=<options>``
+``--ovcopts <options>``
    Specifies the output video codec options for libavcodec.
    See --ovcopts=help for a full list of supported options.

@@ -74,18 +117,32 @@ You can encode files from one format/codec to another using this facility.
        ``"--ovc=libx264 --ovcopts=crf=23"``
            selects VBR quality factor 23 for H.264 encoding.

-    This is a key/value list option. See `List Options`_ for details.
+    Options are managed in lists. There are a few commands to manage the
+    options list.

-    ``--ovcopts-add=<option>``
-        Appends the option given as an argument to the options list. (Passing
-        multiple options is currently still possible, but deprecated.)
+    ``--ovcopts-add=<options1[,options2,...]>``
+        Appends the options given as arguments to the options list.

-    ``--ovcopts=""``
+    ``--ovcopts-pre=<options1[,options2,...]>``
+        Prepends the options given as arguments to the options list.
+
+    ``--ovcopts-del=<index1[,index2,...]>``
+        Deletes the options at the given indexes. Index numbers start at 0,
+        negative numbers address the end of the list (-1 is the last).
+
+    ``--ovcopts-clr``
        Completely empties the options list.

 ``--ovfirst``
    Force the video stream to become the first stream in the output.
-    By default, the order is unspecified. Deprecated.
+    By default, the order is unspecified.
+
+``--ocopyts``
+    Copies input pts to the output video (not supported by some output
+    container formats, e.g. AVI). Discontinuities are still fixed.
+    By default, audio pts are set to playback time and video pts are
+    synchronized to match audio pts, as some output formats do not support
+    anything else.

 ``--orawts``
    Copies input pts to the output video (not supported by some output
@@ -93,31 +150,6 @@ You can encode files from one format/codec to another using this facility.
    and all pts are passed through as-is. Never seek backwards or use multiple
    input files in this mode!

-``--no-ocopy-metadata``
+``--no-ometadata``
    Turns off copying of metadata from input files to output files when
    encoding (which is enabled by default).
-
-``--oset-metadata=<metadata-tag[,metadata-tag,...]>``
-    Specifies metadata to include in the output file.
-    Supported keys vary between output formats. For example, Matroska (MKV) and
-    FLAC allow almost arbitrary keys, while support in MP4 and MP3 is more
-    limited.
-
-    This is a key/value list option. See `List Options`_ for details.
-
-    .. admonition:: Example
-
-        "``--oset-metadata=title="Output title",comment="Another tag"``"
-            adds a title and a comment to the output file.
-
-``--oremove-metadata=<metadata-tag[,metadata-tag,...]>``
-    Specifies metadata to exclude from the output file when copying from the
-    input file.
-
-    This is a string list option. See `List Options`_ for details.
-
-    .. admonition:: Example
-
-        "``--oremove-metadata=comment,genre``"
-            excludes copying of the the comment and genre tags to the output
-            file.
@@ -1,10 +1,10 @@
 JSON IPC
 ========

-mpv can be controlled by external programs using the JSON-based IPC protocol.
-It can be enabled by specifying the path to a unix socket or a named pipe using
-the option ``--input-ipc-server``. Clients can connect to this socket and send
-commands to the player or receive events from it.
+mpv can be controlled by external programs using the JSON-based IPC protocol. It
+can be enabled by specifying the path to a unix socket using the option
+``--input-unix-socket``. Clients can connect to this socket and send commands to
+the player or receive events from it.

 .. warning::

@@ -17,12 +17,12 @@ commands to the player or receive events from it.
 Socat example
 -------------

-You can use the ``socat`` tool to send commands (and receive replies) from the
+You can use the ``socat`` tool to send commands (and receive reply) from the
 shell. Assuming mpv was started with:

 ::

-    mpv file.mkv --input-ipc-server=/tmp/mpvsocket
+    mpv file.mkv --input-unix-socket=/tmp/mpvsocket

 Then you can control it using socat:

@@ -41,48 +41,14 @@ It's also possible to send input.conf style text-only commands:

 ::

-    > echo 'show-text ${playback-time}' | socat - /tmp/mpvsocket
+    > echo 'show_text ${playback-time}' | socat - /tmp/mpvsocket

 But you won't get a reply over the socket. (This particular command shows the
 playback time on the player's OSD.)

-Command Prompt example
----------------------
-
-Unfortunately, it's not as easy to test the IPC protocol on Windows, since
-Windows ports of socat (in Cygwin and MSYS2) don't understand named pipes. In
-the absence of a simple tool to send and receive from bidirectional pipes, the
-``echo`` command can be used to send commands, but not receive replies from the
-command prompt.
-
-Assuming mpv was started with:
-
-::
-
-    mpv file.mkv --input-ipc-server=\\.\pipe\mpvsocket
-
-You can send commands from a command prompt:
-
-::
-
-    echo show-text ${playback-time} >\\.\pipe\mpvsocket
-
-To be able to simultaneously read and write from the IPC pipe, like on Linux,
-it's necessary to write an external program that uses overlapped file I/O (or
-some wrapper like .NET's NamedPipeClientStream.)
-
-You can open the pipe in PuTTY as "serial" device. This is not very
-comfortable, but gives a way to test interactively without having to write code.
-
 Protocol
 --------

-The protocol uses UTF-8-only JSON as defined by RFC-8259. Unlike standard JSON,
-"\u" escape sequences are not allowed to construct surrogate pairs. To avoid
-getting conflicts, encode all text characters including and above codepoint
-U+0020 as UTF-8. mpv might output broken UTF-8 in corner cases (see "UTF-8"
-section below).
-
 Clients can execute commands on the player by sending JSON messages of the
 following form:

@@ -116,11 +82,8 @@ can also be present. See `List of events`_ for a list of all supported events.
 Because events can occur at any time, it may be difficult at times to determine
 which response goes with which command. Commands may optionally include a
 ``request_id`` which, if provided in the command request, will be copied
-verbatim into the response. mpv does not interpret the ``request_id`` in any
-way; it is solely for the use of the requester. The only requirement is that
-the ``request_id`` field must be an integer (a number without fractional parts
-in the range ``-2^63..2^63-1``). Using other types is deprecated and will
-currently show a warning. In the future, this will raise an error.
+verbatim into the response. mpv does not intrepret the ``request_id`` in any
+way; it is solely for the use of the requester.

 For example, this request:

@@ -134,85 +97,17 @@ Would generate this response:

    { "error": "success", "data": 1.468135, "request_id": 100 }

-If you don't specify a ``request_id``, command replies will set it to 0.
-
 All commands, replies, and events are separated from each other with a line
 break character (``\n``).

 If the first character (after skipping whitespace) is not ``{``, the command
 will be interpreted as non-JSON text command, as they are used in input.conf
-(or ``mpv_command_string()`` in the client API). Additionally, lines starting
+(or ``mpv_command_string()`` in the client API). Additionally, line starting
 with ``#`` and empty lines are ignored.

 Currently, embedded 0 bytes terminate the current line, but you should not
 rely on this.

-Data flow
---------
-
-Currently, the mpv-side IPC implementation does not service the socket while a
-command is executed and the reply is written. It is for example not possible
-that other events, that happened during the execution of the command, are
-written to the socket before the reply is written.
-
-This might change in the future. The only guarantee is that replies to IPC
-messages are sent in sequence.
-
-Also, since socket I/O is inherently asynchronous, it is possible that you read
-unrelated event messages from the socket, before you read the reply to the
-previous command you sent. In this case, these events were queued by the mpv
-side before it read and started processing your command message.
-
-If the mpv-side IPC implementation switches away from blocking writes and
-blocking command execution, it may attempt to send events at any time.
-
-You can also use asynchronous commands, which can return in any order, and
-which do not block IPC protocol interaction at all while the command is
-executed in the background.
-
-Asynchronous commands
---------------------
-
-Command can be run asynchronously. This behaves exactly as with normal command
-execution, except that execution is not blocking. Other commands can be sent
-while it's executing, and command completion can be arbitrarily reordered.
-
-The ``async`` field controls this. If present, it must be a boolean. If missing,
-``false`` is assumed.
-
-For example, this initiates an asynchronous command:
-
-::
-
-    { "command": ["screenshot"], "request_id": 123, "async": true }
-
-And this is the completion:
-
-::
-
-    {"request_id":123,"error":"success","data":null}
-
-By design, you will not get a confirmation that the command was started. If a
-command is long running, sending the message will lead to any reply until much
-later when the command finishes.
-
-Some commands execute synchronously, but these will behave like asynchronous
-commands that finished execution immediately.
-
-Cancellation of asynchronous commands is available in the libmpv API, but has
-not yet been implemented in the IPC protocol.
-
-Commands with named arguments
-----------------------------
-
-If the ``command`` field is a JSON object, named arguments are expected. This
-is described in the C API ``mpv_command_node()`` documentation (the
-``MPV_FORMAT_NODE_MAP`` case). In some cases, this may make commands more
-readable, while some obscure commands basically require using named arguments.
-
-Currently, only "proper" commands (as listed by `List of Input Commands`_)
-support named arguments.
-
 Commands
 --------

@@ -260,7 +155,14 @@ extra commands can also be used as part of the protocol:
        { "error": "success" }

 ``set_property_string``
-    Alias for ``set_property``. Both commands accept native values and strings.
+    Like ``set_property``, but the argument value must be passed as string.
+
+    Example:
+
+    ::
+
+        { "command": ["set_property_string", "pause", "yes"] }
+        { "error": "success" }

 ``observe_property``
    Watch a property for changes. If the given property is changed, then an
@@ -274,14 +176,6 @@ extra commands can also be used as part of the protocol:
        { "error": "success" }
        { "event": "property-change", "id": 1, "data": 52.0, "name": "volume" }

-    .. warning::
-
-        If the connection is closed, the IPC client is destroyed internally,
-        and the observed properties are unregistered. This happens for example
-        when sending commands to a socket with separate ``socat`` invocations.
-        This can make it seem like property observation does not work. You must
-        keep the IPC connection open to make it work.
-
 ``observe_property_string``
    Like ``observe_property``, but the resulting data will always be a string.

@@ -322,6 +216,16 @@ extra commands can also be used as part of the protocol:
    By default, most events are enabled, and there is not much use for this
    command.

+``suspend``
+    Suspend the mpv main loop. There is a long-winded explanation of this in
+    the C API function ``mpv_suspend()``. In short, this prevents the player
+    from displaying the next video frame, so that you don't get blocked when
+    trying to access the player.
+
+``resume``
+    Undo one ``suspend`` call. ``suspend`` increments an internal counter, and
+    ``resume`` decrements it. When 0 is reached, the player is actually resumed.
+
 ``get_version``
    Returns the client API version the C API of the remote mpv instance
    provides.
@@ -338,50 +242,4 @@ sometimes sends invalid JSON. If that is a problem for the client application's
 parser, it should filter the raw data for invalid UTF-8 sequences and perform
 the desired replacement, before feeding the data to its JSON parser.

-mpv will not attempt to construct invalid UTF-8 with broken "\u" escape
-sequences. This includes surrogate pairs.
-
-JSON extensions
---------------
-
-The following non-standard extensions are supported:
-
-    - a list or object item can have a trailing ","
-    - object syntax accepts "=" in addition of ":"
-    - object keys can be unquoted, if they start with a character in "A-Za-z\_"
-      and contain only characters in "A-Za-z0-9\_"
-    - byte escapes with "\xAB" are allowed (with AB being a 2 digit hex number)
-
-Example:
-
-::
-
-    { objkey = "value\x0A" }
-
-Is equivalent to:
-
-::
-
-    { "objkey": "value\n" }
-
-Alternative ways of starting clients
------------------------------------
-
-You can create an anonymous IPC connection without having to set
-``--input-ipc-server``. This is achieved through a mpv pseudo scripting backend
-that starts processes.
-
-You can put ``.run`` file extension in the mpv scripts directory in its  config
-directory (see the `FILES`_ section for details), or load them through other
-means (see `Script location`_). These scripts are simply executed with the OS
-native mechanism (as if you ran them in the shell). They must have a proper
-shebang and have the executable bit set.
-
-When executed, a socket (the IPC connection) is passed to them through file
-descriptor inheritance. The file descriptor is indicated as the special command
-line argument ``--mpv-ipc-fd=N``, where ``N`` is the numeric file descriptor.
-
-The rest is the same as with a normal ``--input-ipc-server`` IPC connection. mpv
-does not attempt to observe or other interact with the started script process.
-
-This does not work in Windows yet.
+mpv will not attempt to construct invalid UTF-8 with broken escape sequences.
@@ -1,396 +0,0 @@
-JAVASCRIPT
-==========
-
-JavaScript support in mpv is near identical to its Lua support. Use this section
-as reference on differences and availability of APIs, but otherwise you should
-refer to the Lua documentation for API details and general scripting in mpv.
-
-Example
-------
-
-JavaScript code which leaves fullscreen mode when the player is paused:
-
-::
-
-    function on_pause_change(name, value) {
-        if (value == true)
-            mp.set_property("fullscreen", "no");
-    }
-    mp.observe_property("pause", "bool", on_pause_change);
-
-
-Similarities with Lua
---------------------
-
-mpv tries to load a script file as JavaScript if it has a ``.js`` extension, but
-otherwise, the documented Lua options, script directories, loading, etc apply to
-JavaScript files too.
-
-Script initialization and lifecycle is the same as with Lua, and most of the Lua
-functions at the modules ``mp``, ``mp.utils``, ``mp.msg`` and ``mp.options`` are
-available to JavaScript with identical APIs - including running commands,
-getting/setting properties, registering events/key-bindings/hooks, etc.
-
-Differences from Lua
--------------------
-
-No need to load modules. ``mp``, ``mp.utils``,  ``mp.msg`` and ``mp.options``
-are preloaded, and you can use e.g. ``var cwd = mp.utils.getcwd();`` without
-prior setup.
-
-Errors are slightly different. Where the Lua APIs return ``nil`` for error,
-the JavaScript ones return ``undefined``. Where Lua returns ``something, error``
-JavaScript returns only ``something`` - and makes ``error`` available via
-``mp.last_error()``. Note that only some of the functions have this additional
-``error`` value - typically the same ones which have it in Lua.
-
-Standard APIs are preferred. For instance ``setTimeout`` and ``JSON.stringify``
-are available, but ``mp.add_timeout`` and ``mp.utils.format_json`` are not.
-
-No standard library. This means that interaction with anything outside of mpv is
-limited to the available APIs, typically via ``mp.utils``. However, some file
-functions were added, and CommonJS ``require`` is available too - where the
-loaded modules have the same privileges as normal scripts.
-
-Language features - ECMAScript 5
--------------------------------
-
-The scripting backend which mpv currently uses is MuJS - a compatible minimal
-ES5 interpreter. As such, ``String.substring`` is implemented for instance,
-while the common but non-standard ``String.substr`` is not. Please consult the
-MuJS pages on language features and platform support - https://mujs.com .
-
-Unsupported Lua APIs and their JS alternatives
----------------------------------------------
-
-``mp.add_timeout(seconds, fn)``  JS: ``id = setTimeout(fn, ms)``
-
-``mp.add_periodic_timer(seconds, fn)``  JS: ``id = setInterval(fn, ms)``
-
-``utils.parse_json(str [, trail])``  JS: ``JSON.parse(str)``
-
-``utils.format_json(v)``  JS: ``JSON.stringify(v)``
-
-``utils.to_string(v)``  see ``dump`` below.
-
-``mp.get_next_timeout()`` see event loop below.
-
-``mp.dispatch_events([allow_wait])`` see event loop below.
-
-Scripting APIs - identical to Lua
---------------------------------
-
-(LE) - Last-Error, indicates that ``mp.last_error()`` can be used after the
-call to test for success (empty string) or failure (non empty reason string).
-Where the Lua APIs use ``nil`` to indicate error, JS APIs use ``undefined``.
-
-``mp.command(string)`` (LE)
-
-``mp.commandv(arg1, arg2, ...)`` (LE)
-
-``mp.command_native(table [,def])`` (LE)
-
-``id = mp.command_native_async(table [,fn])`` (LE) Notes: ``id`` is true-thy on
-success, ``error`` is empty string on success.
-
-``mp.abort_async_command(id)``
-
-``mp.get_property(name [,def])`` (LE)
-
-``mp.get_property_osd(name [,def])`` (LE)
-
-``mp.get_property_bool(name [,def])`` (LE)
-
-``mp.get_property_number(name [,def])`` (LE)
-
-``mp.get_property_native(name [,def])`` (LE)
-
-``mp.set_property(name, value)`` (LE)
-
-``mp.set_property_bool(name, value)`` (LE)
-
-``mp.set_property_number(name, value)`` (LE)
-
-``mp.set_property_native(name, value)`` (LE)
-
-``mp.get_time()``
-
-``mp.add_key_binding(key, name|fn [,fn [,flags]])``
-
-``mp.add_forced_key_binding(...)``
-
-``mp.remove_key_binding(name)``
-
-``mp.register_event(name, fn)``
-
-``mp.unregister_event(fn)``
-
-``mp.observe_property(name, type, fn)``
-
-``mp.unobserve_property(fn)``
-
-``mp.get_opt(key)``
-
-``mp.get_script_name()``
-
-``mp.get_script_directory()``
-
-``mp.osd_message(text [,duration])``
-
-``mp.get_wakeup_pipe()``
-
-``mp.register_idle(fn)``
-
-``mp.unregister_idle(fn)``
-
-``mp.enable_messages(level)``
-
-``mp.register_script_message(name, fn)``
-
-``mp.unregister_script_message(name)``
-
-``mp.create_osd_overlay(format)``
-
-``mp.get_osd_size()``  (returned object has properties: width, height, aspect)
-
-``mp.msg.log(level, ...)``
-
-``mp.msg.fatal(...)``
-
-``mp.msg.error(...)``
-
-``mp.msg.warn(...)``
-
-``mp.msg.info(...)``
-
-``mp.msg.verbose(...)``
-
-``mp.msg.debug(...)``
-
-``mp.msg.trace(...)``
-
-``mp.utils.getcwd()`` (LE)
-
-``mp.utils.readdir(path [, filter])`` (LE)
-
-``mp.utils.file_info(path)`` (LE) Note: like lua - this does NOT expand
-meta-paths like ``~~/foo`` (other JS file functions do expand meta paths).
-
-``mp.utils.split_path(path)``
-
-``mp.utils.join_path(p1, p2)``
-
-``mp.utils.subprocess(t)``
-
-``mp.utils.subprocess_detached(t)``
-
-``mp.utils.get_env_list()``
-
-``mp.utils.getpid()`` (LE)
-
-``mp.add_hook(type, priority, fn(hook))``
-
-``mp.options.read_options(obj [, identifier [, on_update]])`` (types:
-string/boolean/number)
-
-Additional utilities
--------------------
-
-``mp.last_error()``
-    If used after an API call which updates last error, returns an empty string
-    if the API call succeeded, or a non-empty error reason string otherwise.
-
-``Error.stack`` (string)
-    When using ``try { ... } catch(e) { ... }``, then ``e.stack`` is the stack
-    trace of the error - if it was created using the ``Error(...)`` constructor.
-
-``print`` (global)
-    A convenient alias to ``mp.msg.info``.
-
-``dump`` (global)
-    Like ``print`` but also expands objects and arrays recursively.
-
-``mp.utils.getenv(name)``
-    Returns the value of the host environment variable ``name``, or
-    ``undefined`` if the variable is not defined.
-
-``mp.utils.get_user_path(path)``
-    Trivial wrapper of the ``expand-path`` mpv command, returns a string.
-    ``read_file``, ``write_file``, ``append_file`` and ``require`` already
-    expand the path internally and accept mpv meta-paths like ``~~desktop/foo``.
-
-``mp.utils.read_file(fname [,max])``
-    Returns the content of file ``fname`` as string. If ``max`` is provided and
-    not negative, limit the read to ``max`` bytes.
-
-``mp.utils.write_file(fname, str)``
-    (Over)write file ``fname`` with text content ``str``. ``fname`` must be
-    prefixed with ``file://`` as simple protection against accidental arguments
-    switch, e.g. ``mp.utils.write_file("file://~/abc.txt", "hello world")``.
-
-``mp.utils.append_file(fname, str)``
-    Same as ``mp.utils.write_file`` if the file ``fname`` does not exist. If it
-    does exist then append instead of overwrite.
-
-Note: ``read_file``, ``write_file`` and ``append_file`` throw on errors, allow
-text content only.
-
-``mp.get_time_ms()``
-    Same as ``mp.get_time()`` but in ms instead of seconds.
-
-``mp.get_script_file()``
-    Returns the file name of the current script.
-
-``exit()`` (global)
-    Make the script exit at the end of the current event loop iteration.
-    Note: please remove added key bindings before calling ``exit()``.
-
-``mp.utils.compile_js(fname, content_str)``
-    Compiles the JS code ``content_str`` as file name ``fname`` (without loading
-    anything from the filesystem), and returns it as a function. Very similar
-    to a ``Function`` constructor, but shows at stack traces as ``fname``.
-
-``mp.module_paths``
-    Global modules search paths array for the ``require`` function (see below).
-
-Timers (global)
---------------
-
-The standard HTML/node.js timers are available:
-
-``id = setTimeout(fn [,duration [,arg1 [,arg2...]]])``
-
-``id = setTimeout(code_string [,duration])``
-
-``clearTimeout(id)``
-
-``id = setInterval(fn [,duration [,arg1 [,arg2...]]])``
-
-``id = setInterval(code_string [,duration])``
-
-``clearInterval(id)``
-
-``setTimeout`` and ``setInterval`` return id, and later call ``fn`` (or execute
-``code_string``) after ``duration`` ms. Interval also repeat every ``duration``.
-
-``duration`` has a minimum and default value of 0, ``code_string`` is
-a plain string which is evaluated as JS code, and ``[,arg1 [,arg2..]]`` are used
-as arguments (if provided) when calling back ``fn``.
-
-The ``clear...(id)`` functions cancel timer ``id``, and are irreversible.
-
-Note: timers always call back asynchronously, e.g. ``setTimeout(fn)`` will never
-call ``fn`` before returning. ``fn`` will be called either at the end of this
-event loop iteration or at a later event loop iteration. This is true also for
-intervals - which also never call back twice at the same event loop iteration.
-
-Additionally, timers are processed after the event queue is empty, so it's valid
-to use ``setTimeout(fn)`` as a one-time idle observer.
-
-CommonJS modules and ``require(id)``
------------------------------------
-
-CommonJS Modules are a standard system where scripts can export common functions
-for use by other scripts. Specifically, a module is a script which adds
-properties (functions, etc) to its pre-existing ``exports`` object, which
-another script can access with ``require(module-id)``. This runs the module and
-returns its ``exports`` object. Further calls to ``require`` for the same module
-will return its cached ``exports`` object without running the module again.
-
-Modules and ``require`` are supported, standard compliant, and generally similar
-to node.js. However, most node.js modules won't run due to missing modules such
-as ``fs``, ``process``, etc, but some node.js modules with minimal dependencies
-do work. In general, this is for mpv modules and not a node.js replacement.
-
-A ``.js`` file extension is always added to ``id``, e.g. ``require("./foo")``
-will load the file ``./foo.js`` and return its ``exports`` object.
-
-An id which starts with ``./`` or ``../`` is relative to the script or module
-which ``require`` it. Otherwise it's considered a top-level id (CommonJS term).
-
-Top-level id is evaluated as absolute filesystem path if possible, e.g. ``/x/y``
-or ``~/x``. Otherwise it's considered a global module id and searched according
-to ``mp.module_paths`` in normal array order, e.g. ``require("x")`` tries to
-load ``x.js`` at one of the array paths, and id ``foo/x`` tries to load ``x.js``
-inside dir ``foo`` at one of the paths.
-
-The ``mp.module_paths`` array is empty by default except for scripts which are
-loaded as a directory where it contains one item - ``<directory>/modules/`` .
-The array may be updated from a script (or using custom init - see below) which
-will affect future calls to ``require`` for global module id's which are not
-already loaded/cached.
-
-No ``global`` variable, but a module's ``this`` at its top lexical scope is the
-global object - also in strict mode. If you have a module which needs ``global``
-as the global object, you could do ``this.global = this;`` before ``require``.
-
-Functions and variables declared at a module don't pollute the global object.
-
-Custom initialization
---------------------
-
-After mpv initializes the JavaScript environment for a script but before it
-loads the script - it tries to run the file ``init.js`` at the root of the mpv
-configuration directory. Code at this file can update the environment further
-for all scripts. E.g. if it contains ``mp.module_paths.push("/foo")`` then
-``require`` at all scripts will search global module id's also at ``/foo``
-(do NOT do ``mp.module_paths = ["/foo"];`` because this will remove existing
-paths - like ``<script-dir>/modules`` for scripts which load from a directory).
-
-The custom-init file is ignored if mpv is invoked with ``--no-config``.
-
-Before mpv 0.34, the file name was ``.init.js`` (with dot) at the same dir.
-
-The event loop
--------------
-
-The event loop poll/dispatch mpv events as long as the queue is not empty, then
-processes the timers, then waits for the next event, and repeats this forever.
-
-You could put this code at your script to replace the built-in event loop, and
-also print every event which mpv sends to your script:
-
-::
-
-    function mp_event_loop() {
-        var wait = 0;
-        do {
-            var e = mp.wait_event(wait);
-            dump(e);  // there could be a lot of prints...
-            if (e.event != "none") {
-                mp.dispatch_event(e);
-                wait = 0;
-            } else {
-                wait = mp.process_timers() / 1000;
-                if (wait != 0) {
-                    mp.notify_idle_observers();
-                    wait = mp.peek_timers_wait() / 1000;
-                }
-            }
-        } while (mp.keep_running);
-    }
-
-
-``mp_event_loop`` is a name which mpv tries to call after the script loads.
-The internal implementation is similar to this (without ``dump`` though..).
-
-``e = mp.wait_event(wait)`` returns when the next mpv event arrives, or after
-``wait`` seconds if positive and no mpv events arrived. ``wait`` value of 0
-returns immediately (with ``e.event == "none"`` if the queue is empty).
-
-``mp.dispatch_event(e)`` calls back the handlers registered for ``e.event``,
-if there are such (event handlers, property observers, script messages, etc).
-
-``mp.process_timers()`` calls back the already-added, non-canceled due timers,
-and returns the duration in ms till the next due timer (possibly 0), or -1 if
-there are no pending timers. Must not be called recursively.
-
-``mp.notify_idle_observers()`` calls back the idle observers, which we do when
-we're about to sleep (wait != 0), but the observers may add timers or take
-non-negligible duration to complete, so we re-calculate ``wait`` afterwards.
-
-``mp.peek_timers_wait()`` returns the same values as ``mp.process_timers()``
-but without doing anything. Invalid result if called from a timer callback.
-
-Note: ``exit()`` is also registered for the ``shutdown`` event, and its
-implementation is a simple ``mp.keep_running = false``.
@@ -1,75 +0,0 @@
-EMBEDDING INTO OTHER PROGRAMS (LIBMPV)
-======================================
-
-mpv can be embedded into other programs as video/audio playback backend. The
-recommended way to do so is using libmpv. See ``libmpv/client.h`` in the mpv
-source code repository. This provides a C API. Bindings for other languages
-might be available (see wiki).
-
-Since libmpv merely allows access to underlying mechanisms that can control
-mpv, further documentation is spread over a few places:
-
- https://github.com/mpv-player/mpv/blob/master/libmpv/client.h
- https://mpv.io/manual/master/#options
- https://mpv.io/manual/master/#list-of-input-commands
- https://mpv.io/manual/master/#properties
- https://github.com/mpv-player/mpv-examples/tree/master/libmpv
-
-C PLUGINS
-=========
-
-You can write C plugins for mpv. These use the libmpv API, although they do not
-use the libmpv library itself.
-
-They are available on Linux/BSD platforms only and enabled by default if the
-compiler supports linking with the ``-rdynamic`` flag.
-
-C plugins location
------------------
-
-C plugins are put into the mpv scripts directory in its config directory
-(see the `FILES`_ section for details). They must have a ``.so`` file extension.
-They can also be explicitly loaded with the ``--script`` option.
-
-API
---
-
-A C plugin must export the following function::
-
-    int mpv_open_cplugin(mpv_handle *handle)
-
-The plugin function will be called on loading time. This function does not
-return as long as your plugin is loaded (it runs in its own thread). The
-``handle`` will be deallocated as soon as the plugin function returns.
-
-The return value is interpreted as error status. A value of ``0`` is
-interpreted as success, while ``-1`` signals an error. In the latter case,
-the player prints an uninformative error message that loading failed.
-
-Return values other than ``0`` and ``-1`` are reserved, and trigger undefined
-behavior.
-
-Within the plugin function, you can call libmpv API functions. The ``handle``
-is created by ``mpv_create_client()`` (or actually an internal equivalent),
-and belongs to you. You can call ``mpv_wait_event()`` to wait for things
-happening, and so on.
-
-Note that the player might block until your plugin calls ``mpv_wait_event()``
-for the first time. This gives you a chance to install initial hooks etc.
-before playback begins.
-
-The details are quite similar to Lua scripts.
-
-Linkage to libmpv
-----------------
-
-The current implementation requires that your plugins are **not** linked against
-libmpv. What your plugins use are not symbols from a libmpv binary, but
-symbols from the mpv host binary.
-
-Examples
--------
-
-See:
-
- https://github.com/mpv-player/mpv-examples/tree/master/cplugins
@@ -1,7 +1,12 @@
 LUA SCRIPTING
 =============

-mpv can load Lua scripts. (See `Script location`_.)
+mpv can load Lua scripts. Scripts passed to the ``--script`` option, or found in
+the ``scripts`` subdirectory of the mpv configuration directory (usually
+``~/.config/mpv/scripts/``) will be loaded on program start. mpv also appends the
+``scripts`` subdirectory to the end of Lua's path so you can import scripts from
+there too. Since it's added to the end, don't name scripts you want to import
+the same as Lua libraries because they will be overshadowed by them.

 mpv provides the built-in module ``mp``, which contains functions to send
 commands to the mpv core and to retrieve information about playback state, user
@@ -25,55 +30,6 @@ A script which leaves fullscreen mode when the player is paused:
    mp.observe_property("pause", "bool", on_pause_change)


-Script location
---------------
-
-Scripts can be passed to the ``--script`` option, and are automatically loaded
-from the ``scripts`` subdirectory of the mpv configuration directory (usually
-``~/.config/mpv/scripts/``).
-
-A script can be a single file. The file extension is used to select the
-scripting backend to use for it. For Lua, it is ``.lua``. If the extension is
-not recognized, an error is printed. (If an error happens, the extension is
-either mistyped, or the backend was not compiled into your mpv binary.)
-
-mpv internally loads the script's name by stripping the ``.lua`` extension and
-replacing all nonalphanumeric characters with ``_``. E.g., ``my-tools.lua``
-becomes ``my_tools``. If there are several scripts with the same name, it is
-made unique by appending a number. This is the name returned by
-``mp.get_script_name()``.
-
-Entries with ``.disable`` extension are always ignored.
-
-If a script is a directory (either if a directory is passed to ``--script``,
-or any sub-directories in the script directory, such as for example
-``~/.config/mpv/scripts/something/``), then the directory represents a single
-script. The player will try to load a file named ``main.x``, where ``x`` is
-replaced with the file extension. For example, if ``main.lua`` exists, it is
-loaded with the Lua scripting backend.
-
-You must not put any other files or directories that start with ``main.`` into
-the script's top level directory. If the script directory contains for example
-both ``main.lua`` and ``main.js``, only one of them will be loaded (and which
-one depends on mpv internals that may change any time). Likewise, if there is
-for example ``main.foo``, your script will break as soon as mpv adds a backend
-that uses the ``.foo`` file extension.
-
-mpv also appends the top level directory of the script to the start of Lua's
-package path so you can import scripts from there too. Be aware that this will
-shadow Lua libraries that use the same package path. (Single file scripts do not
-include mpv specific directory the Lua package path. This was silently changed
-in mpv 0.32.0.)
-
-Using a script directory is the recommended way to package a script that
-consists of multiple source files, or requires other files (you can use
-``mp.get_script_directory()`` to get the location and e.g. load data files).
-
-Making a script a git repository, basically a repository which contains a
-``main.lua``` file in the root directory, makes scripts easily updateable
-(without the dangers of auto-updates). Another suggestion is to use git
-submodules to share common files or libraries.
-
 Details on the script initialization and lifecycle
 --------------------------------------------------

@@ -83,15 +39,13 @@ option. Some scripts are loaded internally (like ``--osc``). Each script runs in
 its own thread. Your script is first run "as is", and once that is done, the event loop
 is entered. This event loop will dispatch events received by mpv and call your
 own event handlers which you have registered with ``mp.register_event``, or
-timers added with ``mp.add_timeout`` or similar. Note that since the
-script starts execution concurrently with player initialization, some properties
-may not be populated with meaningful values until the relevant subsystems have
-initialized.
+timers added with ``mp.add_timeout`` or similar.

 When the player quits, all scripts will be asked to terminate. This happens via
 a ``shutdown`` event, which by default will make the event loop return. If your
-script got into an endless loop, mpv will probably behave fine during playback,
-but it won't terminate when quitting, because it's waiting on your script.
+script got into an endless loop, mpv will probably behave fine during playback
+(unless the player is suspended, see ``mp.suspend``), but it won't terminate
+when quitting, because it's waiting on your script.

 Internally, the C code will call the Lua function ``mp_event_loop`` after
 loading a Lua script. This function is normally defined by the default prelude
@@ -107,10 +61,7 @@ the player will more or less hang until the script returns from the main chunk
 (and ``mp_event_loop`` is called), or the script calls ``mp_event_loop`` or
 ``mp.dispatch_events`` directly. This is done to make it possible for a script
 to fully setup event handlers etc. before playback actually starts. In older
-mpv versions, this happened asynchronously. With mpv 0.29.0, this changes
-slightly, and it merely waits for scripts to be loaded in this manner before
-starting playback as part of the player initialization phase. Scripts run though
-initialization in parallel. This might change again.
+mpv versions, this happened asynchronously.

 mp functions
 ------------
@@ -153,52 +104,12 @@ The ``mp`` module is preloaded, although it can be loaded manually with
 ``mp.command_native(table [,def])``
    Similar to ``mp.commandv``, but pass the argument list as table. This has
    the advantage that in at least some cases, arguments can be passed as
-    native types. It also allows you to use named argument.
-
-    If the table is an array, each array item is like an argument in
-    ``mp.commandv()`` (but can be a native type instead of a string).
-
-    If the table contains string keys, it's interpreted as command with named
-    arguments. This requires at least an entry with the key ``name`` to be
-    present, which must be a string, and contains the command name. The special
-    entry ``_flags`` is optional, and if present, must be an array of
-    `Input Command Prefixes`_ to apply. All other entries are interpreted as
-    arguments.
+    native types.

    Returns a result table on success (usually empty), or ``def, error`` on
    error. ``def`` is the second parameter provided to the function, and is
    nil if it's missing.

-``mp.command_native_async(table [,fn])``
-    Like ``mp.command_native()``, but the command is ran asynchronously (as far
-    as possible), and upon completion, fn is called. fn has three arguments:
-    ``fn(success, result, error)``:
-
-         ``success``
-            Always a Boolean and is true if the command was successful,
-            otherwise false.
-
-        ``result``
-            The result value (can be nil) in case of success, nil otherwise (as
-            returned by ``mp.command_native()``).
-
-        ``error``
-            The error string in case of an error, nil otherwise.
-
-    Returns a table with undefined contents, which can be used as argument for
-    ``mp.abort_async_command``.
-
-    If starting the command failed for some reason, ``nil, error`` is returned,
-    and ``fn`` is called indicating failure, using the same error value.
-
-    ``fn`` is always called asynchronously, even if the command failed to start.
-
-``mp.abort_async_command(t)``
-    Abort a ``mp.command_native_async`` call. The argument is the return value
-    of that command (which starts asynchronous execution of the command).
-    Whether this works and how long it takes depends on the command and the
-    situation. The abort call itself is asynchronous. Does not return anything.
-
 ``mp.get_property(name [,def])``
    Return the value of the given property as string. These are the same
    properties as used in input.conf. See `Properties`_ for a list of
@@ -264,7 +175,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with
    Similar to ``mp.set_property``, but set the given property using its native
    type.

-    Since there are several data types which cannot represented natively in
+    Since there are several data types which can not represented natively in
    Lua, this might not always work as expected. For example, while the Lua
    wrapper can do some guesswork to decide whether a Lua table is an array
    or a map, this would fail with empty tables. Also, there are not many
@@ -281,8 +192,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with
    Register callback to be run on a key binding. The binding will be mapped to
    the given ``key``, which is a string describing the physical key. This uses
    the same key names as in input.conf, and also allows combinations
-    (e.g. ``ctrl+a``). If the key is empty or ``nil``, no physical key is
-    registered, but the user still can create own bindings (see below).
+    (e.g. ``ctrl+a``).

    After calling this function, key presses will cause the function ``fn`` to
    be called (unless the user remapped the key with another binding).
@@ -293,9 +203,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with
    an example). The name should be unique across other bindings in the same
    script - if not, the previous binding with the same name will be
    overwritten. You can omit the name, in which case a random name is generated
-    internally. (Omitting works as follows: either pass ``nil`` for ``name``,
-    or pass the ``fn`` argument in place of the name. The latter is not
-    recommended and is handled for compatibility only.)
+    internally.

    The last argument is used for optional flags. This is a table, which can
    have the following entries:
@@ -306,25 +214,11 @@ The ``mp`` module is preloaded, although it can be loaded manually with
        ``complex``
            If set to ``true``, then ``fn`` is called on both key up and down
            events (as well as key repeat, if enabled), with the first
-            argument being a table. This table has the following entries (and
-            may contain undocumented ones):
-
-                ``event``
-                    Set to one of the strings ``down``, ``repeat``, ``up`` or
-                    ``press`` (the latter if key up/down can't be tracked).
-
-                ``is_mouse``
-                    Boolean Whether the event was caused by a mouse button.
-
-                ``key_name``
-                    The name of they key that triggered this, or ``nil`` if
-                    invoked artificially. If the key name is unknown, it's an
-                    empty string.
-
-                ``key_text``
-                    Text if triggered by a text key, otherwise ``nil``. See
-                    description of ``script-binding`` command for details (this
-                    field is equivalent to the 5th argument).
+            argument being a table. This table has an ``event`` entry, which
+            is set to one of the strings ``down``, ``repeat``, ``up`` or
+            ``press`` (the latter if key up/down can't be tracked). It further
+            has an ``is_mouse`` entry, which tells whether the event was caused
+            by a mouse button.

    Internally, key bindings are dispatched via the ``script-message-to`` or
    ``script-binding`` input commands and ``mp.register_script_message``.
@@ -346,7 +240,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with
    This will print the message ``the key was pressed`` when ``x`` was pressed.

    The user can remap these key bindings. Then the user has to put the
-    following into their input.conf to remap the command to the ``y`` key:
+    following into his input.conf to remap the command to the ``y`` key:

    ::

@@ -361,11 +255,11 @@ The ``mp`` module is preloaded, although it can be loaded manually with

    ::

-        y script-binding fooscript/something
+        y script-binding fooscript.something

 ``mp.add_forced_key_binding(...)``
    This works almost the same as ``mp.add_key_binding``, but registers the
-    key binding in a way that will overwrite the user's custom bindings in their
+    key binding in a way that will overwrite the user's custom bindings in his
    input.conf. (``mp.add_key_binding`` overwrites default key bindings only,
    but not those by the user's input.conf.)

@@ -412,21 +306,13 @@ The ``mp`` module is preloaded, although it can be loaded manually with
    of times in a row, only the last change triggers the change function. (The
    exact behavior depends on timing and other things.)

-    If a property is unavailable, or on error, the value argument to ``fn`` is
-    ``nil``. (The ``observe_property()`` call always succeeds, even if a
-    property does not exist.)
-
    In some cases the function is not called even if the property changes.
-    This depends on the property, and it's a valid feature request to ask for
-    better update handling of a specific property.
+    Whether this can happen depends on the property.

    If the ``type`` is ``none`` or ``nil``, sporadic property change events are
    possible. This means the change function ``fn`` can be called even if the
    property doesn't actually change.

-    You always get an initial change notification. This is meant to initialize
-    the user's state to the current value of the property.
-
 ``mp.unobserve_property(fn)``
    Undo ``mp.observe_property(..., fn)``. This removes all property handlers
    that are equal to the ``fn`` parameter. This uses normal Lua ``==``
@@ -463,10 +349,6 @@ The ``mp`` module is preloaded, although it can be loaded manually with
            with ``add_timeout()``), this starts the timer from the beginning,
            using the initially configured timeout.

-        ``is_enabled()``
-            Whether the timer is currently enabled or was previously disabled
-            (e.g. by ``stop()`` or ``kill()``).
-
        ``timeout`` (RW)
            This field contains the current timeout period. This value is not
            updated as time progresses. It's only used to calculate when the
@@ -481,8 +363,8 @@ The ``mp`` module is preloaded, although it can be loaded manually with
            (``true``). This value is used when the timer expires (but before
            the timer callback function fn is run).

-    Note that these are methods, and you have to call them using ``:`` instead
-    of ``.`` (Refer to https://www.lua.org/manual/5.2/manual.html#3.4.9 .)
+    Note that these are method, and you have to call them using ``:`` instead
+    of ``.`` (Refer to http://www.lua.org/manual/5.2/manual.html#3.4.9 .)

    Example:

@@ -508,16 +390,11 @@ The ``mp`` module is preloaded, although it can be loaded manually with
    Return the name of the current script. The name is usually made of the
    filename of the script, with directory and file extension removed. If
    there are several scripts which would have the same name, it's made unique
-    by appending a number. Any nonalphanumeric characters are replaced with ``_``.
+    by appending a number.

    .. admonition:: Example

-        The script ``/path/to/foo-script.lua`` becomes ``foo_script``.
-
-``mp.get_script_directory()``
-    Return the directory if this is a script packaged as directory (see
-    `Script location`_ for a description). Return nothing if this is a single
-    file script.
+        The script ``/path/to/fooscript.lua`` becomes ``fooscript``.

 ``mp.osd_message(text [,duration])``
    Show an OSD message on the screen. ``duration`` is in seconds, and is
@@ -529,9 +406,30 @@ Advanced mp functions
 These also live in the ``mp`` module, but are documented separately as they
 are useful only in special situations.

+``mp.suspend()``
+    Suspend the mpv main loop. There is a long-winded explanation of this in
+    the C API function ``mpv_suspend()``. In short, this prevents the player
+    from displaying the next video frame, so that you don't get blocked when
+    trying to access the player.
+
+    This is automatically called by the event handler.
+
+``mp.resume()``
+    Undo one ``mp.suspend()`` call. ``mp.suspend()`` increments an internal
+    counter, and ``mp.resume()`` decrements it. When 0 is reached, the player
+    is actually resumed.
+
+``mp.resume_all()``
+    This resets the internal suspend counter and resumes the player. (It's
+    like calling ``mp.resume()`` until the player is actually resumed.)
+
+    You might want to call this if you're about to do something that takes a
+    long time, but doesn't really need access to the player (like a network
+    operation). Note that you still can access the player at any time.
+
 ``mp.get_wakeup_pipe()``
    Calls ``mpv_get_wakeup_pipe()`` and returns the read end of the wakeup
-    pipe. This is deprecated, but still works. (See ``client.h`` for details.)
+    pipe. (See ``client.h`` for details.)

 ``mp.get_next_timeout()``
    Return the relative time in seconds when the next timer (``mp.add_timeout``
@@ -551,17 +449,7 @@ are useful only in special situations.
    ``mp.get_wakeup_pipe()`` if you're interested in properly working
    notification of new events and working timers.

-``mp.register_idle(fn)``
-    Register an event loop idle handler. Idle handlers are called before the
-    script goes to sleep after handling all new events. This can be used for
-    example to delay processing of property change events: if you're observing
-    multiple properties at once, you might not want to act on each property
-    change, but only when all change notifications have been received.
-
-``mp.unregister_idle(fn)``
-    Undo ``mp.register_idle(fn)``. This removes all idle handlers that
-    are equal to the ``fn`` parameter. This uses normal Lua ``==`` comparison,
-    so be careful when dealing with closures.
+    This function calls ``mp.suspend()`` and ``mp.resume_all()`` on its own.

 ``mp.enable_messages(level)``
    Set the minimum log level of which mpv message output to receive. These
@@ -571,9 +459,9 @@ are useful only in special situations.
    The level is a string, see ``msg.log`` for allowed log levels.

 ``mp.register_script_message(name, fn)``
-    This is a helper to dispatch ``script-message`` or ``script-message-to``
-    invocations to Lua functions. ``fn`` is called if ``script-message`` or
-    ``script-message-to`` (with this script as destination) is run
+    This is a helper to dispatch ``script_message`` or ``script_message_to``
+    invocations to Lua functions. ``fn`` is called if ``script_message`` or
+    ``script_message_to`` (with this script as destination) is run
    with ``name`` as first parameter. The other parameters are passed to ``fn``.
    If a message with the given name is already registered, it's overwritten.

@@ -583,42 +471,6 @@ are useful only in special situations.
    Undo a previous registration with ``mp.register_script_message``. Does
    nothing if the ``name`` wasn't registered.

-``mp.create_osd_overlay(format)``
-    Create an OSD overlay. This is a very thin wrapper around the ``osd-overlay``
-    command. The function returns a table, which mostly contains fields that
-    will be passed to ``osd-overlay``. The ``format`` parameter is used to
-    initialize the ``format`` field. The ``data`` field contains the text to
-    be used as overlay. For details, see the ``osd-overlay`` command.
-
-    In addition, it provides the following methods:
-
-    ``update()``
-        Commit the OSD overlay to the screen, or in other words, run the
-        ``osd-overlay`` command with the current fields of the overlay table.
-        Returns the result of the ``osd-overlay`` command itself.
-
-    ``remove()``
-        Remove the overlay from the screen. A ``update()`` call will add it
-        again.
-
-    Example:
-
-    ::
-
-        ov = mp.create_osd_overlay("ass-events")
-        ov.data = "{\\an5}{\\b1}hello world!"
-        ov:update()
-
-    The advantage of using this wrapper (as opposed to running ``osd-overlay``
-    directly) is that the ``id`` field is allocated automatically.
-
-``mp.get_osd_size()``
-    Returns a tuple of ``osd_width, osd_height, osd_par``. The first two give
-    the size of the OSD in pixels (for video outputs like ``--vo=xv``, this may
-    be "scaled" pixels). The third is the display pixel aspect ratio.
-
-    May return invalid/nonsense values if OSD is not initialized yet.
-
 mp.msg functions
 ----------------

@@ -627,17 +479,16 @@ with ``require 'mp.msg'``.

 ``msg.log(level, ...)``
    The level parameter is the message priority. It's a string and one of
-    ``fatal``, ``error``, ``warn``, ``info``, ``v``, ``debug``, ``trace``. The
-    user's settings will determine which of these messages will be
-    visible. Normally, all messages are visible, except ``v``, ``debug`` and
-    ``trace``.
+    ``fatal``, ``error``, ``warn``, ``info``, ``v``, ``debug``. The user's
+    settings will determine which of these messages will be visible. Normally,
+    all messages are visible, except ``v`` and ``debug``.

    The parameters after that are all converted to strings. Spaces are inserted
    to separate multiple parameters.

    You don't need to add newlines.

-``msg.fatal(...)``, ``msg.error(...)``, ``msg.warn(...)``, ``msg.info(...)``, ``msg.verbose(...)``, ``msg.debug(...)``, ``msg.trace(...)``
+``msg.fatal(...)``, ``msg.error(...)``, ``msg.warn(...)``, ``msg.info(...)``, ``msg.verbose(...)``, ``msg.debug(...)``
    All of these are shortcuts and equivalent to the corresponding
    ``msg.log(level, ...)`` call.

@@ -649,27 +500,14 @@ command-line. All you have to do is to supply a table with default options to
 the read_options function. The function will overwrite the default values
 with values found in the config-file and the command-line (in that order).

-``options.read_options(table [, identifier [, on_update]])``
+``options.read_options(table [, identifier])``
    A ``table`` with key-value pairs. The type of the default values is
    important for converting the values read from the config file or
    command-line back. Do not use ``nil`` as a default value!

    The ``identifier`` is used to identify the config-file and the command-line
    options. These needs to unique to avoid collisions with other scripts.
-    Defaults to ``mp.get_script_name()`` if the parameter is ``nil`` or missing.
-
-    The ``on_update`` parameter enables run-time updates of all matching option
-    values via the ``script-opts`` option/property. If any of the matching
-    options changes, the values in the ``table`` (which was originally passed to
-    the function) are changed, and ``on_update(list)`` is called. ``list`` is
-    a table where each updated option has a ``list[option_name] = true`` entry.
-    There is no initial ``on_update()`` call. This never re-reads the config file.
-    ``script-opts`` is always applied on the original config file, ignoring
-    previous ``script-opts`` values (for example, if an option is removed from
-    ``script-opts`` at runtime, the option will have the value in the config
-    file). ``table`` entries are only written for option values whose values
-    effectively change (this is important if the script changes ``table``
-    entries independently).
+    Defaults to ``mp.get_script_name()``.


 Example implementation::
@@ -684,7 +522,7 @@ Example implementation::
    print(options.optionA)


-The config file will be stored in ``script-opts/identifier.conf`` in mpv's user
+The config file will be stored in ``lua-settings/identifier.conf`` in mpv's user
 folder. Comment lines can be started with # and stray spaces are not removed.
 Boolean values will be represented with yes/no.

@@ -704,8 +542,8 @@ Example command-line::
     --script-opts=myscript-optionA=TEST,myscript-optionB=0,myscript-optionC=yes


-mp.utils functions
------------------
+mp.utils options
+----------------

 This built-in module provides generic helper functions for Lua, and have
 strictly speaking nothing to do with mpv or video/audio playback. They are
@@ -745,34 +583,6 @@ strictly part of the guaranteed API.

    On error, ``nil, error`` is returned.

-``utils.file_info(path)``
-    Stats the given path for information and returns a table with the
-    following entries:
-
-        ``mode``
-            protection bits (on Windows, always 755 (octal) for directories
-            and 644 (octal) for files)
-        ``size``
-            size in bytes
-        ``atime``
-            time of last access
-        ``mtime``
-            time of last modification
-        ``ctime``
-            time of last metadata change
-        ``is_file``
-            Whether ``path`` is a regular file (boolean)
-        ``is_dir``
-            Whether ``path`` is a directory (boolean)
-
-    ``mode`` and ``size`` are integers.
-    Timestamps (``atime``, ``mtime`` and ``ctime``) are integer seconds since
-    the Unix epoch (Unix time).
-    The booleans ``is_file`` and ``is_dir`` are provided as a convenience;
-    they can be and are derived from ``mode``.
-
-    On error (e.g. path does not exist), ``nil, error`` is returned.
-
 ``utils.split_path(path)``
    Split a path into directory component and filename component, and return
    them. The first return value is always the directory. The second return
@@ -780,51 +590,51 @@ strictly part of the guaranteed API.

 ``utils.join_path(p1, p2)``
    Return the concatenation of the 2 paths. Tries to be clever. For example,
-    if ``p2`` is an absolute path, ``p2`` is returned without change.
+    if ```p2`` is an absolute path, p2 is returned without change.

 ``utils.subprocess(t)``
    Runs an external process and waits until it exits. Returns process status
-    and the captured output. This is a legacy wrapper around calling the
-    ``subprocess`` command with ``mp.command_native``. It does the following
-    things:
-
-    - copy the table ``t``
-    - rename ``cancellable`` field to ``playback_only``
-    - rename ``max_size`` to ``capture_size``
-    - set ``capture_stdout`` field to ``true`` if unset
-    - set ``name`` field to ``subprocess``
-    - call ``mp.command_native(copied_t)``
-    - if the command failed, create a dummy result table
-    - copy ``error_string`` to ``error`` field if the string is non-empty
-    - return the result table
-
-    It is recommended to use ``mp.command_native`` or ``mp.command_native_async``
-    directly, instead of calling this legacy wrapper. It is for compatibility
-    only.
-
-    See the ``subprocess`` documentation for semantics and further parameters.
-
-``utils.subprocess_detached(t)``
-    Runs an external process and detaches it from mpv's control.
+    and the captured output.

    The parameter ``t`` is a table. The function reads the following entries:

        ``args``
-            Array of strings of the same semantics as the ``args`` used in the
-            ``subprocess`` function.
+            Array of strings. The first array entry is the executable. This
+            can be either an absolute path, or a filename with no path
+            components, in which case the ``PATH`` environment variable is
+            used to resolve the executable. The other array elements are
+            passed as command line arguments.

-    The function returns ``nil``.
+        ``cancellable``
+            Optional. If set to ``true`` (default), then if the user stops
+            playback or goes to the next file while the process is running,
+            the process will be killed.

-    This is a legacy wrapper around calling the ``run`` command with
-    ``mp.commandv`` and other functions.
+        ``max_size``
+            Optional. The maximum size in bytes of the data that can be captured
+            from stdout. (Default: 16 MB.)

-``utils.getpid()``
-    Returns the process ID of the running mpv process. This can be used to identify
-    the calling mpv when launching (detached) subprocesses.
+    The function returns a table as result with the following entries:

-``utils.get_env_list()``
-    Returns the C environment as a list of strings. (Do not confuse this with
-    the Lua "environment", which is an unrelated concept.)
+        ``status``
+            The raw exit status of the process. It will be negative on error.
+
+        ``stdout``
+            Captured output stream as string, limited to ``max_size``.
+
+        ``error``
+            ``nil`` on success. The string ``killed`` if the process was
+            terminated in an unusual way. The string ``init`` if the process
+            could not be started.
+
+            On Windows, ``killed`` is only returned when the process has been
+            killed by mpv as a result of ``cancellable`` being set to ``true``.
+
+        ``killed_by_us``
+            Set to ``true`` if the process has been killed by mpv as a result
+            of ``cancellable`` being set to ``true``.
+
+    In all cases, ``mp.resume_all()`` is implicitly called.

 ``utils.parse_json(str [, trail])``
    Parses the given string argument as JSON, and returns it as a Lua table. On
@@ -871,7 +681,116 @@ Example:

    mp.register_event("file-loaded", my_fn)

-For the existing event types, see `List of events`_.
+
+
+List of events
+--------------
+
+``start-file``
+    Happens right before a new file is loaded. When you receive this, the
+    player is loading the file (or possibly already done with it).
+
+``end-file``
+    Happens after a file was unloaded. Typically, the player will load the
+    next file right away, or quit if this was the last file.
+
+    The event has the ``reason`` field, which takes one of these values:
+
+    ``eof``
+        The file has ended. This can (but doesn't have to) include
+        incomplete files or broken network connections under
+        circumstances.
+
+    ``stop``
+        Playback was ended by a command.
+
+    ``quit``
+        Playback was ended by sending the quit command.
+
+    ``error``
+        An error happened. In this case, an ``error`` field is present with
+        the error string.
+
+    ``redirect``
+        Happens with playlists and similar. Details see
+        ``MPV_END_FILE_REASON_REDIRECT`` in the C API.
+
+    ``unknown``
+        Unknown. Normally doesn't happen, unless the Lua API is out of sync
+        with the C API. (Likewise, it could happen that your script gets
+        reason strings that did not exist yet at the time your script was
+        written.)
+
+``file-loaded``
+    Happens after a file was loaded and begins playback.
+
+``seek``
+    Happens on seeking. (This might include cases when the player seeks
+    internally, even without user interaction. This includes e.g. segment
+    changes when playing ordered chapters Matroska files.)
+
+``playback-restart``
+    Start of playback after seek or after file was loaded.
+
+``idle``
+    Idle mode is entered. This happens when playback ended, and the player was
+    started with ``--idle`` or ``--force-window``. This mode is implicitly ended
+    when the ``start-file`` or ``shutdown`` events happen.
+
+``tick``
+    Called after a video frame was displayed. This is a hack, and you should
+    avoid using it. Use timers instead and maybe watch pausing/unpausing events
+    to avoid wasting CPU when the player is paused.
+
+``shutdown``
+    Sent when the player quits, and the script should terminate. Normally
+    handled automatically. See `Details on the script initialization and lifecycle`_.
+
+``log-message``
+    Receives messages enabled with ``mp.enable_messages``. The message data
+    is contained in the table passed as first parameter to the event handler.
+    The table contains, in addition to the default event fields, the following
+    fields:
+
+    ``prefix``
+        The module prefix, identifies the sender of the message. This is what
+        the terminal player puts in front of the message text when using the
+        ``--v`` option, and is also what is used for ``--msg-level``.
+
+    ``level``
+        The log level as string. See ``msg.log`` for possible log level names.
+        Note that later versions of mpv might add new levels or remove
+        (undocumented) existing ones.
+
+    ``text``
+        The log message. The text will end with a newline character. Sometimes
+        it can contain multiple lines.
+
+    Keep in mind that these messages are meant to be hints for humans. You
+    should not parse them, and prefix/level/text of messages might change
+    any time.
+
+``get-property-reply``
+    Undocumented (not useful for Lua scripts).
+
+``set-property-reply``
+    Undocumented (not useful for Lua scripts).
+
+``command-reply``
+    Undocumented (not useful for Lua scripts).
+
+``client-message``
+    Undocumented (used internally).
+
+``video-reconfig``
+    Happens on video output or filter reconfig.
+
+``audio-reconfig``
+    Happens on audio output or filter reconfig.
+
+The following events also happen, but are deprecated: ``tracks-changed``,
+``track-switched``, ``pause``, ``unpause``, ``metadata-update``,
+``chapter-change``. Use ``mp.observe_property()`` instead.

 Extras
 ------
@@ -885,22 +804,8 @@ guarantee a stable interface.
    their result (normally, the Lua scripting interface is asynchronous from
    the point of view of the player core). ``priority`` is an arbitrary integer
    that allows ordering among hooks of the same kind. Using the value 50 is
-    recommended as neutral default value.
-
-    ``fn(hook)`` is the function that will be called during execution of the
-    hook. The parameter passed to it (``hook``) is a Lua object that can control
-    further aspects about the currently invoked hook. It provides the following
-    methods:
-
-        ``defer()``
-            Returning from the hook function should not automatically continue
-            the hook. Instead, the API user wants to call ``hook:cont()`` on its
-            own at a later point in time (before or after the function has
-            returned).
-
-        ``cont()``
-            Continue the hook. Doesn't need to be called unless ``defer()`` was
-            called.
+    recommended as neutral default value. ``fn`` is the function that will be
+    called during execution of the hook.

    See `Hooks`_ for currently existing hooks and what they do - only the hook
    list is interesting; handling hook execution is done by the Lua script
@@ -20,78 +20,37 @@ The Interface

 ::

-    +---------+----------+------------------------------------------+----------+
-    | pl prev | pl next  |  title                                   |    cache |
-    +------+--+---+------+---------+-----------+------+-------+-----+-----+----+
-    | play | skip | skip | time    |  seekbar  | time | audio | sub | vol | fs |
-    |      | back | frwd | elapsed |           | left |       |     |     |    |
-    +------+------+------+---------+-----------+------+-------+-----+-----+----+
+    +------------------+-----------+--------------------+
+    | playlist prev    |   title   |      playlist next |
+    +-------+------+---+--+------+-+----+------+--------+
+    | audio | skip | seek |      | seek | skip |  full  |
+    +-------+ back | back | play | frwd | frwd | screen |
+    | sub   |      |      |      |      |      |        |
+    +-------+------+------+------+------+------+--------+
+    |                     seekbar                       |
+    +----------------+--------------+-------------------+
+    | time passed    | cache status |    time remaining |
+    +----------------+--------------+-------------------+


-pl prev
+playlist prev
    =============   ================================================
    left-click      play previous file in playlist
-    right-click     show playlist
-    shift+L-click   show playlist
-    =============   ================================================
-
-pl next
-    =============   ================================================
-    left-click      play next file in playlist
-    right-click     show playlist
    shift+L-click   show playlist
    =============   ================================================

 title
-    | Displays current media-title, filename, custom title, or target chapter
-      name while hovering the seekbar.
+    | Displays current media-title or filename

    =============   ================================================
    left-click      show playlist position and length and full title
    right-click     show filename
    =============   ================================================

-cache
-    | Shows current cache fill status
-
-play
+playlist next
    =============   ================================================
-    left-click      toggle play/pause
-    =============   ================================================
-
-skip back
-    =============   ================================================
-    left-click      go to beginning of chapter / previous chapter
-    right-click     show chapters
-    shift+L-click   show chapters
-    =============   ================================================
-
-skip frwd
-    =============   ================================================
-    left-click      go to next chapter
-    right-click     show chapters
-    shift+L-click   show chapters
-    =============   ================================================
-
-time elapsed
-    | Shows current playback position timestamp
-
-    =============   ================================================
-    left-click      toggle displaying timecodes with milliseconds
-    =============   ================================================
-
-seekbar
-    | Indicates current playback position and position of chapters
-
-    =============   ================================================
-    left-click      seek to position
-    =============   ================================================
-
-time left
-    | Shows remaining playback time timestamp
-
-    =============   ================================================
-    left-click      toggle between total and remaining time
+    left-click      play next file in playlist
+    shift+L-click   show playlist
    =============   ================================================

 audio and sub
@@ -103,17 +62,66 @@ audio and sub
    shift+L-click   show available audio/sub tracks
    =============   ================================================

-vol
+skip back
    =============   ================================================
-    left-click      toggle mute
-    mouse wheel     volume up/down
+    left-click      go to beginning of chapter / previous chapter
+    shift+L-click   show chapters
    =============   ================================================

-fs
+seek back
+    =============   ================================================
+    left-click      skip back  5 seconds
+    right-click     skip back 30 seconds
+    shift-L-click   skip back  1 frame
+    =============   ================================================
+
+play
+    =============   ================================================
+    left-click      toggle play/pause
+    =============   ================================================
+
+seek frwd
+    =============   ================================================
+    left-click      skip forward 10 seconds
+    right-click     skip forward 60 seconds
+    shift-L-click   skip forward  1 frame
+    =============   ================================================
+
+skip frwd
+    =============   ================================================
+    left-click      go to next chapter
+    shift+L-click   show chapters
+    =============   ================================================
+
+fullscreen
    =============   ================================================
    left-click      toggle fullscreen
    =============   ================================================

+seekbar
+    | Indicates current playback position and position of chapters
+
+    =============   ================================================
+    left-click      seek to position
+    =============   ================================================
+
+time passed
+    | Shows current playback position timestamp
+
+    =============   ================================================
+    left-click      toggle displaying timecodes with milliseconds
+    =============   ================================================
+
+cache status
+    | Shows current cache fill status (only visible when below 45%)
+
+time remaining
+    | Shows remaining playback time timestamp
+
+    =============   ================================================
+    left-click      toggle between total and remaining time
+    =============   ================================================
+
 Key Bindings
 ~~~~~~~~~~~~

@@ -129,7 +137,7 @@ Configuration
 -------------

 The OSC offers limited configuration through a config file
-``script-opts/osc.conf`` placed in mpv's user dir and through the
+``lua-settings/osc.conf`` placed in mpv's user dir and through the
 ``--script-opts`` command-line option. Options provided through the command-line
 will override those from the config file.

@@ -159,261 +167,85 @@ Example::
 Configurable Options
 ~~~~~~~~~~~~~~~~~~~~

-``layout``
-    Default: bottombar
-
-    The layout for the OSC. Currently available are: box, slimbox,
-    bottombar and topbar. Default pre-0.21.0 was 'box'.
-
-``seekbarstyle``
-    Default: bar
-
-    Sets the style of the playback position marker and overall shape
-    of the seekbar: ``bar``, ``diamond`` or ``knob``.
-
-``seekbarhandlesize``
-    Default: 0.6
-
-    Size ratio of the seek handle if ``seekbarstyle`` is set to ``dimaond``
-    or ``knob``. This is relative to the full height of the seekbar.
-
-``seekbarkeyframes``
-    Default: yes
-
-    Controls the mode used to seek when dragging the seekbar. If set to ``yes``,
-    default seeking mode is used (usually keyframes, but player defaults and
-    heuristics can change it to exact). If set to ``no``, exact seeking on
-    mouse drags will be used instead. Keyframes are preferred, but exact seeks
-    may be useful in cases where keyframes cannot be found. Note that using
-    exact seeks can potentially make mouse dragging much slower.
-
-``seekrangestyle``
-    Default: inverted
-
-    Display seekable ranges on the seekbar. ``bar`` shows them on the full
-    height of the bar, ``line`` as a thick line and ``inverted`` as a thin
-    line that is inverted over playback position markers. ``none`` will hide
-    them. Additionally, ``slider`` will show a permanent handle inside the seekbar
-    with cached ranges marked inside. Note that these will look differently
-    based on the seekbarstyle option. Also, ``slider`` does not work with
-    ``seekbarstyle`` set to ``bar``.
-
-``seekrangeseparate``
-    Default: yes
-
-    Controls whether to show line-style seekable ranges on top of the
-    seekbar or separately if ``seekbarstyle`` is set to ``bar``.
-
-``seekrangealpha``
-    Default: 200
-
-    Alpha of the seekable ranges, 0 (opaque) to 255 (fully transparent).
-
-``deadzonesize``
-    Default: 0.5
-
-    Size of the deadzone. The deadzone is an area that makes the mouse act
-    like leaving the window. Movement there won't make the OSC show up and
-    it will hide immediately if the mouse enters it. The deadzone starts
-    at the window border opposite to the OSC and the size controls how much
-    of the window it will span. Values between 0.0 and 1.0, where 0 means the
-    OSC will always popup with mouse movement in the window, and 1 means the
-    OSC will only show up when the mouse hovers it. Default pre-0.21.0 was 0.
-
-``minmousemove``
-    Default: 0
-
-    Minimum amount of pixels the mouse has to move between ticks to make
-    the OSC show up. Default pre-0.21.0 was 3.
-
 ``showwindowed``
-    Default: yes
-
-    Enable the OSC when windowed
+    | Default: yes
+    | Enable the OSC when windowed

 ``showfullscreen``
-    Default: yes
-
-    Enable the OSC when fullscreen
-
-``idlescreen``
-    Default: yes
-
-    Show the mpv logo and message when idle
+    | Default: yes
+    | Enable the OSC when fullscreen

 ``scalewindowed``
-    Default: 1.0
-
-    Scale factor of the OSC when windowed.
+    | Default: 1.0
+    | Scale factor of the OSC when windowed

 ``scalefullscreen``
-    Default: 1.0
-
-    Scale factor of the OSC when fullscreen
+    | Default: 1.0
+    | Scale factor of the OSC when fullscreen

 ``scaleforcedwindow``
-    Default: 2.0
-
-    Scale factor of the OSC when rendered on a forced (dummy) window
+    | Default: 2.0
+    | Scale factor of the OSC when rendered on a forced (dummy) window

 ``vidscale``
-    Default: yes
-
-    Scale the OSC with the video
-    ``no`` tries to keep the OSC size constant as much as the window size allows
+    | Default: yes
+    | Scale the OSC with the video
+    | ``no`` tries to keep the OSC size constant as much as the window size allows

 ``valign``
-    Default: 0.8
-
-    Vertical alignment, -1 (top) to 1 (bottom)
+    | Default: 0.8
+    | Vertical alignment, -1 (top) to 1 (bottom)

 ``halign``
-    Default: 0.0
-
-    Horizontal alignment, -1 (left) to 1 (right)
-
-``barmargin``
-    Default: 0
-
-    Margin from bottom (bottombar) or top (topbar), in pixels
+    | Default: 0.0
+    | Horizontal alignment, -1 (left) to 1 (right)

 ``boxalpha``
-    Default: 80
-
-    Alpha of the background box, 0 (opaque) to 255 (fully transparent)
+    | Default: 80
+    | Alpha of the background box, 0 (opaque) to 255 (fully transparent)

 ``hidetimeout``
-    Default: 500
-
-    Duration in ms until the OSC hides if no mouse movement, must not be
-    negative
+    | Default: 500
+    | Duration in ms until the OSC hides if no mouse movement, must not be
+      negative

 ``fadeduration``
-    Default: 200
+    | Default: 200
+    | Duration of fade out in ms, 0 = no fade

-    Duration of fade out in ms, 0 = no fade
+``deadzonesize``
+    | Default: 0
+    | Size of the deadzone. The deadzone is an area that makes the mouse act
+      like leaving the window. Movement there won't make the OSC show up and
+      it will hide immediately if the mouse enters it. The deadzone starts
+      at the window border opposite to the OSC and the size controls how much
+      of the window it will span. Values between 0 and 1.

-``title``
-    Default: ${media-title}
+``minmousemove``
+    | Default: 3
+    | Minimum amount of pixels the mouse has to move between ticks to make
+      the OSC show up

-    String that supports property expansion that will be displayed as
-    OSC title.
-    ASS tags are escaped, and newlines and trailing slashes are stripped.
+``layout``
+    | Default: box
+    | The layout for the OSC. Currently available are: box, slimbox,
+      bottombar and topbar.

-``tooltipborder``
-    Default: 1
-
-    Size of the tooltip outline when using bottombar or topbar layouts
+``seekbarstyle``
+    | Default: slider
+    | Sets the style of the seekbar, slider (diamond marker) or bar (fill)

 ``timetotal``
-    Default: no
-
-    Show total time instead of time remaining
+    | Default: no
+    | Show total time instead of time remaining

 ``timems``
-    Default: no
-
-    Display timecodes with milliseconds
-
-``tcspace``
-    Default: 100 (allowed: 50-200)
-
-    Adjust space reserved for timecodes (current time and time remaining) in
-    the ``bottombar`` and ``topbar`` layouts. The timecode width depends on the
-    font, and with some fonts the spacing near the timecodes becomes too small.
-    Use values above 100 to increase that spacing, or below 100 to decrease it.
+    | Default: no
+    | Display timecodes with milliseconds

 ``visibility``
-    Default: auto (auto hide/show on mouse move)
-
-    Also supports ``never`` and ``always``
-
-``boxmaxchars``
-    Default: 80
-
-    Max chars for the osc title at the box layout. mpv does not measure the
-    text width on screen and so it needs to limit it by number of chars. The
-    default is conservative to allow wide fonts to be used without overflow.
-    However, with many common fonts a bigger number can be used. YMMV.
-
-``boxvideo``
-    Default: no
-
-    Whether to overlay the osc over the video (``no``), or to box the video
-    within the areas not covered by the osc (``yes``). If this option is set,
-    the osc may overwrite the ``--video-margin-ratio-*`` options, even if the
-    user has set them. (It will not overwrite them if all of them are set to
-    default values.) Additionally, ``visibility`` must be set to ``always``.
-    Otherwise, this option does nothing.
-
-    Currently, this is supported for the ``bottombar`` and ``topbar`` layout
-    only. The other layouts do not change if this option is set. Separately,
-    if window controls are present (see below), they will be affected
-    regardless of which osc layout is in use.
-
-    The border is static and appears even if the OSC is configured to appear
-    only on mouse interaction. If the OSC is invisible, the border is simply
-    filled with the background color (black by default).
-
-    This currently still makes the OSC overlap with subtitles (if the
-    ``--sub-use-margins`` option is set to ``yes``, the default). This may be
-    fixed later.
-
-    This does not work correctly with video outputs like ``--vo=xv``, which
-    render OSD into the unscaled video.
-
-``windowcontrols``
-    Default: auto (Show window controls if there is no window border)
-
-    Whether to show window management controls over the video, and if so,
-    which side of the window to place them. This may be desirable when the
-    window has no decorations, either because they have been explicitly
-    disabled (``border=no``) or because the current platform doesn't support
-    them (eg: gnome-shell with wayland).
-
-    The set of window controls is fixed, offering ``minimize``, ``maximize``,
-    and ``quit``. Not all platforms implement ``minimize`` and ``maximize``,
-    but ``quit`` will always work.
-
-``windowcontrols_alignment``
-    Default: right
-
-    If window controls are shown, indicates which side should they be aligned
-    to.
-
-    Supports ``left`` and ``right`` which will place the controls on those
-    respective sides.
-
-``greenandgrumpy``
-    Default: no
-
-    Set to ``yes`` to reduce festivity (i.e. disable santa hat in December.)
-
-``livemarkers``
-    Default: yes
-
-    Update chapter markers positions on duration changes, e.g. live streams.
-    The updates are unoptimized - consider disabling it on very low-end systems.
-
-``chapters_osd``, ``playlist_osd``
-    Default: yes
-
-    Whether to display the chapters/playlist at the OSD when left-clicking the
-    next/previous OSC buttons, respectively.
-
-``chapter_fmt``
-    Default: ``Chapter: %s``
-
-    Template for the chapter-name display when hovering the seekbar.
-    Use ``no`` to disable chapter display on hover. Otherwise it's a lua
-    ``string.format`` template and ``%s`` is replaced with the actual name.
-
-``unicodeminus``
-    Default: no
-
-    Use a Unicode minus sign instead of an ASCII hyphen when displaying
-    the remaining playback time.
-
+    | Default: auto (auto hide/show on mouse move)
+    | Also supports ``never`` and ``always``

 Script Commands
 ~~~~~~~~~~~~~~~
@@ -434,14 +266,6 @@ Example
 You could put this into ``input.conf`` to hide the OSC with the ``a`` key and
 to set auto mode (the default) with ``b``::

-    a script-message osc-visibility never
-    b script-message osc-visibility auto
-
-``osc-idlescreen``
-    Controls the visibility of the mpv logo on idle. Valid arguments are ``yes``,
-    ``no``, and ``cycle`` to toggle between yes and no.
-
-``osc-playlist``, ``osc-chapterlist``, ``osc-tracklist``
-    Shows a limited view of the respective type of list using the OSC. First
-    argument is duration in seconds.
+    a script_message osc-visibility never
+    b script_message osc-visibility auto

@@ -1,235 +0,0 @@
-STATS
-=====
-
-This builtin script displays information and statistics for the currently
-played file. It is enabled by default if mpv was compiled with Lua support.
-It can be disabled entirely using the ``--load-stats-overlay=no`` option.
-
-Usage
-----
-
-The following key bindings are active by default unless something else is
-already bound to them:
-
-====   ==============================================
-i      Show stats for a fixed duration
-I      Toggle stats (shown until toggled again)
-====   ==============================================
-
-While the stats are visible on screen the following key bindings are active,
-regardless of existing bindings. They allow you to switch between *pages* of
-stats:
-
-====   ==================
-1      Show usual stats
-2      Show frame timings (scroll)
-3      Input cache stats
-4      Active key bindings (scroll)
-0      Internal stuff (scroll)
-====   ==================
-
-On pages which support scroll, these key bindings are also active:
-
-====   ==================
-UP      Scroll one line up
-DOWN    Scroll one line down
-====   ==================
-
-Font
-~~~~
-
-For optimal visual experience, a font with support for many font weights and
-monospaced digits is recommended. By default, the open source font
-`Source Sans Pro <https://github.com/adobe-fonts/source-sans-pro>`_ is used.
-
-Configuration
-------------
-
-This script can be customized through a config file ``script-opts/stats.conf``
-placed in mpv's user directory and through the ``--script-opts`` command-line
-option. The configuration syntax is described in `ON SCREEN CONTROLLER`_.
-
-Configurable Options
-~~~~~~~~~~~~~~~~~~~~
-
-``key_page_1``
-    Default: 1
-``key_page_2``
-    Default: 2
-``key_page_3``
-    Default: 3
-``key_page_4``
-    Default: 4
-``key_page_0``
-    Default: 0
-
-    Key bindings for page switching while stats are displayed.
-
-``key_scroll_up``
-    Default: UP
-``key_scroll_down``
-    Default: DOWN
-``scroll_lines``
-    Default: 1
-
-    Scroll key bindings and number of lines to scroll on pages which support it.
-
-``duration``
-    Default: 4
-
-    How long the stats are shown in seconds (oneshot).
-
-``redraw_delay``
-    Default: 1
-
-    How long it takes to refresh the displayed stats in seconds (toggling).
-
-``persistent_overlay``
-    Default: no
-
-    When `no`, other scripts printing text to the screen can overwrite the
-    displayed stats. When `yes`, displayed stats are persistently shown for the
-    respective duration. This can result in overlapping text when multiple
-    scripts decide to print text at the same time.
-
-``plot_perfdata``
-    Default: yes
-
-    Show graphs for performance data (page 2).
-
-``plot_vsync_ratio``
-    Default: yes
-``plot_vsync_jitter``
-    Default: yes
-
-    Show graphs for vsync and jitter values (page 1). Only when toggled.
-
-``flush_graph_data``
-    Default: yes
-
-    Clear data buffers used for drawing graphs when toggling.
-
-``font``
-    Default: Source Sans Pro
-
-    Font name. Should support as many font weights as possible for optimal
-    visual experience.
-
-``font_mono``
-    Default: Source Sans Pro
-
-    Font name for parts where monospaced characters are necessary to align
-    text. Currently, monospaced digits are sufficient.
-
-``font_size``
-    Default: 8
-
-    Font size used to render text.
-
-``font_color``
-    Default: FFFFFF
-
-    Font color.
-
-``border_size``
-    Default: 0.8
-
-    Size of border drawn around the font.
-
-``border_color``
-    Default: 262626
-
-    Color of drawn border.
-
-``alpha``
-    Default: 11
-
-    Transparency for drawn text.
-
-``plot_bg_border_color``
-    Default: 0000FF
-
-    Border color used for drawing graphs.
-
-``plot_bg_color``
-    Default: 262626
-
-    Background color used for drawing graphs.
-
-``plot_color``
-    Default: FFFFFF
-
-    Color used for drawing graphs.
-
-Note: colors are given as hexadecimal values and use ASS tag order: BBGGRR
-(blue green red).
-
-Different key bindings
-~~~~~~~~~~~~~~~~~~~~~~
-
-Additional keys can be configured in ``input.conf`` to display the stats::
-
-    e script-binding stats/display-stats
-    E script-binding stats/display-stats-toggle
-
-And to display a certain page directly::
-
-    i script-binding stats/display-page-1
-    e script-binding stats/display-page-2
-
-Active key bindings page
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Lists the active key bindings and the commands they're bound to, excluding the
-interactive keys of the stats script itself. See also ``--input-test`` for more
-detailed view of each binding.
-
-The keys are grouped automatically using a simple analysis of the command
-string, and one should not expect documentation-level grouping accuracy,
-however, it should still be reasonably useful.
-
-Using ``--idle --script-opts=stats-bindlist=yes`` will print the list to the
-terminal and quit immediately. By default long lines are shortened to 79 chars,
-and terminal escape sequences are enabled. A different length limit can be
-set by changing ``yes`` to a number (at least 40), and escape sequences can be
-disabled by adding ``-`` before the value, e.g. ``...=-yes`` or ``...=-120``.
-
-Like with ``--input-test``, the list includes bindings from ``input.conf`` and
-from user scripts. Use ``--no-config`` to list only built-in bindings.
-
-Internal stuff page
-~~~~~~~~~~~~~~~~~~~
-
-Most entries shown on this page have rather vague meaning. Likely none of this
-is useful for you. Don't attempt to use it. Forget its existence.
-
-Selecting this for the first time will start collecting some internal
-performance data. That means performance will be slightly lower than normal for
-the rest of the time the player is running (even if the stats page is closed).
-Note that the stats page itself uses a lot of CPU and even GPU resources, and
-may have a heavy impact on performance.
-
-The displayed information is accumulated over the redraw delay (shown as
-``poll-time`` field).
-
-This adds entries for each Lua script. If there are too many scripts running,
-parts of the list will simply be out of the screen, but it can be scrolled.
-
-If the underlying platform does not support pthread per thread times, the
-displayed times will be 0 or something random (I suspect that at time of this
-writing, only Linux provides the correct via pthread APIs for per thread times).
-
-Most entries are added lazily and only during data collection, which is why
-entries may pop up randomly after some time. It's also why the memory usage
-entries for scripts that have been inactive since the start of data collection
-are missing.
-
-Memory usage is approximate and does not reflect internal fragmentation.
-
-JS scripts memory reporting is disabled by default because collecting the data
-at the JS side has an overhead. It can be enabled by exporting the env var
-``MPV_LEAK_REPORT=1`` before starting mpv, and will increase JS memory usage.
-
-If entries have ``/time`` and ``/cpu`` variants, the former gives the real time
-(monotonic clock), while the latter the thread CPU time (only if the
-corresponding pthread API works and is supported).
@@ -7,11 +7,8 @@ large part of which is incompatible or completely changes how the player
 behaves. Although there are still many similarities to its ancestors, **mpv**
 should generally be treated as a completely different program.

-.. admonition:: Warning
-
-    This document is **not updated** anymore, and is **incomplete** and
-    **outdated**. If you look for old option replacements, always check with
-    the current mpv manpage, as the options could have changed meanwhile.
+.. note::
+    These lists are incomplete.

 General Changes from MPlayer to mpv
 -----------------------------------
@@ -33,7 +30,7 @@ Player
 * Slave mode compatibility broken (see below).
 * Re-enable screensaver while the player is paused.
 * Allow resuming playback at a later point with ``Shift+q``, also see the
-  ``quit-watch-later`` input command.
+  ``quit_watch_later`` input command.
 * ``--keep-open`` option to stop the player from closing the window and
  exiting after playback ends.
 * A client API, that allows embedding **mpv** into applications
@@ -52,7 +49,7 @@ Input
 * Classic LIRC support was removed. Install remotes as input devices instead.
  This way they will send X11 key events to the mpv window, which can be bound
  using the normal ``input.conf``.
-  Also see: https://github.com/mpv-player/mpv/wiki/IR-remotes
+  Also see: http://github.com/mpv-player/mpv/wiki/IR-remotes
 * Joystick support was removed. It was considered useless and was the cause
  of some problems (e.g. a laptop's accelerator being recognized as joystick).
 * Support for relative seeking by percentage.
@@ -76,16 +73,15 @@ Video

 * Wayland support.
 * Native support for VAAPI and VDA. Improved VDPAU video output.
-* Improved GPU-accelerated video output (see the ``gpu-hq`` preset).
-* Make hardware decoding work with the ``gpu`` video output.
+* Improved OpenGL output (see the ``opengl-hq`` video output).
+* Make hardware decoding work with the ``opengl`` video output.
 * Support for libavfilter (for video->video and audio->audio). This allows
  using most of FFmpeg's filters, which improve greatly on the old MPlayer
  filters in features, performance, and correctness.
 * More correct color reproduction (color matrix generation), including support
-  for BT.2020 (Ultra HD). linear XYZ (Digital Cinema) and SMPTE ST2084 (HDR)
-  inputs.
+  for BT.2020 (Ultra HD) and linear XYZ (Digital Cinema) inputs.
 * Support for color managed displays, via ICC profiles.
-* High-quality image resamplers (see the ``--scale`` suboption).
+* High-quality image resamplers (see the ``opengl`` ``scale`` suboption).
 * Support for scaling in (sigmoidized) linear light.
 * Better subtitle rendering using libass by default.
 * Improvements when playing multiple files (``-fixed-vo`` is default, do not
@@ -144,6 +140,7 @@ Mac OS X
 * Native OpenGL backend.
 * Cocoa event loop is independent from MPlayer's event loop, so user
  actions like accessing menus and live resizing do not block the playback.
+* Apple Remote support.
 * Media Keys support.
 * VDA support using libavcodec hwaccel API instead of FFmpeg's decoder with up
  to 2-2.5x reduction in CPU usage.
@@ -211,7 +208,7 @@ Command Line Switches
    ``-no<opt>``                ``--no-<opt>`` (add a dash)
    ``-a52drc level``           ``--ad-lavc-ac3drc=level``
    ``-ac spdifac3``            ``--ad=spdif:ac3`` (see ``--ad=help``)
-    ``-af volnorm``             (removed; use acompressor ffmpeg filter instead)
+    ``-af volnorm``             ``--af=drc`` (renamed)
    ``-afm hwac3``              ``--ad=spdif:ac3,spdif:dts``
    ``-ao alsa:device=hw=0.3``  ``--ao=alsa:device=[hw:0,3]``
    ``-aspect``                 ``--video-aspect``
@@ -247,7 +244,7 @@ Command Line Switches
    ``-msglevel``               ``--msg-level`` (changed semantics)
    ``-msgmodule``              ``--msg-module``
    ``-name``                   ``--x11-name``
-    ``-noar``                   ``(removed; replaced by MediaPlayer framework)``
+    ``-noar``                   ``--no-input-appleremote``
    ``-noautosub``              ``--no-sub-auto``
    ``-noconsolecontrols``      ``--no-input-terminal``
    ``-nosound``                ``--no-audio``
@@ -264,14 +261,13 @@ Command Line Switches
    ``-ssf <sub>``              ``--sws-...``
    ``-stop-xscreensaver``      ``--stop-screensaver``
    ``-sub-fuzziness``          ``--sub-auto``
-    ``-sub-text-*``             ``--sub-*``
    ``-sub``                    ``--sub-file``
    ``-subcp``                  ``--sub-codepage``
    ``-subdelay``               ``--sub-delay``
    ``-subfile``                ``--sub-file``
-    ``-subfont-*``              ``--sub-*``, ``--osd-*``
+    ``-subfont-*``              ``--sub-text-*``, ``--osd-*``
    ``-subfont-text-scale``     ``--sub-scale``
-    ``-subfont``                ``--sub-font``
+    ``-subfont``                ``--sub-text-font``
    ``-subfps``                 ``--sub-fps``
    ``-subpos``                 ``--sub-pos``
    ``-sws``                    ``--sws-scaler``
@@ -315,11 +311,11 @@ input.conf and Slave Commands
    +--------------------------------+----------------------------------------+
    | Old                            | New                                    |
    +================================+========================================+
-    | ``pt_step 1 [0|1]``            | ``playlist-next [weak|force]``         |
+    | ``pt_step 1 [0|1]``            | ``playlist_next [weak|force]``         |
    |                                | (translation layer cannot deal with    |
    |                                | whitespace)                            |
    +--------------------------------+----------------------------------------+
-    | ``pt_step -1 [0|1]``           | ``playlist-prev [weak|force] (same)``  |
+    | ``pt_step -1 [0|1]``           | ``playlist_prev [weak|force] (same)``  |
    +--------------------------------+----------------------------------------+
    | ``switch_ratio [<ratio>]``     | ``set video-aspect <ratio>``           |
    |                                |                                        |
@@ -334,7 +330,7 @@ input.conf and Slave Commands
    | ``<step> <dir>``               | ``no-osd``: ``no-osd cycle <prop>``    |
    |                                | ``<step>``                             |
    +--------------------------------+----------------------------------------+
-    | ``osd_show_property_text``     | ``show-text <text>``                   |
+    | ``osd_show_property_text``     | ``show_text <text>``                   |
    | ``<text>``                     | The property expansion format string   |
    |                                | syntax slightly changed.               |
    +--------------------------------+----------------------------------------+
@@ -343,9 +339,9 @@ input.conf and Slave Commands
    |                                | ``raw`` prefix to disable property     |
    |                                | expansion.                             |
    +--------------------------------+----------------------------------------+
-    | ``show_tracks``                | ``show-text ${track-list}``            |
+    | ``show_tracks``                | ``show_text ${track-list}``            |
    +--------------------------------+----------------------------------------+
-    | ``show_chapters``              | ``show-text ${chapter-list}``          |
+    | ``show_chapters``              | ``show_text ${chapter-list}``          |
    +--------------------------------+----------------------------------------+
    | ``af_switch``, ``af_add``, ... | ``af set|add|...``                     |
    +--------------------------------+----------------------------------------+
@@ -7,7 +7,8 @@ contains breaking changes, such as changed options or added/removed features,
 and Y is incremented if a release contains only bugfixes and other minor
 changes.

-Releases are tagged on the master branch and will not be maintained separately.
+There is only one release branch that keeps track of the latest version and
+will not be maintained separately.

 The goal of releases is to provide Linux distributions with something to
 package. If you want the newest features, just use the master branch.
@@ -18,30 +19,21 @@ Releases other than the latest release are unsupported and unmaintained.
 Release procedure
 -----------------

-While on master:
+- Merge master into branch release/current.

- Update the `RELEASE_NOTES` file, replacing the previous release notes.
+- Create and/or update the `RELEASE_NOTES` file.

- Update the `VERSION` file.
+- Create and/or update the `VERSION` file.

- Update `DOCS/client-api-changes.rst` and `DOCS/interface-changes.rst`
-  (in particular, update the last version numbers if necessary)
+- Update `DOCS/client-api-changes.rst` (on major releases).

- Create signed commit with changes.
+- Create tag v0.X.Y.

- Create signed tag v0.X.Y.
-
- Add -UNKNOWN suffix to version in `VERSION` file.
-
- Commit changes, push release branch (`release/0.X`) and tag to GitHub.
+- Push branch and tag to GitHub.

 - Create a new GitHub release using the content of `RELEASE_NOTES` related to
  the new version.

-If necessary (to e.g. exclude commits already on master), the release can
-be done on a branch with different commit history. The release branch **must**
-then be merged to master so `git describe` will pick up the tag.
-
 Release notes template
 ----------------------

@@ -15,7 +15,7 @@ player/*.c:
        * parse command line, add files from the command line to playlist
          (m_config_parse_mp_command_line())
        * check help options etc. (call handle_help_options()), possibly exit
-        * call mp_play_files() function that works down the playlist:
+        * call play_files() function that works down the playlist:
            * run idle loop (idle_loop()), until there are files in the
                playlist or an exit command was given (only if --idle it set)
            * actually load and play a file in play_current_file():
@@ -30,7 +30,7 @@ player/*.c:
            * determine next entry on the playlist to play
            * loop, or exit if no next file or quit is requested
              (see enum stop_play_reason)
-        * call mp_destroy()
+        * call exit_player_with_rc()
    * run_playloop():
        * calls fill_audio_out_buffers()
            This checks whether new audio needs to be decoded, and pushes it
@@ -44,9 +44,11 @@ player/*.c:

    Things worth saying about the playback core:
    - most state is in MPContext (core.h), which is not available to the
-      subsystems (and should not be made available)
+      subsystems
    - the currently played tracks are in mpctx->current_tracks, and decoder
-      state in track.dec/d_sub
+      state in d_video/d_audio/d_sub
+    - the timeline stuff is used only with MKV ordered chapters (and some other
+      minor features: cue, edl)
    - the other subsystems rarely call back into the frontend, and the frontend
      polls them instead (probably a good thing)
    - one exceptions are wakeup callbacks, which notify a "higher" component
@@ -54,34 +56,43 @@ player/*.c:

    I like to call the player/*.c files the "frontend".

-ta.h & ta.c:
-    Hierarchical memory manager inspired by talloc from Samba. It's like a
-    malloc() with more features. Most importantly, each talloc allocation can
-    have a parent, and if the parent is free'd, all children will be free'd as
-    well. The parent is an arbitrary talloc allocation. It's either set by the
-    allocation call by passing a talloc parent, usually as first argument to the
-    allocation function. It can also be set or reset later by other calls (at
-    least talloc_steal()). A talloc allocation that is used as parent is often
-    called a talloc context.
+talloc.h & talloc.c:
+    Hierarchical memory manager copied from Samba. It's like a malloc() with
+    more features. Most importantly, each talloc allocation can have a parent,
+    and if the parent is free'd, all children will be free'd as well. The
+    parent is an arbitrary talloc allocation. It's either set by the allocation
+    call by passing a talloc parent, usually as first argument to the allocation
+    function. It can also be set or reset later by other calls (at least
+    talloc_steal()). A talloc allocation that is used as parent is often called
+    a talloc context.
+
+    Lots of code still uses malloc() proper, and you should be careful what
+    type of allocation you're dealing with when returning or free'ing an
+    allocation. (Needless to say, talloc_free() and free() are completely
+    different things.)
+
+    The copy in mpv has been modified to abort on OOM conditions. An
+    allocation call will never return NULL.

    One very useful feature of talloc is fast tracking of memory leaks. ("Fast"
    as in it doesn't require valgrind.) You can enable it by setting the
    MPV_LEAK_REPORT environment variable to "1":
        export MPV_LEAK_REPORT=1
-    Or permanently by building with --enable-ta-leak-report.
    This will list all unfree'd allocations on exit.

    Documentation can be found here:
        http://git.samba.org/?p=samba.git;a=blob;f=lib/talloc/talloc.h;hb=HEAD

-    For some reason, we're still using API-compatible wrappers instead of TA
-    directly. The talloc wrapper has only a subset of the functionality, and
-    in particular the wrappers abort() on memory allocation failure.
-
    Note: unlike tcmalloc, jemalloc, etc., talloc() is not actually a malloc
          replacement. It works on top of system malloc and provides additional
          features that are supposed to make memory management easier.

+    Warning: actually, we're not using talloc anymore. talloc in mpv has been
+             replaced by a custom re-implementation (TA in ta/). It provides
+             some talloc emulation (just the parts needed by mpv). We will get
+             rid of the talloc emulation later and use TA natively.
+             (See ta/README for details.)
+
 player/command.c:
    This contains the implementation for client API commands and properties.
    Properties are essentially dynamic variables changed by certain commands.
@@ -104,47 +115,15 @@ options/options.h, options/options.c
    options.c. Most default values for options and MPOpts are in
    mp_default_opts at the end of options.c.

-    MPOpts is unfortunately quite monolithic, but is being incrementally broken
-    up into sub-structs. Many components have their own sub-option structs
-    separate from MPOpts. New options should be bound to the component that uses
-    them. Add a new option table/struct if needed.
-
-    The global MPOpts still contains the sub-structs as fields, which serves to
-    link them to the option parser. For example, an entry like this may be
-    typical:
-
-        {"", OPT_SUBSTRUCT(demux_opts, demux_conf)},
-
-    This directs the option access code to include all options in demux_conf
-    into the global option list, with no prefix (""), and as part of the
-    MPOpts.demux_opts field. The MPOpts.demux_opts field is actually not
-    accessed anywhere, and instead demux.c does this:
-
-        struct m_config_cache *opts_cache =
-            m_config_cache_alloc(demuxer, global, &demux_conf);
-        struct demux_opts *opts = opts_cache->opts;
-
-    ... to get a copy of its options.
-
-    See m_config.h (below) how to access options.
+    MPOpts is unfortunately quite monolithic, and virtually accessed by
+    everything.But some components (like video outputs and video filters) have
+    their own sub-option tables separate from MPOpts.

    The actual option parser is spread over m_option.c, m_config.c, and
-    parse_commandline.c, and uses the option table in options.c.
-
-options/m_config.h & m_config.c:
-    Code for querying and managing options. This (unfortunately) contains both
-    declarations for the "legacy-ish" global m_config struct, and ways to access
-    options in a threads-safe way anywhere, like m_config_cache_alloc().
-
-    m_config_cache_alloc() lets anyone read, observe, and write options in any
-    thread. The only state it needs is struct mpv_global, which is an opaque
-    type that can be passed "down" the component hierarchy. For safety reasons,
-    you should not pass down any pointers to option structs (like MPOpts), but
-    instead pass down mpv_global, and use m_config_cache_alloc() (or similar)
-    to get a synchronized copy of the options.
+    parser-mpcmd.c, and uses the option table in options.c.

 input/input.c:
-    This translates keyboard input coming from VOs and other sources (such
+    This translates keyboard input comming from VOs and other sources (such
    as remote control devices like Apple IR or client API commands) to the
    key bindings listed in the user's (or the builtin) input.conf and turns
    them into items of type struct mp_cmd. These commands are queued, and read
@@ -172,6 +151,9 @@ stream/*:
    Some stream inputs are just there to invoke special demuxers, like
    stream_mf.c. (Basically to make the prefix "mf://" do something special.)

+    cache.c is a caching wrapper around streams implementations, needed for
+    smooth network playback.
+
 demux/:
    Demuxers split data streams into audio/video/sub streams, which in turn
    are split in packets. Packets (see demux_packet.h) are mostly byte chunks
@@ -179,16 +161,13 @@ demux/:

    Most demuxers have been removed from this fork, and the only important and
    "actual" demuxers left are demux_mkv.c and demux_lavf.c (uses libavformat).
-    There are some pseudo demuxers like demux_cue.c.
+    There are some pseudo demuxers like demux_cue.c, which exist only to invoke
+    other frontend code (tl_cue.c in this case).

    The main interface is in demux.h. The stream headers are in stheader.h.
    There is a stream header for each audio/video/sub stream, and each of them
    holds codec information about the stream and other information.

-    demux.c is a bit big, the main reason being that it contains the demuxer
-    cache, which is implemented as a list of packets. The cache is complex
-    because it support seeking, multiple ranges, prefetching, and so on.
-
 video/:
    This contains several things related to audio/video decoding, as well as
    video filters.
@@ -197,8 +176,8 @@ video/:
    internally.

 video/decode/:
-    vd_*.c are video decoders. (There's only vd_lavc.c left.) dec_video.c
-    handles most of connecting the frontend with the actual decoder.
+    vd_*.c are video decoders. (There's only vd_lavc.c left.) dec_video.c/vd.c
+    handle most of connecting the frontend with the actual decoder.

 video/filter/:
    vf_*.c and vf.c form the video filter chain. They are fed by the video
@@ -211,26 +190,27 @@ video/out/:
    Video output. They also create GUI windows and handle user input. In most
    cases, the windowing code is shared among VOs, like x11_common.c for X11 and
    w32_common.c for Windows. The VOs stand between frontend and windowing code.
-    vo_gpu can pick a windowing system at runtime, e.g. the same binary can
+    vo_opengl can pick a windowing system at runtime, e.g. the same binary can
    provide both X11 and Cocoa support on OSX.

-    VOs can be reconfigured at runtime. A vo_reconfig() call can change the video
+    VOs can be reconfigured at runtime. A vo_config() call can change the video
    resolution and format, without destroying the window.

-    vo_gpu should be taken as reference.
+    vo_vdpau and vo_opengl should be taken as reference.

 audio/:
    format.h/format.c define the uncompressed audio formats. (As well as some
    compressed formats used for spdif.)

 audio/decode/:
-    ad_*.c and dec_audio.c handle audio decoding. ad_lavc.c is the
+    ad_*.c and dec_audio.c/ad.c handle audio decoding. ad_lavc.c is the
    decoder using ffmpeg. ad_spdif.c is not really a decoder, but is used for
    compressed audio passthrough.

 audio/filter/:
    Audio filter chain. af_lavrresample is inserted if any form of conversion
-    between audio formats is needed.
+    between audio formats is needed. (af_convert24.c and af_convertsignendian.c
+    are also used for some formats not directly supported by FFmpeg.)

 audio/out/:
    Audio outputs.
@@ -264,394 +244,23 @@ sub/:

    The subtitles are passed to dec_sub.c and the subtitle decoders in sd_*.c
    as they are demuxed. All text subtitles are rendered by sd_ass.c. If text
-    subtitles are not in the ASS format, the libavcodec subtitle converters are
-    used (lavc_conv.c).
+    subtitles are not in the ASS format, subtitle converters are inserted, for
+    example sd_srt.c, which is used to convert SRT->ASS. sd_srt.c is also used
+    as general converter for text->ASS (to prevent interpretation of text as
+    ASS tags).

    Text subtitles can be preloaded, in which case they are read fully as soon
-    as the subtitle is selected. In this case, they are effectively stored in
-    sd_ass.c's internal state.
+    as the subtitle is selected, and then effectively stored in an ASS_Track.
+    It's used for external text subtitles, and required to make codepage
+    detection as well as timing postprocessing work. (Timing postprocessing
+    removes tiny gaps or overlaps between subtitle events.)
+
+player/timeline/:
+    A timeline is the abstraction used by loadfile.c to combine several files
+    into one seemingly linear video. It's mainly used for ordered chapters
+    playback. The high level code to find and load other files containing the
+    segments for playing an ordered chapters file is in tl_matroska.c.

 etc/:
    The file input.conf is actually integrated into the mpv binary by the
    build system. It contains the default keybindings.
-
-Best practices and Concepts within mpv
-======================================
-
-General contribution etc.
-------------------------
-
-See: DOCS/contribute.md
-
-Error checking
--------------
-
-If an error is relevant, it should be handled. If it's interesting, log the
-error. However, mpv often keeps errors silent and reports failures somewhat
-coarsely by propagating them upwards the caller chain. This is OK, as long as
-the errors are not very interesting, or would require a developer to debug it
-anyway (in which case using a debugger would be more convenient, and the
-developer would need to add temporary debug printfs to get extremely detailed
-information which would not be appropriate during normal operation).
-
-Basically, keep a balance on error reporting. But always check them, unless you
-have a good argument not to.
-
-Memory allocation errors (OOM) are a special class of errors. Normally such
-allocation failures are not handled "properly". Instead, abort() is called.
-(New code should use MP_HANDLE_OOM() for this.) This is done out of laziness and
-for convenience, and due to the fact that MPlayer/mplayer2 never handled it
-correctly. (MPlayer varied between handling it correctly, trying to do so but
-failing, and just not caring, while mplayer2 started using abort() for it.)
-
-This is justifiable in a number of ways. Error handling paths are notoriously
-untested and buggy, so merely having them won't make your program more reliable.
-Having these error handling paths also complicates non-error code, due to the
-need to roll back state at any point after a memory allocation.
-
-Take any larger body of code, that is supposed to handle OOM, and test whether
-the error paths actually work, for example by overriding malloc with a version
-that randomly fails. You will find bugs quickly, and often they will be very
-annoying to fix (if you can even reproduce them).
-
-In addition, a clear indication that something went wrong may be missing. On
-error your program may exhibit "degraded" behavior by design. Consider a video
-encoder dropping frames somewhere in the middle of a video due to temporary
-allocation failures, instead of just exiting with an errors. In other cases, it
-may open conceptual security holes. Failing fast may be better.
-
-mpv uses GPU APIs, which may be break on allocation errors (because driver
-authors will have the same issues as described here), or don't even have a real
-concept for dealing with OOM (OpenGL).
-
-libmpv is often used by GUIs, which I predict always break if OOM happens.
-
-Last but not least, OSes like Linux use "overcommit", which basically means that
-your program may crash any time OOM happens, even if it doesn't use malloc() at
-all!
-
-But still, don't just assume malloc() always succeeds. Use MP_HANDLE_OOM(). The
-ta* APIs do this for you. The reason for this is that dereferencing a NULL
-pointer can have security relevant consequences if large offsets are involved.
-Also, a clear error message is better than a random segfault.
-
-Some big memory allocations are checked anyway. For example, all code must
-assume that allocating video frames or packets can fail. (The above example
-of dropping video frames during encoding is entirely possible in mpv.)
-
-Undefined behavior
------------------
-
-Undefined behavior (UB) is a concept in the C language. C is famous for being a
-language that makes it almost impossible to write working code, because
-undefined behavior is so easily triggered, compilers will happily abuse it to
-generate "faster" code, debugging tools will shout at you, and sometimes it
-even means your code doesn't work.
-
-There is a lot of literature on this topic. Read it.
-
-(In C's defense, UB exists in other languages too, but since they're not used
-for low level infrastructure, and/or these languages are at times not rigorously
-defined, simply nobody cares. However, the C standard committee is still guilty
-for not addressing this. I'll admit that I can't even tell from the standard's
-gibberish whether some specific behavior is UB or not. It's written like tax
-law.)
-
-In mpv, we generally try to avoid undefined behavior. For one, we want portable
-and reliable operation. But more importantly, we want clean output from
-debugging tools, in order to find real bugs more quickly and effectively.
-
-Avoid the "works in practice" argument. Once debugging tools come into play, or
-simply when "in practice" stops being true, this will all get back to you in a
-bad way.
-
-Global state, library safety
----------------------------
-
-Mutable global state is when code uses global variables that are not read-only.
-This must be avoided in mpv. Always use context structs that the caller of
-your code needs to allocate, and whose pointers are passed to your functions.
-
-Library safety means that your code (or library) can be used by a library
-without causing conflicts with other library users in the same process. To any
-piece of code, a "safe" library's API can simply be used, without having to
-worry about other API users that may be around somewhere.
-
-Libraries are often not library safe, because they use global mutable state
-or other "global" resources. Typical examples include use of signals, simple
-global variables (like hsearch() in libc), or internal caches not protected by
-locks.
-
-A surprisingly high number of libraries are not library safe because they need
-global initialization. Typically they provide an API function, which
-"initializes" the library, and which must be called before calling any other
-API functions. Often, you are to provide global configuration parameters, which
-can change the behavior of the library. If two libraries A and B use library C,
-but A and B initialize C with different parameters, something "bad" may happen.
-In addition, these global initialization functions are often not thread-safe. So
-if A and B try to initialize C at the same time (from different threads and
-without knowing about each other), it may cause undefined behavior. (libcurl is
-a good example of both of these issues. FFmpeg and some TLS libraries used to be
-affected, but improved.)
-
-This is so bad because library A and B from the previous example most likely
-have no way to cooperate, because they're from different authors and have no
-business knowing each others. They'd need a library D, which wraps library C
-in a safe way. Unfortunately, typically something worse happens: libraries get
-"infected" by the unsafeness of its sub-libraries, and export a global init API
-just to initialize the sub-libraries. In the previous example, libraries A and B
-would export global init APIs just to init library C, even though the rest of
-A/B are clean and library safe. (Again, libcurl is an example of this, if you
-subtract other historic anti-features.)
-
-The main problem with library safety is that its lack propagates to all
-libraries using the library.
-
-We require libmpv to be library safe. This is not really possible, because some
-libraries are not library safe (FFmpeg, Xlib, partially ALSA). However, for
-ideological reasons, there is no global init API, and best effort is made to try
-to avoid problems.
-
-libmpv has some features that are not library safe, but which are disabled by
-default (such as terminal usage aka stdout, or JSON IPC blocking SIGPIPE for
-internal convenience).
-
-A notable, very disgustingly library unsafe behavior of libmpv is calling
-abort() on some memory allocation failure. See error checking section.
-
-Logging
-------
-
-All logging and terminal output in mpv goes through the functions and macros
-provided in common/msg.h. This is in part for library safety, and in part to
-make sure users can silence all output, or to redirect the output elsewhere,
-like a log file or the internal console.lua script.
-
-Locking
-------
-
-See generally available literature. In mpv, we use pthread for this.
-
-Always keep locking clean. Don't skip locking just because it will work "in
-practice". (See undefined behavior section.) If your use case is simple, you may
-use C11 atomics (osdep/atomic.h for partial C99 support), but most likely you
-will only hurt yourself and others.
-
-Always make clear which fields in a struct are protected by which lock. If a
-field is immutable, or simply not thread-safe (e.g. state for a single worker
-thread), document it as well.
-
-Internal mpv APIs are assumed to be not thread-safe by default. If they have
-special guarantees (such as being usable by more than one thread at a time),
-these should be explicitly documented.
-
-All internal mpv APIs must be free of global state. Even if a component is not
-thread-safe, multiple threads can use _different_ instances of it without any
-locking.
-
-On a side note, recursive locks may seem convenient at first, but introduce
-additional problems with condition variables and locking hierarchies. They
-should be avoided.
-
-Locking hierarchy
-----------------
-
-A simple way to avoid deadlocks with classic locking is to define a locking
-hierarchy or lock order. If all threads acquire locks in the same order, no
-deadlocks will happen.
-
-For example, a "leaf" lock is a lock that is below all other locks in the
-hierarchy. You can acquire it any time, as long as you don't acquire other
-locks while holding it.
-
-Unfortunately, C has no way to declare or check the lock order, so you should at
-least document it.
-
-In addition, try to avoid exposing locks to the outside. Making the declaration
-of a lock private to a specific .c file (and _not_ exporting accessors or
-lock/unlock functions that manipulate the lock) is a good idea. Your component's
-API may acquire internal locks, but should release them when returning. Keeping
-the entire locking in a single file makes it easy to check it.
-
-Avoiding callback hell
----------------------
-
-mpv code is separated in components, like the "frontend" (i.e. MPContext mpctx),
-VOs, AOs, demuxers, and more. The frontend usually calls "down" the usage
-hierarchy: mpctx almost on top, then things like vo/ao, and utility code on the
-very bottom.
-
-"Callback hell" is when components call both up and down the hierarchy,
-which for example leads to accidentally recursion, reentrancy problems, or
-locking nightmares. This is avoided by (mostly) calling only down the hierarchy.
-Basically the call graph forms a DAG. The other direction is handled by event
-queues, wakeup callbacks, and similar mechanisms.
-
-Typically, a component provides an API, and does not know anything about its
-user. The API user (component higher in the hierarchy) polls the state of the
-lower component when needed.
-
-This also enforces some level of modularization, and with some luck the locking
-hierarchy. (Basically, locks of lower components automatically become leaf
-locks.) Another positive effect is simpler memory management.
-
-(Also see e.g.: http://250bpm.com/blog:24)
-
-Wakeup callbacks
----------------
-
-This is a common concept in mpv. Even the public API uses it. It's used when an
-API has internal threads (or otherwise triggers asynchronous events), but the
-component call hierarchy needs to be kept. The wakeup callback is the only
-exception to the call hierarchy, and always calls up.
-
-For example, vo spawns a thread that the API user (the mpv frontend) does not
-need to know about. vo simply provides a single-threaded API (or that looks like
-one). This API needs a way to notify the API user of new events. But the vo
-event producer is on the vo thread - it can't simply invoke a callback back into
-the API user, because then the API user has to deal with locking, despite not
-using threads. In addition, this will probably cause problems like mentioned in
-the "callback hell" section, especially lock order issues.
-
-The solution is the wakeup callback. It merely unblocks the API user from
-waiting, and the API user then uses the normal vo API to examine whether or
-which state changed. As a concept, it documents what a wakeup callback is
-allowed to do and what not, to avoid the aforementioned problems.
-
-Generally, you are not allowed to call any API from the wakeup callback. You
-just do whatever is needed to unblock your thread. For example, if it's waiting
-on a mutex/condition variable, acquire the mutex, set a change flag, signal
-the condition variable, unlock, return. (This mutex must not be held when
-calling the API. It must be a leaf lock.)
-
-Restricting the wakeup callback like this sidesteps any reentrancy issues and
-other complexities. The API implementation can simply hold internal (and
-non-recursive) locks while invoking the wakeup callback.
-
-The API user still needs to deal with locking (probably), but there's only the
-need to implement a single "receiver", that can handle the entire API of the
-used component. (Or multiple APIs - MPContext for example has only 1 wakeup
-callback that handles all AOs, VOs, input, demuxers, and more. It simple re-runs
-the playloop.)
-
-You could get something more advanced by turning this into a message queue. The
-API would append a message to the queue, and the API user can read it. But then
-you still need a way to "wakeup" the API user (unless you force the API user
-to block on your API, which will make things inconvenient for the API user). You
-also need to worry about what happens if the message queue overruns (you either
-lose messages or have unbounded memory usage). In the mpv public API, the
-distinction between message queue and wakeup callback is sort of blurry, because
-it does provide a message queue, but an additional wakeup callback, so API
-users are not required to call mpv_wait_event() with a high timeout.
-
-mpv itself prefers using wakeup callbacks over a generic event queue, because
-most times an event queue is not needed (or complicates things), and it is
-better to do it manually.
-
-(You could still abstract the API user side of wakeup callback handling, and
-avoid reimplementing it all the time. Although mp_dispatch_queue already
-provides mechanisms for this.)
-
-Condition variables
-------------------
-
-They're used whenever a thread needs to wait for something, without nonsense
-like sleep calls or busy waiting. mpv uses the standard pthread API for this.
-There's a lot of literature on it. Read it.
-
-For initial understanding, it may be helpful to know that condition variables
-are not variables that signal a condition. pthread_cond_t does not have any
-state per-se. Maybe pthread_cond_t would better be named pthread_interrupt_t,
-because its sole purpose is to interrupt a thread waiting via pthread_cond_wait()
-(or similar). The "something" in "waiting for something" can be called
-predicate (to avoid confusing it with "condition"). Consult literature for the
-proper terms.
-
-The very short version is...
-
-Shared declarations:
-
-    pthread_mutex_t lock;
-    pthread_cond_t cond_var;
-    struct something state_var; // protected by lock, changes signaled by cond_var
-
-Waiter thread:
-
-    pthread_mutex_lock(&lock);
-
-    // Wait for a change in state_var. We want to wait until predicate_fulfilled()
-    // returns true.
-    // Must be a loop for 2 reasons:
-    //  1. cond_var may be associated with other conditions too
-    //  2. pthread_cond_wait() can have sporadic wakeups
-    while (!predicate_fulfilled(&state_var)) {
-        // This unlocks, waits for cond_var to be signaled, and then locks again.
-        // The _whole_ point of cond_var is that unlocking and waiting for the
-        // signal happens atomically.
-        pthread_cond_wait(&cond_var, &lock);
-    }
-
-    // Here you may react to the state change. The state cannot change
-    // asynchronously as long as you still hold the lock (and didn't release
-    // and reacquire it).
-    // ...
-
-    pthread_mutex_unlock(&lock);
-
-Signaler thread:
-
-    pthread_mutex_lock(&lock);
-
-    // Something changed. Update the shared variable with the new state.
-    update_state(&state_var);
-
-    // Notify that something changed. This will wake up the waiter thread if
-    // it's blocked in pthread_cond_wait(). If not, nothing happens.
-    pthread_cond_broadcast(&cond_var);
-
-    // Fun fact: good implementations wake up the waiter only when the lock is
-    // released, to reduce kernel scheduling overhead.
-    pthread_mutex_unlock(&lock);
-
-Some basic rules:
-    1. Always access your state under proper locking
-    2. Always check your predicate before every call to pthread_cond_wait()
-       (And don't call pthread_cond_wait() if the predicate is fulfilled.)
-    3. Always call pthread_cond_wait() in a loop
-       (And only if your predicate failed without releasing the lock..)
-    4. Always call pthread_cond_broadcast()/_signal() inside of its associated
-       lock
-
-mpv sometimes violates rule 3, and leaves "retrying" (i.e. looping) to the
-caller.
-
-Common pitfalls:
-    - Thinking that pthread_cond_t is some kind of semaphore, or holds any
-       application state or the user predicate (it _only_ wakes up threads
-       that are at the same time blocking on pthread_cond_wait() and friends,
-       nothing else)
-    - Changing the predicate, but not updating all pthread_cond_broadcast()/
-      _signal() calls correctly
-    - Forgetting that pthread_cond_wait() unlocks the lock (other threads can
-      and must acquire the lock)
-    - Holding multiple nested locks while trying to wait (=> deadlock, violates
-      the lock order anyway)
-    - Waiting for a predicate correctly, but unlocking/relocking before acting
-      on it (unlocking allows arbitrary state changes)
-    - Confusing which lock/condition var. is used to manage a bit of state
-
-Generally available literature probably has better examples and explanations.
-
-Using condition variables the proper way is generally preferred over using more
-messy variants of them. (Just saying because on win32, "SetEvent" exists, and
-it's inferior to condition variables. Try to avoid the win32 primitives, even if
-you're dealing with Windows-only code.)
-
-Threads
-------
-
-Threading should be conservatively used. Normally, mpv code pretends to be
-single-threaded, and provides thread-unsafe APIs. Threads are used coarsely,
-and if you can avoid messing with threads, you should. For example, VOs and AOs
-do not need to deal with threads normally, even though they run on separate
-threads. The glue code "isolates" them from any threading issues.
@@ -46,7 +46,7 @@ mpv's custom configure step on top of waf

 To some extents mpv has a custom build system written on top of waf. This
 document will not go over the standard waf behaviour as that is documented in
-the `Waf book <https://waf.io/book/>`_.
+the `Waf book <http://docs.waf.googlecode.com/git/book_17/single.html>`_.

 All of the configuration process is handled with a declarative approach. Lists
 of dictionaries define the checks, and some custom Python code traverses these
@@ -146,7 +146,7 @@ mpv's custom build step on top of waf

 Build step is pretty much vanilla waf. The only difference being that the list
 of source files can contain both strings or tuples. If a tuple is found,
-the second element in the tuple will be used to match the features detected
+the second element in the tuple will the used to match the features detected
 in the configure step (the ``name`` field described above). If this feature
 was not enabled during configure, the source file will not be compiled in.

@@ -1,8 +1,8 @@
                    GNU GENERAL PUBLIC LICENSE
                       Version 2, June 1991

- Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+        51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

@@ -15,7 +15,7 @@ software--to make sure the software is free for all its users.  This
 General Public License applies to most of the Free Software
 Foundation's software and to any other program whose authors commit to
 using it.  (Some other Free Software Foundation software is covered by
-the GNU Lesser General Public License instead.)  You can apply it to
+the GNU Library General Public License instead.)  You can apply it to
 your programs, too.

  When we speak of free software, we are referring to freedom, not
@@ -55,7 +55,7 @@ patent must be licensed for everyone's free use or not licensed at all.

  The precise terms and conditions for copying, distribution and
 modification follow.
-
+
                    GNU GENERAL PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

@@ -110,7 +110,7 @@ above, provided that you also meet all of these conditions:
    License.  (Exception: if the Program itself is interactive but
    does not normally print such an announcement, your work based on
    the Program is not required to print an announcement.)
-
+
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
@@ -168,7 +168,7 @@ access to copy from a designated place, then offering equivalent
 access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
-
+
  4. You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
@@ -225,7 +225,7 @@ impose that choice.

 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
-
+
  8. If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
@@ -278,7 +278,7 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.

                     END OF TERMS AND CONDITIONS
-
+
            How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
@@ -303,9 +303,10 @@ the "copyright" line and a pointer to where the full notice is found.
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

-    You should have received a copy of the GNU General Public License along
-    with this program; if not, write to the Free Software Foundation, Inc.,
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+

 Also add information on how to contact you by electronic and paper mail.

@@ -335,5 +336,5 @@ necessary.  Here is a sample; alter the names:
 This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
-library.  If this is what you want to do, use the GNU Lesser General
+library.  If this is what you want to do, use the GNU Library General
 Public License instead of this License.
@@ -1,502 +0,0 @@
-                  GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 2.1, February 1999
-
- Copyright (C) 1991, 1999 Free Software Foundation, Inc.
- 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-[This is the first released version of the Lesser GPL.  It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-
-                            Preamble
-
-  The licenses for most software are designed to take away your
-freedom to share and change it.  By contrast, the GNU General Public
-Licenses are intended to guarantee your freedom to share and change
-free software--to make sure the software is free for all its users.
-
-  This license, the Lesser General Public License, applies to some
-specially designated software packages--typically libraries--of the
-Free Software Foundation and other authors who decide to use it.  You
-can use it too, but we suggest you first think carefully about whether
-this license or the ordinary General Public License is the better
-strategy to use in any particular case, based on the explanations below.
-
-  When we speak of free software, we are referring to freedom of use,
-not price.  Our General Public Licenses are designed to make sure that
-you have the freedom to distribute copies of free software (and charge
-for this service if you wish); that you receive source code or can get
-it if you want it; that you can change the software and use pieces of
-it in new free programs; and that you are informed that you can do
-these things.
-
-  To protect your rights, we need to make restrictions that forbid
-distributors to deny you these rights or to ask you to surrender these
-rights.  These restrictions translate to certain responsibilities for
-you if you distribute copies of the library or if you modify it.
-
-  For example, if you distribute copies of the library, whether gratis
-or for a fee, you must give the recipients all the rights that we gave
-you.  You must make sure that they, too, receive or can get the source
-code.  If you link other code with the library, you must provide
-complete object files to the recipients, so that they can relink them
-with the library after making changes to the library and recompiling
-it.  And you must show them these terms so they know their rights.
-
-  We protect your rights with a two-step method: (1) we copyright the
-library, and (2) we offer you this license, which gives you legal
-permission to copy, distribute and/or modify the library.
-
-  To protect each distributor, we want to make it very clear that
-there is no warranty for the free library.  Also, if the library is
-modified by someone else and passed on, the recipients should know
-that what they have is not the original version, so that the original
-author's reputation will not be affected by problems that might be
-introduced by others.
-
-  Finally, software patents pose a constant threat to the existence of
-any free program.  We wish to make sure that a company cannot
-effectively restrict the users of a free program by obtaining a
-restrictive license from a patent holder.  Therefore, we insist that
-any patent license obtained for a version of the library must be
-consistent with the full freedom of use specified in this license.
-
-  Most GNU software, including some libraries, is covered by the
-ordinary GNU General Public License.  This license, the GNU Lesser
-General Public License, applies to certain designated libraries, and
-is quite different from the ordinary General Public License.  We use
-this license for certain libraries in order to permit linking those
-libraries into non-free programs.
-
-  When a program is linked with a library, whether statically or using
-a shared library, the combination of the two is legally speaking a
-combined work, a derivative of the original library.  The ordinary
-General Public License therefore permits such linking only if the
-entire combination fits its criteria of freedom.  The Lesser General
-Public License permits more lax criteria for linking other code with
-the library.
-
-  We call this license the "Lesser" General Public License because it
-does Less to protect the user's freedom than the ordinary General
-Public License.  It also provides other free software developers Less
-of an advantage over competing non-free programs.  These disadvantages
-are the reason we use the ordinary General Public License for many
-libraries.  However, the Lesser license provides advantages in certain
-special circumstances.
-
-  For example, on rare occasions, there may be a special need to
-encourage the widest possible use of a certain library, so that it becomes
-a de-facto standard.  To achieve this, non-free programs must be
-allowed to use the library.  A more frequent case is that a free
-library does the same job as widely used non-free libraries.  In this
-case, there is little to gain by limiting the free library to free
-software only, so we use the Lesser General Public License.
-
-  In other cases, permission to use a particular library in non-free
-programs enables a greater number of people to use a large body of
-free software.  For example, permission to use the GNU C Library in
-non-free programs enables many more people to use the whole GNU
-operating system, as well as its variant, the GNU/Linux operating
-system.
-
-  Although the Lesser General Public License is Less protective of the
-users' freedom, it does ensure that the user of a program that is
-linked with the Library has the freedom and the wherewithal to run
-that program using a modified version of the Library.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.  Pay close attention to the difference between a
-"work based on the library" and a "work that uses the library".  The
-former contains code derived from the library, whereas the latter must
-be combined with the library in order to run.
-
-                  GNU LESSER GENERAL PUBLIC LICENSE
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-  0. This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or
-other authorized party saying it may be distributed under the terms of
-this Lesser General Public License (also called "this License").
-Each licensee is addressed as "you".
-
-  A "library" means a collection of software functions and/or data
-prepared so as to be conveniently linked with application programs
-(which use some of those functions and data) to form executables.
-
-  The "Library", below, refers to any such software library or work
-which has been distributed under these terms.  A "work based on the
-Library" means either the Library or any derivative work under
-copyright law: that is to say, a work containing the Library or a
-portion of it, either verbatim or with modifications and/or translated
-straightforwardly into another language.  (Hereinafter, translation is
-included without limitation in the term "modification".)
-
-  "Source code" for a work means the preferred form of the work for
-making modifications to it.  For a library, complete source code means
-all the source code for all modules it contains, plus any associated
-interface definition files, plus the scripts used to control compilation
-and installation of the library.
-
-  Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope.  The act of
-running a program using the Library is not restricted, and output from
-such a program is covered only if its contents constitute a work based
-on the Library (independent of the use of the Library in a tool for
-writing it).  Whether that is true depends on what the Library does
-and what the program that uses the Library does.
-
-  1. You may copy and distribute verbatim copies of the Library's
-complete source code as you receive it, in any medium, provided that
-you conspicuously and appropriately publish on each copy an
-appropriate copyright notice and disclaimer of warranty; keep intact
-all the notices that refer to this License and to the absence of any
-warranty; and distribute a copy of this License along with the
-Library.
-
-  You may charge a fee for the physical act of transferring a copy,
-and you may at your option offer warranty protection in exchange for a
-fee.
-
-  2. You may modify your copy or copies of the Library or any portion
-of it, thus forming a work based on the Library, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
-    a) The modified work must itself be a software library.
-
-    b) You must cause the files modified to carry prominent notices
-    stating that you changed the files and the date of any change.
-
-    c) You must cause the whole of the work to be licensed at no
-    charge to all third parties under the terms of this License.
-
-    d) If a facility in the modified Library refers to a function or a
-    table of data to be supplied by an application program that uses
-    the facility, other than as an argument passed when the facility
-    is invoked, then you must make a good faith effort to ensure that,
-    in the event an application does not supply such function or
-    table, the facility still operates, and performs whatever part of
-    its purpose remains meaningful.
-
-    (For example, a function in a library to compute square roots has
-    a purpose that is entirely well-defined independent of the
-    application.  Therefore, Subsection 2d requires that any
-    application-supplied function or table used by this function must
-    be optional: if the application does not supply it, the square
-    root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole.  If
-identifiable sections of that work are not derived from the Library,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works.  But when you
-distribute the same sections as part of a whole which is a work based
-on the Library, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Library.
-
-In addition, mere aggregation of another work not based on the Library
-with the Library (or with a work based on the Library) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-  3. You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library.  To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License.  (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.)  Do not make any other change in
-these notices.
-
-  Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-
-  This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-
-  4. You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you accompany
-it with the complete corresponding machine-readable source code, which
-must be distributed under the terms of Sections 1 and 2 above on a
-medium customarily used for software interchange.
-
-  If distribution of object code is made by offering access to copy
-from a designated place, then offering equivalent access to copy the
-source code from the same place satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-  5. A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library".  Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-
-  However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library".  The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-
-  When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library.  The
-threshold for this to be true is not precisely defined by law.
-
-  If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work.  (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-
-  Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-
-  6. As an exception to the Sections above, you may also combine or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
-  You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License.  You must supply a copy of this License.  If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License.  Also, you must do one
-of these things:
-
-    a) Accompany the work with the complete corresponding
-    machine-readable source code for the Library including whatever
-    changes were used in the work (which must be distributed under
-    Sections 1 and 2 above); and, if the work is an executable linked
-    with the Library, with the complete machine-readable "work that
-    uses the Library", as object code and/or source code, so that the
-    user can modify the Library and then relink to produce a modified
-    executable containing the modified Library.  (It is understood
-    that the user who changes the contents of definitions files in the
-    Library will not necessarily be able to recompile the application
-    to use the modified definitions.)
-
-    b) Use a suitable shared library mechanism for linking with the
-    Library.  A suitable mechanism is one that (1) uses at run time a
-    copy of the library already present on the user's computer system,
-    rather than copying library functions into the executable, and (2)
-    will operate properly with a modified version of the library, if
-    the user installs one, as long as the modified version is
-    interface-compatible with the version that the work was made with.
-
-    c) Accompany the work with a written offer, valid for at
-    least three years, to give the same user the materials
-    specified in Subsection 6a, above, for a charge no more
-    than the cost of performing this distribution.
-
-    d) If distribution of the work is made by offering access to copy
-    from a designated place, offer equivalent access to copy the above
-    specified materials from the same place.
-
-    e) Verify that the user has already received a copy of these
-    materials or that you have already sent this user a copy.
-
-  For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it.  However, as a special exception,
-the materials to be distributed need not include anything that is
-normally distributed (in either source or binary form) with the major
-components (compiler, kernel, and so on) of the operating system on
-which the executable runs, unless that component itself accompanies
-the executable.
-
-  It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system.  Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-
-  7. You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-
-    a) Accompany the combined library with a copy of the same work
-    based on the Library, uncombined with any other library
-    facilities.  This must be distributed under the terms of the
-    Sections above.
-
-    b) Give prominent notice with the combined library of the fact
-    that part of it is a work based on the Library, and explaining
-    where to find the accompanying uncombined form of the same work.
-
-  8. You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License.  Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library is void, and will automatically terminate your
-rights under this License.  However, parties who have received copies,
-or rights, from you under this License will not have their licenses
-terminated so long as such parties remain in full compliance.
-
-  9. You are not required to accept this License, since you have not
-signed it.  However, nothing else grants you permission to modify or
-distribute the Library or its derivative works.  These actions are
-prohibited by law if you do not accept this License.  Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-
-  10. Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-subject to these terms and conditions.  You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties with
-this License.
-
-  11. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Library at all.  For example, if a patent
-license would not permit royalty-free redistribution of the Library by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply,
-and the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system which is
-implemented by public license practices.  Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-  12. If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library under this License may add
-an explicit geographical distribution limitation excluding those countries,
-so that distribution is permitted only in or among countries not thus
-excluded.  In such case, this License incorporates the limitation as if
-written in the body of this License.
-
-  13. The Free Software Foundation may publish revised and/or new
-versions of the Lesser General Public License from time to time.
-Such new versions will be similar in spirit to the present version,
-but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number.  If the Library
-specifies a version number of this License which applies to it and
-"any later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-the Free Software Foundation.  If the Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-
-  14. If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-write to the author to ask for permission.  For software which is
-copyrighted by the Free Software Foundation, write to the Free
-Software Foundation; we sometimes make exceptions for this.  Our
-decision will be guided by the two goals of preserving the free status
-of all derivatives of our free software and of promoting the sharing
-and reuse of software generally.
-
-                            NO WARRANTY
-
-  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
-KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
-LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
-AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
-FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
-CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
-LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-                     END OF TERMS AND CONDITIONS
-
-           How to Apply These Terms to Your New Libraries
-
-  If you develop a new library, and you want it to be of the greatest
-possible use to the public, we recommend making it free software that
-everyone can redistribute and change.  You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms of the
-ordinary General Public License).
-
-  To apply these terms, attach the following notices to the library.  It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the library's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This library is free software; you can redistribute it and/or
-    modify it under the terms of the GNU Lesser General Public
-    License as published by the Free Software Foundation; either
-    version 2.1 of the License, or (at your option) any later version.
-
-    This library is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-    Lesser General Public License for more details.
-
-    You should have received a copy of the GNU Lesser General Public
-    License along with this library; if not, write to the Free Software
-    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the
-  library `Frob' (a library for tweaking knobs) written by James Random Hacker.
-
-  <signature of Ty Coon>, 1 April 1990
-  Ty Coon, President of Vice
-
-That's all there is to it!
@@ -1,99 +1,61 @@
-![mpv logo](https://raw.githubusercontent.com/mpv-player/mpv.io/master/source/images/mpv-logo-128.png)
+![http://mpv.io/](https://raw.githubusercontent.com/mpv-player/mpv.io/master/source/images/mpv-logo-128.png)

-# mpv
+## mpv
+
+--------------


-* [External links](#external-links)
 * [Overview](#overview)
-* [System requirements](#system-requirements)
 * [Downloads](#downloads)
-* [Changelog](#changelog)
 * [Compilation](#compilation)
+* [FFmpeg vs. Libav](#ffmpeg-vs-libav)
 * [Release cycle](#release-cycle)
 * [Bug reports](#bug-reports)
 * [Contributing](#contributing)
-* [License](#license)
-* [Contact](#contact)
-
-
-## External links
-
-
+* [Relation to MPlayer and mplayer2](#relation-to-mplayer-and-mplayer2)
 * [Wiki](https://github.com/mpv-player/mpv/wiki)
-* [FAQ][FAQ]
-* [Manual](https://mpv.io/manual/master/)
-
+* [Man pages](http://mpv.io/manual/master/)
+* [Contact](#contact)
+* [License](#license)

 ## Overview


-**mpv** is a free (as in freedom) media player for the command line. It supports
-a wide variety of media file formats, audio and video codecs, and subtitle types.
-
-There is a [FAQ][FAQ].
+**mpv** is a media player based on MPlayer and mplayer2. It supports a wide
+variety of video file formats, audio and video codecs, and subtitle types.

 Releases can be found on the [release list][releases].

 ## System requirements

- A not too ancient Linux, Windows 7 or later, or OSX 10.8 or later.
- A somewhat capable CPU. Hardware decoding might help if the CPU is too slow to
-  decode video in realtime, but must be explicitly enabled with the `--hwdec`
-  option.
- A not too crappy GPU. mpv's focus is not on power-efficient playback on
-  embedded or integrated GPUs (for example, hardware decoding is not even
-  enabled by default). Low power GPUs may cause issues like tearing, stutter,
-  etc. The main video output uses shaders for video rendering and scaling,
-  rather than GPU fixed function hardware. On Windows, you might want to make
-  sure the graphics drivers are current. In some cases, ancient fallback video
-  output methods can help (such as `--vo=xv` on Linux), but this use is not
+- A not too ancient Linux, or Windows Vista or later, or OSX 10.8 or later.
+- A somewhat capable CPU. Hardware decoding might sometimes help if the CPU
+  is too slow to decode video realtime, but must be explicitly enabled with
+  the `--hwdec` option. On Windows, a CPU with SSE4 instruction set is required
+  to get decent hardware decoding performance.
+- A not too crappy GPU. mpv is not intended to be used with bad GPUs. There are
+  many caveats with drivers or system compositors causing tearing, stutter,
+  etc. On Windows, you might want to make sure the graphics drivers are
+  current, especially OpenGL. In some cases, ancient fallback video output
+  methods can help (such as `--vo=xv` on Linux), but this use is not
  recommended or supported.

+
 ## Downloads


 For semi-official builds and third-party packages please see
-[mpv.io/installation](https://mpv.io/installation/).
-
-## Changelog
-
-
-There is no complete changelog; however, changes to the player core interface
-are listed in the [interface changelog][interface-changes].
-
-Changes to the C API are documented in the [client API changelog][api-changes].
-
-The [release list][releases] has a summary of most of the important changes
-on every release.
-
-Changes to the default key bindings are indicated in
-[restore-old-bindings.conf][restore-old-bindings].
+[mpv.io](http://mpv.io/installation/).

 ## Compilation


 Compiling with full features requires development files for several
-external libraries. One of the two build systems supported by mpv is required:
-[meson](https://mesonbuild.com/index.html) or [waf](https://waf.io/). Meson
-can be obtained from your distro or PyPI. Waf can be downloaded by using the
-`./bootstrap.py` script. It will get the latest version of waf that was tested
-with mpv. Some documentation about the differences between the build systems are
-located in [build-system-differences][build-system-differences].
+external libraries. Below is a list of some important requirements.

-### Meson
-
-After creating your build directory (e.g. `meson setup build`), you can view a list
-of all the build options via `meson configure build`. You could also just simply
-look at the `meson_options.txt` file. Logs are stored in `meson-logs` within
-your build directory.
-
-Example:
-
-    meson setup build
-    meson compile -C build
-    meson install -C build
-
-### Waf
+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
@@ -101,77 +63,80 @@ detect it, the file `build/config.log` may contain information about the
 reasons for the failure.

 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 or
-enabled 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`.
+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`.

 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.

-Example:
-
-    ./bootstrap.py
-    ./waf configure
-    ./waf
-    ./waf install
-
 Essential dependencies (incomplete list):

 - gcc or clang
- X development headers (xlib, xrandr, xext, xscrnsaver, xinerama, libvdpau,
-  libGL, GLX, EGL, xv, ...)
+- X development headers (xlib, X extensions, libvdpau, libGL, libXv, ...)
 - Audio output development headers (libasound/ALSA, pulseaudio)
 - FFmpeg libraries (libavutil libavcodec libavformat libswscale libavfilter
  and either libswresample or libavresample)
+  At least FFmpeg 2.4.0 or Libav 11 is required.
 - zlib
 - iconv (normally provided by the system libc)
 - libass (OSD, OSC, text subtitles)
 - Lua (optional, required for the OSC pseudo-GUI and youtube-dl integration)
 - libjpeg (optional, used for screenshots only)
 - uchardet (optional, for subtitle charset detection)
- nvdec and vaapi libraries for hardware decoding on Linux (optional)
+- vdpau and vaapi libraries for hardware decoding on Linux (optional)

-Libass dependencies (when building libass):
+Libass dependencies:

 - gcc or clang, yasm on x86 and x86_64
 - fribidi, freetype, fontconfig development headers (for libass)
- harfbuzz (required for correct rendering of combining characters, particularly
-  for correct rendering of non-English text on OSX, and Arabic/Indic scripts on
-  any platform)
+- harfbuzz (optional, required for correct rendering of combining characters,
+  particularly for correct rendering of non-English text on OSX, and
+  Arabic/Indic scripts on any platform)

-FFmpeg dependencies (when building FFmpeg):
+FFmpeg dependencies:

 - gcc or clang, yasm on x86 and x86_64
- OpenSSL or GnuTLS (have to be explicitly enabled when compiling FFmpeg)
- libx264/libmp3lame/libfdk-aac if you want to use encoding (have to be
-  explicitly enabled when compiling FFmpeg)
- For native DASH playback, FFmpeg needs to be built with --enable-libxml2
-  (although there are security implications, and DASH support has lots of bugs).
- AV1 decoding support requires dav1d.
- For good nvidia support on Linux, make sure nv-codec-headers is installed
-  and can be found by configure.
+- OpenSSL (has to be explicitly enabled when compiling ffmpeg)
+- libx264/libmp3lame/libfdk-aac if you want to use encoding (has to be
+  explicitly enabled when compiling ffmpeg)
+- Libav also works, but some features will not work. (See section below.)

 Most of the above libraries are available in suitable versions on normal
-Linux distributions. For ease of compiling the latest git master of everything,
-you may wish to use the separately available build wrapper ([mpv-build][mpv-build])
-which first compiles FFmpeg libraries and libass, and then compiles the player
-statically linked against those.
+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
+the separately available build wrapper ([mpv-build][mpv-build]) that first compiles FFmpeg
+libraries and libass, and then compiles the player statically linked against
+those.

 If you want to build a Windows binary, you either have to use MSYS2 and MinGW,
-or cross-compile from Linux with MinGW. See
-[Windows compilation][windows_compilation].
+or cross-compile from Linux with MinGW. See [Windows compilation][windows_compilation].
+
+
+## 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 (subtitle formats in particular).


 ## Release cycle

-Every other month, an arbitrary git snapshot is made, and is assigned
-a 0.X.0 version number. No further maintenance is done.

-The goal of releases is to make Linux distributions happy. Linux distributions
-are also expected to apply their own patches in case of bugs and security
-issues.
+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.

 Releases other than the latest release are unsupported and unmaintained.

@@ -181,53 +146,60 @@ See the [release policy document][release-policy] for more information.


 Please use the [issue tracker][issue-tracker] provided by GitHub to send us bug
-reports or feature requests. Follow the template's instructions or the issue
-will likely be ignored or closed as invalid.
-
-Using the bug tracker as place for simple questions is fine but IRC is
-recommended (see [Contact](#Contact) below).
+reports or feature requests.

 ## Contributing


-Please read [contribute.md][contribute.md].
-
 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.

-You can check [the wiki](https://github.com/mpv-player/mpv/wiki/Stuff-to-do)
-or the [issue tracker](https://github.com/mpv-player/mpv/issues?q=is%3Aopen+is%3Aissue+label%3Ameta%3Afeature-request)
-for ideas on what you could contribute with.
+## Relation to MPlayer and mplayer2

-## License

-GPLv2 "or later" by default, LGPLv2.1 "or later" with `--enable-lgpl`.
-See [details.](https://github.com/mpv-player/mpv/blob/master/Copyright)
+mpv is based on mplayer2, which in turn is based on the original MPlayer
+(also called mplayer, mplayer-svn, mplayer1). Many changes have been made, a
+large part of which is incompatible or completely changes how the player
+behaves. Although there are still many similarities to its ancestors, mpv
+should generally be treated as a completely different program.

-## History
+mpv was forked because we wanted to modernize MPlayer. This includes
+removing cruft (including features which stopped making sense 10 years ago),
+and of course adding modern features. Such huge and intrusive changes made it
+infeasible to work directly with MPlayer, which is mostly focused on
+preservation, so a fork had to be made. (Actually, mpv is based on mplayer2,
+which already started this process of removing cruft.)

-This software is based on the MPlayer project. Before mpv existed as a project,
-the code base was briefly developed under the mplayer2 project. For details,
-see the [FAQ][FAQ].
+In general, mpv should be considered a completely new program, rather than a
+MPlayer drop-in replacement.
+
+If you are wondering what's different from mplayer2 and MPlayer, an incomplete
+list of changes is located [here][mplayer-changes].

 ## Contact


-Most activity happens on the IRC channel and the github issue tracker.
+Most activity happens on the IRC channel and the github issue tracker. The
+mailing lists are mostly unused.

- **GitHub issue tracker**: [issue tracker][issue-tracker] (report bugs here)
- **User IRC Channel**: `#mpv` on `irc.libera.chat`
- **Developer IRC Channel**: `#mpv-devel` on `irc.libera.chat`
+ - **GitHub issue tracker**: [issue tracker][issue-tracker] (report bugs here)
+ - **User IRC Channel**: `#mpv` on `irc.freenode.net`
+ - **Developer IRC Channel**: `#mpv-devel` on `irc.freenode.net`
+
+To contact the `mpv` team in private write to `mpv-team@googlegroups.com`. Use
+only if discretion is required.

-[FAQ]: https://github.com/mpv-player/mpv/wiki/FAQ
 [releases]: https://github.com/mpv-player/mpv/releases
 [mpv-build]: https://github.com/mpv-player/mpv-build
+[homebrew-mpv]: https://github.com/mpv-player/homebrew-mpv
 [issue-tracker]:  https://github.com/mpv-player/mpv/issues
+[ffmpeg_vs_libav]: https://github.com/mpv-player/mpv/wiki/FFmpeg-versus-Libav
 [release-policy]: https://github.com/mpv-player/mpv/blob/master/DOCS/release-policy.md
 [windows_compilation]: https://github.com/mpv-player/mpv/blob/master/DOCS/compile-windows.md
-[interface-changes]: https://github.com/mpv-player/mpv/blob/master/DOCS/interface-changes.rst
-[api-changes]: https://github.com/mpv-player/mpv/blob/master/DOCS/client-api-changes.rst
-[restore-old-bindings]: https://github.com/mpv-player/mpv/blob/master/etc/restore-old-bindings.conf
-[contribute.md]: https://github.com/mpv-player/mpv/blob/master/DOCS/contribute.md
-[build-system-differences]: https://github.com/mpv-player/mpv/blob/master/DOCS/build-system-differences.md
+[mplayer-changes]: https://github.com/mpv-player/mpv/blob/master/DOCS/mplayer-changes.rst
+
+## License
+
+
+Mostly GPLv2 or later. See [details.](https://github.com/mpv-player/mpv/blob/master/Copyright)
@@ -1,24 +0,0 @@
-#!/usr/bin/bash
-set -e
-
-export DEST_OS=win32
-export CC=gcc
-export PKG_CONFIG=/usr/bin/pkg-config
-export PERL=/usr/bin/perl
-export PYTHON=/usr/bin/python3
-
-"$PYTHON" bootstrap.py
-"$PYTHON" waf configure \
-    --check-c-compiler=gcc \
-    --enable-spirv-cross \
-    --enable-d3d-hwaccel \
-    --enable-d3d11 \
-    --enable-jpeg \
-    --enable-lcms2 \
-    --enable-libarchive \
-    --enable-lua \
-    --enable-rubberband \
-    --enable-shaderc \
-    --enable-uchardet \
-    --enable-vulkan
-"$PYTHON" waf build
@@ -1,54 +0,0 @@
-#!/usr/bin/bash
-set -e
-
-export PYTHON=/usr/bin/python3
-
-# Write an empty fonts.conf to speed up fc-cache
-export FONTCONFIG_FILE=/dummy-fonts.conf
-cat >"$FONTCONFIG_FILE" <<EOF
-<?xml version="1.0"?>
-<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
-<fontconfig></fontconfig>
-EOF
-
-# Install build dependencies for mpv
-pacman -S --noconfirm --needed \
-    $MINGW_PACKAGE_PREFIX-toolchain \
-    $MINGW_PACKAGE_PREFIX-cmake \
-    $MINGW_PACKAGE_PREFIX-lcms2 \
-    $MINGW_PACKAGE_PREFIX-libarchive \
-    $MINGW_PACKAGE_PREFIX-libass \
-    $MINGW_PACKAGE_PREFIX-libjpeg-turbo \
-    $MINGW_PACKAGE_PREFIX-libplacebo \
-    $MINGW_PACKAGE_PREFIX-lua51 \
-    $MINGW_PACKAGE_PREFIX-ninja \
-    $MINGW_PACKAGE_PREFIX-rubberband \
-    $MINGW_PACKAGE_PREFIX-shaderc \
-    $MINGW_PACKAGE_PREFIX-spirv-cross \
-    $MINGW_PACKAGE_PREFIX-uchardet \
-    $MINGW_PACKAGE_PREFIX-vulkan
-
-# Delete unused packages to reduce space used in the Appveyor cache
-pacman -Sc --noconfirm
-
-# Compile ffmpeg
-(
-    git clone --depth=1 https://github.com/FFmpeg/ffmpeg.git && cd ffmpeg
-
-    mkdir build && cd build
-    ../configure \
-        --prefix=$MINGW_PREFIX \
-        --target-os=mingw32 \
-        --arch=$MSYSTEM_CARCH \
-        --disable-static \
-        --disable-doc \
-        --disable-asm \
-        --enable-gpl \
-        --enable-version3 \
-        --enable-shared \
-        --enable-pic \
-        --enable-d3d11va \
-        --enable-dxva2 \
-        --enable-schannel
-    make -j4 install
-)
@@ -1,4 +1,4 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python

 import re
 import os
@@ -20,24 +20,12 @@ def is_user_lib(objfile, libname):
           not "libc." in libname and \
           not "libgcc." in libname and \
           not os.path.basename(libname) == 'Python' and \
-           not os.path.basename(objfile) in libname and \
-           not "libswift" in libname
+           not os.path.basename(objfile) in libname

 def otool(objfile):
-    command = "otool -L '%s' | grep -e '\t' | awk '{ print $1 }'" % objfile
-    output  = subprocess.check_output(command, shell = True, universal_newlines=True)
-    return set(filter(partial(is_user_lib, objfile), output.split()))
-
-def get_rpaths_dev_tools(binary):
-    command = "otool -l '%s' | grep -A2 LC_RPATH | grep path | grep \"Xcode\|CommandLineTools\"" % binary
-    result  = subprocess.check_output(command, shell = True, universal_newlines=True)
-    pathRe = re.compile("^\s*path (.*) \(offset \d*\)$")
-    output = []
-
-    for line in result.splitlines():
-        output.append(pathRe.search(line).group(1).strip())
-
-    return output
+    command = "otool -L %s | grep -e '\t' | awk '{ print $1 }'" % objfile
+    output  = subprocess.check_output(command, shell = True)
+    return filter(partial(is_user_lib, objfile), output.split())

 def install_name_tool_change(old, new, objfile):
    subprocess.call(["install_name_tool", "-change", old, new, objfile])
@@ -45,15 +33,9 @@ def install_name_tool_change(old, new, objfile):
 def install_name_tool_id(name, objfile):
    subprocess.call(["install_name_tool", "-id", name, objfile])

-def install_name_tool_add_rpath(rpath, binary):
-    subprocess.call(["install_name_tool", "-add_rpath", rpath, binary])
-
-def install_name_tool_delete_rpath(rpath, binary):
-    subprocess.call(["install_name_tool", "-delete_rpath", rpath, binary])
-
 def libraries(objfile, result = dict()):
    libs_list       = otool(objfile)
-    result[objfile] = libs_list
+    result[objfile] = set(libs_list)

    for lib in libs_list:
        if lib not in result:
@@ -61,19 +43,29 @@ def libraries(objfile, result = dict()):

    return result

+def leafs(libs_dict, processed = []):
+    result    = []
+    processed = set(processed)
+
+    for objfile, libs in libs_dict.items():
+        if libs <= processed:
+            result.append(objfile)
+
+    return result
+
 def lib_path(binary):
    return os.path.join(os.path.dirname(binary), 'lib')

 def lib_name(lib):
    return os.path.join("@executable_path", "lib", os.path.basename(lib))

-def process_libraries(libs_dict, binary):
-    libs_set = set(libs_dict)
-    # Remove binary from libs_set to prevent a duplicate of the binary being
-    # added to the libs directory.
-    libs_set.remove(binary)
+def process_libraries(libs_dict, binary, processed = []):
+    ls   = leafs(libs_dict, processed)
+    diff = set(ls) - set(processed)
+    if diff == set([binary]):
+        return

-    for src in libs_set:
+    for src in diff:
        name = lib_name(src)
        dst  = os.path.join(lib_path(binary), os.path.basename(src))

@@ -84,47 +76,19 @@ def process_libraries(libs_dict, binary):
        if src in libs_dict[binary]:
            install_name_tool_change(src, name, binary)

-        for p in libs_set:
+        for p in processed:
            if p in libs_dict[src]:
                install_name_tool_change(p, lib_name(p), dst)

-def process_swift_libraries(binary):
-    command = ['xcrun', '--find', 'swift-stdlib-tool']
-    swiftStdlibTool = subprocess.check_output(command, universal_newlines=True).strip()
-    # from xcode11 on the dynamic swift libs reside in a separate directory from
-    # the std one, might need versioned paths for future swift versions
-    swiftLibPath = os.path.join(swiftStdlibTool, '../../lib/swift-5.0/macosx')
-    swiftLibPath = os.path.abspath(swiftLibPath)
-
-    command = [swiftStdlibTool, '--copy', '--platform', 'macosx', '--scan-executable', binary, '--destination', lib_path(binary)]
-
-    if os.path.exists(swiftLibPath):
-        command.extend(['--source-libraries', swiftLibPath])
-
-    subprocess.check_output(command, universal_newlines=True)
-
-    print(">> setting additional rpath for swift libraries")
-    install_name_tool_add_rpath("@executable_path/lib", binary)
-
-def remove_dev_tools_rapths(binary):
-    for path in get_rpaths_dev_tools(binary):
-        install_name_tool_delete_rpath(path, binary)
+    process_libraries(libs_dict, binary, ls)

 def main():
    binary = os.path.abspath(sys.argv[1])
    if not os.path.exists(lib_path(binary)):
        os.makedirs(lib_path(binary))
-    print(">> gathering all linked libraries")
    libs = libraries(binary)
-
-    print(">> copying and processing all linked libraries")
+    print(libs)
    process_libraries(libs, binary)

-    print(">> removing rpath definitions towards dev tools")
-    remove_dev_tools_rapths(binary)
-
-    print(">> copying and processing swift libraries")
-    process_swift_libraries(binary)
-
 if __name__ == "__main__":
    main()
@@ -0,0 +1,24 @@
+#! /usr/bin/env perl
+
+use strict;
+use warnings;
+
+# Convert the contents of a file into a C string constant.
+# Note that the compiler will implicitly add an extra 0 byte at the end
+# of every string, so code using the string may need to remove that to get
+# the exact contents of the original file.
+# FIXME: why not a char array?
+
+# treat only alphanumeric and punctuations (excluding " and ?) as safe
+my $unsafe_chars = qr{[^][A-Za-z0-9!#%&'()*+,./:;<=>^_{|}~ -]};
+
+for my $file (@ARGV) {
+    open my $fh, '<:raw', $file or next;
+    print "/* Generated from $file */\n";
+    while (<$fh>) {
+        # replace unsafe chars with their equivalent octal escapes
+        s/($unsafe_chars)/\\@{[sprintf '%03o', ord($1)]}/gos;
+        print "\"$_\"\n"
+    }
+    close $fh;
+}
@@ -1,48 +0,0 @@
-#!/usr/bin/env python3
-
-# Convert the contents of a file into a C string constant.
-# Note that the compiler will implicitly add an extra 0 byte at the end
-# of every string, so code using the string may need to remove that to get
-# the exact contents of the original file.
-
-#
-# This file is part of mpv.
-#
-# mpv is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# mpv is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with mpv.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-import sys
-
-def file2string(infilename, infile, outfile):
-    outfile.write("// Generated from %s\n\n" % infilename)
-
-    conv = ["\\%03o" % c for c in range(256)]
-    safe_chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" \
-                 "0123456789!#%&'()*+,-./:;<=>[]^_{|}~ "
-
-    for c in safe_chars:
-        conv[ord(c)] = c
-    for c, esc in ("\nn", "\tt", r"\\", '""'):
-        conv[ord(c)] = '\\' + esc
-    for line in infile:
-        outfile.write('"' + ''.join(conv[c] for c in line) + '"\n')
-
-if __name__ == "__main__":
-    if len(sys.argv) < 2:
-        outfile = sys.stdout
-    else:
-        outfile = open(sys.argv[2], "w")
-
-    with open(sys.argv[1], 'rb') as infile:
-        file2string(sys.argv[1], infile, outfile)
@@ -1,9 +0,0 @@
-#!/bin/sh
-
-# This script is expected to be called as TOOLS/gen-osd-font.sh (it will access
-# TOOLS/mpv-osd-symbols.sfdir), and it will write sub/osd_font.otf.
-
-# Needs fontforge with python scripting
-
-fontforge -lang=py -c 'f=open(argv[1]); f.generate(argv[2])' \
-    TOOLS/mpv-osd-symbols.sfdir sub/osd_font.otf
@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# This script is expected to be called as TOOLS/gen-x11-icon.sh (it will access
+# etc/mpv-icon...), and it will write video/out/x11_icon.bin.
+
+conv() {
+    echo
+    echo `identify -format "icon: %w %h" "$1"`
+    convert "$1" -depth 8 rgba:-
+}
+
+(echo "# File generated by gen-x11-icon.sh" ;
+ conv etc/mpv-icon-8bit-16x16.png ;
+ conv etc/mpv-icon-8bit-32x32.png ;
+ conv etc/mpv-icon-8bit-64x64.png) | gzip -c > video/out/x11_icon.bin
@@ -0,0 +1,30 @@
+use 5.008;
+use strict;
+use warnings;
+
+# ABSTRACT: Module collection to parse Matroska files.
+package Parse::Matroska;
+
+=head1 DESCRIPTION
+
+C<use>s L<Parse::Matroska::Reader>. See the documentation
+of the modules mentioned in L</"SEE ALSO"> for more information
+in how to use this module.
+
+It's intended for this module to contain high-level interfaces
+to the other modules in the distribution.
+
+=head1 SOURCE CODE
+
+L<https://github.com/Kovensky/Parse-Matroska>
+
+=head1 SEE ALSO
+
+L<Parse::Matroska::Reader>, L<Parse::Matroska::Element>,
+L<Parse::Matroska::Definitions>.
+
+=cut
+
+use Parse::Matroska::Reader;
+
+1;
@@ -0,0 +1,357 @@
+use 5.008;
+use strict;
+use warnings;
+
+# ABSTRACT: internal EBML grammar definitions
+package Parse::Matroska::Definitions;
+
+use Parse::Matroska::Utils qw{uniq uncamelize};
+
+use Exporter;
+our @ISA       = qw{Exporter};
+our @EXPORT_OK = qw{elem_by_hexid %EBML_DEFINITION %MATROSKA_DEFINITION};
+
+=head1 SYNOPSIS
+
+    use Parse::Matroska::Definitions qw{elem_by_hexid};
+    my $ebml_id = elem_by_hexid('1a45dfa3');
+    print "EBML ID $ebml_id->{elid}'s name: $ebml_id->{name}";
+
+=head1 DESCRIPTION
+
+Contains the definition of the EBML grammar as expected in
+Matroska files. This module is meant mostly for internal use.
+
+As this was extended from a script in mpv-player, some data
+generated is apparently useless for regular module users
+but is still relevant to the mpv-player script. Such data
+is annotated as being for mpv compatibility.
+
+=head1 NOTE
+
+The API of this module is not yet considered stable.
+
+=head1 GLOBALS
+
+These global variables are considered B<immutable>.
+
+=head2 @Parse::Matroska::Definitions::global_elem_list
+
+A global list of known matroska elements. Useful for
+mpv's matroska script, used for generating C headers
+that parse matroska.
+
+=head2 %Parse::Matroska::Definitions::global_elem_dict
+
+A global hash of known matroska elements. Used internally
+by L</elem_by_hexid($id)>.
+
+=cut
+
+@Parse::Matroska::Definitions::global_elem_list = ();
+%Parse::Matroska::Definitions::global_elem_dict = ();
+
+=head2 %EBML_DEFINITION
+
+Optionally-importable hash of known EBML IDs belonging
+to the EBML generic grammar.
+
+=head2 %MATROSKA_DEFINITION
+
+Optionally-importable hash of known EBML IDs belonging
+to the Matroska-specific grammar.
+
+=cut
+
+our %EBML_DEFINITION = define_ebml();
+our %MATROSKA_DEFINITION = define_matroska();
+
+=method elem_by_hexid($id)
+
+Returns an EBML Element Definition corresponding to the provided
+hexadecimal string. Returns C<undef> if the element is unknown.
+
+=cut
+sub elem_by_hexid {
+    my ($elid) = @_;
+    return $Parse::Matroska::Definitions::global_elem_dict{$elid};
+}
+
+################################################
+### Helper functions for document definition ###
+################################################
+
+# used by elem when setting the 'valname' key
+use constant TYPE_MAP => {
+    uint    => 'uint64_t',
+    str     => 'char *',
+    binary  => 'struct bstr',
+    ebml_id => 'uint32_t',
+    float   => 'double',
+    sint    => 'int64_t',
+};
+
+# this will be localized to "MATROSKA" or "EBML" on the elem declarations
+our $ELEM_DEFINE_TYPE = undef;
+
+=method elem($name,$elid,$valtype)
+
+NOTE: never call this function yourself; it changes data structures
+that are considered immutable outside of this package.
+
+Internal API function that generates the EBML Element Definitions.
+
+This API function returns an array which first element is C<$elid>
+and the second is a generated hash. The generated hash is stored
+in the @global_elem_list and %global_elem_dict.
+
+The generated hash contains:
+
+=for :list
+= name
+The EBML Element's name, given through C<$name>.
+= elid
+The EBML Element's hex id, given through C<$elid>. Used for lookups by L</elem_by_hexid($id)>.
+= valtype
+The EBML Element's type, given through C<$valtype>, except when C<$valtype> is an arrayref.
+= multiple
+If C<$name> ends with a C<*>, this is set as true and strips the C<*> from L</name>. Used to
+mark elements that may be repeated.
+= subelements
+An arrayref of elements that may be children of this element, given through C<$valtype> if it
+is an arrayref. Sets L</valtype> to C<sub> if there are subelements.
+= subids
+An arrayref listing all the L</elid>s of subelements, C<uniq>ified.
+
+The following elements are for mpv compatibility:
+
+=for :list
+= definename
+Name used for generating C #defines.
+= fieldname
+Name used for generating C struct fields.
+= structname
+Name used for generating C struct names.
+= ebmltype
+A pre-#defined constant to describe the element's type.
+= valname
+Typename used when declaring a struct field referring to this element.
+
+=cut
+sub elem {
+    my %e = (name => shift, elid => shift, valtype => shift);
+
+    # strip * from name, set 'multiple' if there was one
+    $e{multiple} = scalar $e{name} =~ s/\*$//;
+
+    # ELEM_DEFINE_TYPE is either MATROSKA or EBML
+    $e{definename} = "${ELEM_DEFINE_TYPE}_ID_".uc($e{name});
+    $e{fieldname} = uncamelize $e{name};
+    $e{structname} = "ebml_$e{fieldname}";
+
+    if (ref $e{valtype} eq 'HASH') {
+        $e{subelements} = $e{valtype};
+        $e{subids} = uniq map { $_->{elid} } values %{$e{subelements}};
+        $e{valtype} = 'sub';
+        $e{ebmltype} = 'EBML_TYPE_SUBELEMENTS';
+        $e{valname} = "struct $e{structname}";
+    } else {
+        $e{ebmltype} = "EBML_TYPE_\U$e{valtype}";
+        die "Unrecognized value type $e{valtype}" unless
+            defined ($e{valname} = TYPE_MAP->{$e{valtype}});
+    }
+    my $e = \%e;
+    push @Parse::Matroska::Definitions::global_elem_list, $e;
+    $Parse::Matroska::Definitions::global_elem_dict{$e{elid}} = $e;
+    return ($e{elid}, $e);
+}
+
+#############################################
+### EBML and Matroska document definitons ###
+#############################################
+
+=method define_ebml
+
+Internal function that defines the EBML generic grammar.
+
+Must not be called from outside the package.
+
+=cut
+sub define_ebml {
+    local $ELEM_DEFINE_TYPE = 'EBML';
+    return (
+        elem('EBML', '1a45dfa3', {
+            elem('EBMLVersion',        '4286', 'uint'),
+            elem('EBMLReadVersion',    '42f7', 'uint'),
+            elem('EBMLMaxIDLength',    '42f2', 'uint'),
+            elem('EBMLMaxSizeLength',  '42f3', 'uint'),
+            elem('DocType',            '4282', 'str'),
+            elem('DocTypeVersion',     '4287', 'uint'),
+            elem('DocTypeReadVersion', '4285', 'uint'),
+        }),
+
+        elem('CRC32',      'bf', 'binary'),
+        elem('Void',       'ec', 'binary'),
+    );
+}
+
+
+=method define_matroska
+
+Internal function that defines the Matroska-specific EBML grammar.
+
+Must not be called from outside the package.
+
+=cut
+sub define_matroska {
+    local $ELEM_DEFINE_TYPE = 'MATROSKA';
+    return (
+        elem('Segment', '18538067', {
+            elem('SeekHead*', '114d9b74', {
+                elem('Seek*', '4dbb', {
+                    elem('SeekID',       '53ab', 'ebml_id'),
+                    elem('SeekPosition', '53ac', 'uint'),
+                }),
+            }),
+
+            elem('Info*', '1549a966', {
+                elem('SegmentUID',      '73a4', 'binary'),
+                elem('PrevUID',       '3cb923', 'binary'),
+                elem('NextUID',       '3eb923', 'binary'),
+                elem('TimecodeScale', '2ad7b1', 'uint'),
+                elem('DateUTC',         '4461', 'sint'),
+                elem('Title',           '7ba9', 'str'),
+                elem('MuxingApp',       '4d80', 'str'),
+                elem('WritingApp',      '5741', 'str'),
+                elem('Duration',        '4489', 'float'),
+            }),
+
+            elem('Cluster*', '1f43b675', {
+                elem('Timecode', 'e7', 'uint'),
+                elem('BlockGroup*', 'a0', {
+                    elem('Block',           'a1', 'binary'),
+                    elem('BlockDuration',   '9b', 'uint'),
+                    elem('ReferenceBlock*', 'fb', 'sint'),
+                    elem('DiscardPadding',  '75A2', 'sint'),
+                }),
+                elem('SimpleBlock*', 'a3', 'binary'),
+            }),
+
+            elem('Tracks*', '1654ae6b', {
+                elem('TrackEntry*', 'ae', {
+                    elem('TrackNumber',            'd7', 'uint'),
+                    elem('TrackUID',             '73c5', 'uint'),
+                    elem('TrackType',              '83', 'uint'),
+                    elem('FlagEnabled',            'b9', 'uint'),
+                    elem('FlagDefault',            '88', 'uint'),
+                    elem('FlagForced',           '55aa', 'uint'),
+                    elem('FlagLacing',             '9c', 'uint'),
+                    elem('MinCache',             '6de7', 'uint'),
+                    elem('MaxCache',             '6df8', 'uint'),
+                    elem('DefaultDuration',    '23e383', 'uint'),
+                    elem('TrackTimecodeScale', '23314f', 'float'),
+                    elem('MaxBlockAdditionID',   '55ee', 'uint'),
+                    elem('Name',                 '536e', 'str'),
+                    elem('Language',           '22b59c', 'str'),
+                    elem('CodecID',                '86', 'str'),
+                    elem('CodecPrivate',         '63a2', 'binary'),
+                    elem('CodecName',          '258688', 'str'),
+                    elem('CodecDecodeAll',         'aa', 'uint'),
+                    elem('CodecDelay',           '56AA', 'uint'),
+                    elem('SeekPreRoll',          '56BB', 'uint'),
+                    elem('Video', 'e0', {
+                        elem('FlagInterlaced',  '9a', 'uint'),
+                        elem('PixelWidth',      'b0', 'uint'),
+                        elem('PixelHeight',     'ba', 'uint'),
+                        elem('DisplayWidth',  '54b0', 'uint'),
+                        elem('DisplayHeight', '54ba', 'uint'),
+                        elem('DisplayUnit',   '54b2', 'uint'),
+                        elem('FrameRate',   '2383e3', 'float'),
+                        elem('ColourSpace', '2eb524', 'binary'),
+                        elem('StereoMode',    '53b8', 'uint'),
+                    }),
+                    elem('Audio', 'e1', {
+                        elem('SamplingFrequency',         'b5', 'float'),
+                        elem('OutputSamplingFrequency', '78b5', 'float'),
+                        elem('Channels',                  '9f', 'uint'),
+                        elem('BitDepth',                '6264', 'uint'),
+                    }),
+                    elem('ContentEncodings', '6d80', {
+                        elem('ContentEncoding*', '6240', {
+                            elem('ContentEncodingOrder', '5031', 'uint'),
+                            elem('ContentEncodingScope', '5032', 'uint'),
+                            elem('ContentEncodingType',  '5033', 'uint'),
+                            elem('ContentCompression', '5034', {
+                                elem('ContentCompAlgo',     '4254', 'uint'),
+                                elem('ContentCompSettings', '4255', 'binary'),
+                            }),
+                        }),
+                    }),
+                }),
+            }),
+
+            elem('Cues', '1c53bb6b', {
+                elem('CuePoint*', 'bb', {
+                    elem('CueTime', 'b3', 'uint'),
+                    elem('CueTrackPositions*', 'b7', {
+                        elem('CueTrack',           'f7', 'uint'),
+                        elem('CueClusterPosition', 'f1', 'uint'),
+                        elem('CueRelativePosition','f0', 'uint'),
+                        elem('CueDuration',        'b2', 'uint'),
+                    }),
+                }),
+            }),
+
+            elem('Attachments', '1941a469', {
+                elem('AttachedFile*', '61a7', {
+                    elem('FileDescription', '467e', 'str'),
+                    elem('FileName',        '466e', 'str'),
+                    elem('FileMimeType',    '4660', 'str'),
+                    elem('FileData',        '465c', 'binary'),
+                    elem('FileUID',         '46ae', 'uint'),
+                }),
+            }),
+
+            elem('Chapters', '1043a770', {
+                elem('EditionEntry*', '45b9', {
+                    elem('EditionUID',         '45bc', 'uint'),
+                    elem('EditionFlagHidden',  '45bd', 'uint'),
+                    elem('EditionFlagDefault', '45db', 'uint'),
+                    elem('EditionFlagOrdered', '45dd', 'uint'),
+                    elem('ChapterAtom*', 'b6', {
+                        elem('ChapterUID',               '73c4', 'uint'),
+                        elem('ChapterTimeStart',           '91', 'uint'),
+                        elem('ChapterTimeEnd',             '92', 'uint'),
+                        elem('ChapterFlagHidden',          '98', 'uint'),
+                        elem('ChapterFlagEnabled',       '4598', 'uint'),
+                        elem('ChapterSegmentUID',        '6e67', 'binary'),
+                        elem('ChapterSegmentEditionUID', '6ebc', 'uint'),
+                        elem('ChapterDisplay*', '80', {
+                            elem('ChapString',      '85', 'str'),
+                            elem('ChapLanguage*', '437c', 'str'),
+                            elem('ChapCountry*',  '437e', 'str'),
+                        }),
+                    }),
+                }),
+            }),
+            elem('Tags*', '1254c367', {
+                elem('Tag*', '7373', {
+                    elem('Targets', '63c0', {
+                        elem('TargetTypeValue',     '68ca', 'uint'),
+                        elem('TargetTrackUID',      '63c5', 'uint'),
+                        elem('TargetEditionUID',    '63c9', 'uint'),
+                        elem('TargetChapterUID',    '63c4', 'uint'),
+                        elem('TargetAttachmentUID', '63c6', 'uint'),
+                     }),
+                    elem('SimpleTag*', '67c8', {
+                        elem('TagName',     '45a3', 'str'),
+                        elem('TagLanguage', '447a', 'str'),
+                        elem('TagString',   '4487', 'str'),
+                    }),
+                }),
+            }),
+        }),
+    );
+}
+
+1;
@@ -0,0 +1,331 @@
+use 5.008;
+use strict;
+use warnings;
+
+# ABSTRACT: a mid-level representation of an EBML element
+package Parse::Matroska::Element;
+
+use Carp;
+use List::Util qw{first};
+
+=head1 SYNOPSIS
+
+    use Parse::Matroska::Reader;
+    my $reader = Parse::Matroska::Reader->new($path);
+    my $elem = $reader->read_element;
+
+    print "ID: $elem->{elid}\n";
+    print "Name: $elem->{name}\n";
+    print "Length: $elem->{content_len}\n";
+    print "Type: $elem->{type}\n";
+    print "Child count: ", scalar(@{$elem->all_children}), "\n";
+    if ($elem->{type} eq 'sub') {
+        while (my $chld = $elem->next_child) {
+            print "Child Name: $chld->{name}\n";
+        }
+    } else {
+        print "Value: ", $elem->get_value, "\n";
+    }
+
+=head1 DESCRIPTION
+
+Represents a single Matroska element as decoded by
+L<Parse::Matroska::Reader>. This is essentially a hash
+augmented with functions for delay-loading of binary
+values and children elements.
+
+=head1 NOTE
+
+The API of this module is not yet considered stable.
+
+=attr elid
+
+The EBML Element ID, suitable for passing to
+L<Parse::Matroska::Definitions/elem_by_hexid>.
+
+=attr name
+
+The EBML Element's name.
+
+=attr type
+
+The EBML Element's type. Can be C<uint>, C<sint>,
+C<float>, C<ebml_id>, C<str> or C<binary>. See L</value>
+for details.
+
+Equivalent to
+C<elem_by_hexid($elem-E<gt>{value})-E<gt>{valtype}>.
+
+=attr value
+
+The EBML Element's value. Should be obtained through
+L</get_value>.
+
+Is an unicode string if the L</type> is C<str>, that is,
+the string has already been decoded by L<Encode/decode>.
+
+Is C<undef> if the L</type> is C<binary> and the contents
+were delay-loaded and not yet read. L</get_value> will
+do the delayed load if needed.
+
+Is an arrayref if the L</type> is C<sub>, containing
+the children nodes that were already loaded.
+
+Is a hashref if the L</type> is C<ebml_id>, containing
+the referred element's information as defined in
+L<Parse::Matroska::Definitions>. Calling
+C<elem_by_hexid($elem-E<gt>{value}-E<gt>{elid})> will
+return the same object as $elem->{value}.
+
+=attr full_len
+
+The entire length of this EBML Element, including
+the header's.
+
+=attr size_len
+
+The length of the size marker. Used when calculating
+L</full_len> from L</content_len>
+
+=attr content_len
+
+The length of the contents of this EBML Element,
+which excludes the header.
+
+=attr reader
+
+A weakened reference to the associated
+L<Parse::Matroska::Reader>.
+
+=method new(%hash)
+
+Creates a new Element initialized with the hash
+given as argument.
+
+=cut
+sub new {
+    my $class = shift;
+    my $self = {};
+    bless $self, $class;
+
+    $self->initialize(@_);
+    return $self;
+}
+
+=method initialize(%hash)
+
+Called by L</new> on initialization.
+
+=cut
+sub initialize {
+    my ($self, %args) = @_;
+    for (keys %args) {
+        $self->{$_} = $args{$_};
+    }
+    $self->{depth} = 0 unless $self->{depth};
+}
+
+=method skip
+
+Called by the user to ignore the contents of this EBML node.
+Needed when ignoring the children of a node.
+
+=cut
+sub skip {
+    my ($self) = @_;
+    my $reader = $self->{reader};
+    return unless $reader; # we don't have to skip if there's no reader
+    my $pos = $reader->getpos;
+    croak "Too late to skip, reads were already done"
+        if $pos ne $self->{data_pos};
+    $reader->skip($self->{content_len});
+}
+
+=method get_value($keep_bin)
+
+Returns the value contained by this EBML element.
+
+If the element has children, returns an arrayref to
+the children elements that were already encountered.
+
+If the element's type is C<binary> and the value was
+delay-loaded, does the reading now.
+
+If $keep_bin is true, the delay-loaded data is kept
+as the L</value>, otherwise, further calls to
+C<get_value> will reread the data from the L</reader>.
+
+=cut
+sub get_value {
+    my ($self, $keep_bin) = @_;
+
+    return undef if $self->{type} eq 'skip';
+    return $self->{value} if $self->{value};
+
+    my $reader = $self->{reader} or
+        croak "The associated Reader has been deleted";
+
+    # delay-loaded 'binary'
+    if ($self->{type} eq 'binary') {
+        croak "Cannot seek in the current Reader" unless $self->{data_pos};
+        # seek to the data position...
+        $reader->setpos($self->{data_pos});
+        # read the data, keeping it in value if requested
+        if ($keep_bin) {
+            $self->{value} = $reader->readlen($self->{content_len});
+            return $self->{value};
+        } else {
+            return $reader->readlen($self->{content_len});
+        }
+    }
+}
+
+=method next_child($read_bin)
+
+Builtin iterator; reads and returns the next child element.
+Always returns undef if the type isn't C<sub>.
+
+Returns undef at the end of the iterator and resets itself to
+point to the first element; so calling L</next_child($read_bin)>
+after the iterator returned C<undef> will return the first child.
+
+The optional C<$read_bin> parameter has the children elements
+not delay-load their value if their type is C<binary>.
+
+If all children elements have already been read, return
+each element in-order as would be given by
+L</all_children($recurse,$read_bin)>.
+
+=cut
+sub next_child {
+    my ($self, $read_bin) = @_;
+    return unless $self->{type} eq 'sub';
+
+    if ($self->{_all_children_read}) {
+        my $idx = $self->{_last_child} ||= 0;
+        if ($idx == @{$self->{value}}) {
+            # reset the iterator, returning undef once
+            $self->{_last_child} = 0;
+            return;
+        }
+        my $ret = $self->{value}->[$idx];
+
+        ++$idx;
+        $self->{_last_child} = $idx;
+        return $ret;
+    }
+
+    my $len = defined $self->{remaining_len}
+        ? $self->{remaining_len}
+        : $self->{content_len};
+
+    if ($len == 0) {
+        # we've read all children; switch into $self->{value} iteration mode
+        $self->{_all_children_read} = 1;
+        # return undef since the iterator will reset
+        return;
+    }
+
+    $self->{pos_offset} ||= 0;
+    my $pos = $self->{data_pos};
+    my $reader = $self->{reader} or croak "The associated reader has been deleted";
+    $reader->setpos($pos);
+    $reader->{fh}->seek($self->{pos_offset}, 1) if $pos;
+
+    my $chld = $reader->read_element($read_bin);
+    return undef unless defined $chld;
+    $self->{pos_offset} += $chld->{full_len};
+
+    $self->{remaining_len} = $len - $chld->{full_len};
+
+    if ($self->{remaining_len} < 0) {
+        croak "Child elements consumed $self->{remaining_len} more bytes than parent $self->{name} contained";
+    }
+
+    $chld->{depth} = $self->{depth} + 1;
+    $self->{value} ||= [];
+
+    push @{$self->{value}}, $chld;
+
+    return $chld;
+}
+
+=method all_children($recurse,$read_bin)
+
+Calls L</populate_children($recurse,$read_bin)> on self
+and returns an arrayref with the children nodes.
+
+Both C<$recurse> and C<$read_bin> are optional and default
+to false.
+
+=cut
+sub all_children {
+    my ($self, $recurse, $read_bin) = @_;
+    $self->populate_children($recurse, $read_bin);
+    return $self->{value};
+}
+
+=method children_by_name($name)
+
+Searches in the already read children elements for all
+elements with the EBML name C<$name>. Returns an array
+containing all found elements. On scalar context,
+returns only the first element found.
+
+Croaks if the element's C<type> isn't C<sub>.
+
+=cut
+sub children_by_name {
+    my ($self, $name) = @_;
+    return unless defined wantarray; # don't do work if work isn't wanted
+    croak "Element can't have children" unless $self->{type} eq 'sub';
+
+    my @found = grep { $_->{name} eq $name } @{$self->{value}};
+    return @found       if wantarray;         # list
+    return shift @found if defined wantarray; # scalar
+}
+
+=method populate_children($recurse,$read_bin)
+
+Populates the internal array of children elements, that is,
+requests that the associated L<Matroska::Parser::Reader> reads
+all children elements. Returns itself.
+
+Returns false if the element's C<type> isn't C<sub>.
+
+If C<$recurse> is provided and is true, the method will call
+itself in the children elements with the same parameters it
+received; this will build a full EBML tree.
+
+If C<$read_bin> is provided and is true, disables delay-loading
+of the contents of C<binary>-type nodes, reading the contents
+to memory.
+
+If both C<$recurse> and C<$read_bin> are true, entire EBML trees
+can be loaded without requiring seeks, thus behaving correctly
+on unseekable streams. If C<$read_bin> is false, the entire EBML
+tree is still loaded, but calling L</get_value> on C<binary>-type
+nodes will produce an error on unseekable streams.
+
+=cut
+sub populate_children {
+    my ($self, $recurse, $read_bin) = @_;
+
+    return unless $self->{type} eq 'sub';
+
+    if (@{$self->{value}} && $recurse) {
+        # only recurse
+        foreach (@{$self->{value}}) {
+            $_->populate_children($recurse, $read_bin);
+        }
+        return $self;
+    }
+
+    while (my $chld = $self->next_child($read_bin)) {
+        $chld->populate_children($recurse, $read_bin) if $recurse;
+    }
+
+    return $self;
+}
+
+1;
@@ -0,0 +1,426 @@
+use 5.008;
+use strict;
+use warnings;
+
+# ABSTRACT: a low-level reader for EBML files
+package Parse::Matroska::Reader;
+
+use Parse::Matroska::Definitions qw{elem_by_hexid};
+use Parse::Matroska::Element;
+
+use Carp;
+use Scalar::Util qw{openhandle weaken};
+use IO::Handle;
+use IO::File;
+use List::Util qw{first};
+use Encode;
+
+use constant BIGINT_TRY => 'Pari,GMP,FastCalc';
+use Math::BigInt try => BIGINT_TRY;
+use Math::BigRat try => BIGINT_TRY;
+
+=head1 SYNOPSIS
+
+    use Parse::Matroska::Reader;
+    my $reader = Parse::Matroska::Reader->new($path);
+    $reader->close;
+    $reader->open(\$string_with_matroska_data);
+
+    my $elem = $reader->read_element;
+    print "Element ID: $elem->{elid}\n";
+    print "Element name: $elem->{name}\n";
+    if ($elem->{type} ne 'sub') {
+        print "Element value: $elem->get_value\n";
+    } else {
+        while (my $child = $elem->next_child) {
+            print "Child element: $child->{name}\n";
+        }
+    }
+    $reader->close;
+
+=head1 DESCRIPTION
+
+Reads EBML data, which is used in Matroska files.
+This is a low-level reader which is meant to be used as a backend
+for higher level readers. TODO: write the high level readers :)
+
+=head1 NOTE
+
+The API of this module is not yet considered stable.
+
+=method new
+
+Creates a new reader.
+Calls L</open($arg)> with its arguments if provided.
+
+=cut
+sub new {
+    my $class = shift;
+    my $self = {};
+    bless $self, $class;
+
+    $self->open(@_) if @_;
+    return $self;
+}
+
+=method open($arg)
+
+Creates the internal filehandle. The argument can be:
+
+=for :list
+* An open filehandle or L<IO::Handle> object.
+The filehandle is not C<dup()>ed, so calling L</close> in this
+object will close the given filehandle as well.
+* A scalar containing a path to a file.
+* On perl v5.14 or newer, a scalarref pointing to EBML data.
+For similar functionality in older perls, give an L<IO::String> object
+or the handle to an already C<open>ed scalarref.
+
+=cut
+sub open {
+    my ($self, $arg) = @_;
+    $self->{fh} = openhandle($arg) || IO::File->new($arg, "<:raw")
+        or croak "Can't open $arg: $!";
+}
+
+=method close
+
+Closes the internal filehandle.
+
+=cut
+sub close {
+    my ($self) = @_;
+    $self->{fh}->close;
+    delete $self->{fh};
+}
+
+# equivalent to $self->readlen(1), possibly faster
+sub _getc {
+    my ($self) = @_;
+    my $c = $self->{fh}->getc;
+    croak "Can't do read of length 1: $!" if !defined $c && $!;
+    return $c;
+}
+
+=method readlen($length)
+
+Reads C<$length> bytes from the internal filehandle.
+
+=cut
+sub readlen {
+    my ($self, $len) = @_;
+    my $data;
+    my $readlen = $self->{fh}->read($data, $len);
+    croak "Can't do read of length $len: $!"
+                 unless defined $readlen;
+    return $data;
+}
+
+# converts a byte string into an integer
+# we do so by converting the integer into a hex string (big-endian)
+# and then reading the hex-string into an integer
+sub _bin2int($) {
+    my ($bin) = @_;
+    # if the length is larger than 3
+    # the resulting integer might be larger than INT_MAX
+    if (length($bin) > 3) {
+        return Math::BigInt->from_hex(unpack("H*", $bin));
+    }
+    return hex(unpack("H*", $bin));
+}
+
+# creates a floating-point number with the given mantissa and exponent
+sub _ldexp {
+    my ($mantissa, $exponent) = @_;
+    my $r = new Math::BigRat($mantissa);
+    return $r * Math::BigRat->new(2)**$exponent;
+}
+
+# NOTE: the read_* functions are hard to read because they're ports
+# of even harder to read python functions.
+# TODO: make them readable
+
+=method read_id
+
+Reads an EBML ID atom in hexadecimal string format, suitable
+for passing to L<Parse::Matroska::Definitions/elem_by_hexid($id)>.
+
+=cut
+sub read_id {
+    my ($self) = @_;
+    my $t = $self->_getc;
+    return undef unless defined $t;
+    my $i = 0;
+    my $mask = 1<<7;
+
+    if (ord($t) == 0) {
+        croak "Matroska Syntax error: first byte of ID was \\0"
+    }
+    until (ord($t) & $mask) {
+        ++$i;
+        $mask >>= 1;
+    }
+    # return hex string of the bytes we just read
+    return unpack "H*", ($t . $self->readlen($i));
+}
+
+=method read_size
+
+Reads an EBML Data Size atom, which immediately follows
+an EBML ID atom.
+
+This returns an array consisting of:
+
+=for :list
+0. The length of the Data Size atom.
+1. The value encoded in the Data Size atom, which is the length of all the data following it.
+
+=cut
+sub read_size {
+    my ($self) = @_;
+    my $t = $self->_getc;
+    my $i = 0;
+    my $mask = 1<<7;
+
+    if (ord($t) == 0) {
+        croak "Matroska Syntax error: first byte of data size was \\0"
+    }
+    until (ord($t) & $mask) {
+        ++$i;
+        $mask >>= 1;
+    }
+    $t = $t & chr($mask-1); # strip length bits (keep only significant bits)
+    return ($i+1, _bin2int $t . $self->readlen($i));
+}
+
+=method read_str($length)
+
+Reads a string of length C<$length> bytes from the internal filehandle.
+The string is already L<Encode/decode>d from C<UTF-8>, which is the
+standard Matroska string encoding.
+
+=cut
+{
+    my $utf8 = find_encoding("UTF-8");
+    sub read_str {
+        my ($self, $length) = @_;
+        return $utf8->decode($self->readlen($length));
+    }
+}
+
+=method read_uint($length)
+
+Reads an unsigned integer of length C<$length> bytes
+from the internal filehandle.
+
+Returns a L<Math::BigInt> object if C<$length> is greater
+than 4.
+
+=cut
+sub read_uint {
+    my ($self, $length) = @_;
+    return _bin2int $self->readlen($length);
+}
+
+=method read_sint($length)
+
+Reads a signed integer of length C<$length> bytes
+from the internal filehandle.
+
+Returns a L<Math::BigInt> object if C<$length> is greater
+than 4.
+
+=cut
+sub read_sint {
+    my ($self, $length) = @_;
+    my $i = $self->read_uint($length);
+
+    # Apply 2's complement to the unsigned int
+    my $mask = int(2 ** ($length * 8 - 1));
+    # if the most significant bit is set...
+    if ($i & $mask) {
+        # subtract the MSB twice
+        $i -= 2 * $mask;
+    }
+    return $i;
+}
+
+=method read_float($length)
+
+Reads an IEEE floating point number of length C<$length>
+bytes from the internal filehandle.
+
+Only lengths C<4> and C<8> are supported (C C<float> and C<double>).
+
+=cut
+{
+    my $b1 = new Math::BigInt 1;
+
+    sub read_float {
+        my ($self, $length) = @_;
+        my $i = new Math::BigInt $self->read_uint($length)->bstr;
+        my $f;
+
+        # These evil expressions reinterpret an unsigned int as IEEE binary floats
+        if ($length == 4) {
+            $f = _ldexp(($i & ((1<<23) - 1)) + (1<<23), ($i>>23 & ((1<<8) - 1)) - 150);
+            $f = -$f if $i & ($b1<<31);
+        } elsif ($length == 8) {
+            $f = _ldexp(($i & (($b1<<52) - 1)) + ($b1<<52), ($i>>52 & ((1<<12) - 1)) - 1075);
+            $f = -$f if $i & ($b1<<63);
+        } else {
+            croak "Matroska Syntax error: unsupported IEEE float byte size $length";
+        }
+
+        return $f;
+    }
+}
+
+=method read_ebml_id($length)
+
+Reads an EBML ID when it's encoded as the data inside another
+EBML element, that is, when the enclosing element's C<type> is
+C<ebml_id>.
+
+This returns a hashref with the EBML element description as
+defined in L<Parse::Matroska::Definitions>.
+
+=cut
+sub read_ebml_id {
+    my ($self, $length) = @_;
+    return elem_by_hexid(unpack("H*", $self->readlen($length)));
+}
+
+=method skip($length)
+
+Skips C<$length> bytes in the internal filehandle.
+
+=cut
+sub skip {
+    my ($self, $len) = @_;
+    return if $self->{fh}->can('seek') && $self->{fh}->seek($len, 1);
+    $self->readlen($len);
+    return;
+}
+
+=method getpos
+
+Wrapper for L<IO::Seekable/$io-E<gt>getpos> in the internal filehandle.
+
+Returns undef if the internal filehandle can't C<getpos>.
+
+=cut
+sub getpos {
+    my ($self) = @_;
+    return undef unless $self->{fh}->can('getpos');
+    return $self->{fh}->getpos;
+}
+
+=method setpos($pos)
+
+Wrapper for L<IO::Seekable/$io-E<gt>setpos> in the internal filehandle.
+
+Returns C<undef> if the internal filehandle can't C<setpos>.
+
+Croaks if C<setpos> does not seek to the requested position,
+that is, if calling C<getpos> does not yield the same object
+as the C<$pos> argument.
+
+=cut
+sub setpos {
+    my ($self, $pos) = @_;
+    return undef unless $pos && $self->{fh}->can('setpos');
+
+    my $ret = $self->{fh}->setpos($pos);
+    croak "Cannot seek to correct position"
+        unless $self->getpos eq $pos;
+    return $ret;
+}
+
+=method read_element($read_bin)
+
+Reads a full EBML element from the internal filehandle.
+
+Returns a L<Parse::Matroska::Element> object initialized with
+the read data. If C<read_bin> is not present or is false, will
+delay-load the contents of C<binary> type elements, that is,
+they will only be loaded when calling C<get_value> on the
+returned L<Parse::Matroska::Element> object.
+
+Does not read the children of the element if its type is
+C<sub>. Look into the L<Parse::Matroska::Element> interface
+for details in how to read children elements.
+
+Pass a true C<$read_bin> if the stream being read is not
+seekable (C<getpos> is undef) and the contents of C<binary>
+elements is desired, otherwise seeking errors or internal
+filehandle corruption might occur.
+
+=cut
+sub read_element {
+    my ($self, $read_bin) = @_;
+    return undef if $self->{fh}->eof;
+
+    my $elem_pos = $self->getpos;
+
+    my $elid = $self->read_id;
+    my $elem_def = elem_by_hexid($elid);
+    my ($size_len, $content_len) = $self->read_size;
+    my $full_len = length($elid)/2 + $size_len + $content_len;
+
+    my $elem = Parse::Matroska::Element->new(
+        elid => $elid,
+        name => $elem_def && $elem_def->{name},
+        type => $elem_def && $elem_def->{valtype},
+        size_len => $size_len,
+        content_len => $content_len,
+        full_len => $full_len,
+        reader => $self,
+        elem_pos => $elem_pos,
+        data_pos => $self->getpos,
+        );
+    weaken($elem->{reader});
+
+    if (defined $elem_def) {
+        if ($elem->{type} eq 'sub') {
+            $elem->{value} = [];
+        } elsif ($elem->{type} eq 'str') {
+            $elem->{value} = $self->read_str($content_len);
+        } elsif ($elem->{type} eq 'ebml_id') {
+            $elem->{value} = $self->read_ebml_id($content_len);
+        } elsif ($elem->{type} eq 'uint') {
+            $elem->{value} = $self->read_uint($content_len);
+        } elsif ($elem->{type} eq 'sint') {
+            $elem->{value} = $self->read_sint($content_len);
+        } elsif ($elem->{type} eq 'float') {
+            $elem->{value} = $self->read_float($content_len);
+        } elsif ($elem->{type} eq 'skip') {
+            $self->skip($content_len);
+        } elsif ($elem->{type} eq 'binary') {
+            if ($read_bin) {
+                $elem->{value} = $self->readlen($content_len);
+            } else {
+                $self->skip($content_len);
+            }
+        } else {
+            die "Matroska Definition error: type $elem->{valtype} unknown"
+        }
+    } else {
+        $self->skip($content_len);
+    }
+    return $elem;
+}
+
+1;
+
+=head1 CAVEATS
+
+Children elements have to be processed as soon as an element
+with children is found, or their children ignored with
+L<Parse::Matroska::Element/skip>. Not doing so doesn't cause
+errors but results in an invalid structure, with constant C<0>
+depth.
+
+To work correctly in unseekable streams, either the contents
+of C<binary>-type elements has to be ignored or the C<read_bin>
+flag to C<read_element> has to be true.
@@ -0,0 +1,37 @@
+use strict;
+use warnings;
+
+# ABSTRACT: internally-used helper functions
+package Parse::Matroska::Utils;
+
+use Exporter;
+our @ISA       = qw{Exporter};
+our @EXPORT_OK = qw{uniq uncamelize};
+
+=method uniq(@array)
+
+The same as L<List::MoreUtils/"uniq LIST">.
+Included to avoid depending on it since it's
+not a core module.
+
+=cut
+sub uniq(@) {
+  my %seen;
+  return grep { !$seen{$_}++ } @_;
+}
+
+=method uncamelize($string)
+
+Converts a "StringLikeTHIS" into a
+"string_like_this".
+
+=cut
+sub uncamelize($) {
+    local $_ = shift;
+    # lc followed by UC: lc_UC
+    s/(?<=[a-z])([A-Z])/_\L$1/g;
+    # UC followed by two lc: _UClclc
+    s/([A-Z])(?=[a-z]{2})/_\L$1/g;
+    # strip leading _ that the second regexp might add; lowercase all
+    s/^_//; lc
+}
@@ -11,10 +11,4 @@ to mpv's command line.
 Where appropriate, they may also be placed in ~/.config/mpv/scripts/ from
 where they will be automatically loaded when mpv starts.

-This is only a small selection of internally maintained scripts. Some of them
-are just for testing mpv internals, or serve as examples. An extensive
-user-edited list of 3rd party scripts is available here:
-
-    https://github.com/mpv-player/mpv/wiki/User-Scripts
-
-(Anyone can add their own scripts to that list.)
+Some of these are just for testing mpv internals.
@@ -1,155 +0,0 @@
-- This script adds control to the dynamic range compression ffmpeg
-- filter including key bindings for adjusting parameters.
--
-- See https://ffmpeg.org/ffmpeg-filters.html#acompressor for explanation
-- of the parameters.
-
-local mp = require 'mp'
-local options = require 'mp.options'
-
-local o = {
-	default_enable = false,
-	show_osd = true,
-	osd_timeout = 4000,
-	filter_label = mp.get_script_name(),
-
-	key_toggle = 'n',
-	key_increase_threshold = 'F1',
-	key_decrease_threshold = 'Shift+F1',
-	key_increase_ratio = 'F2',
-	key_decrease_ratio = 'Shift+F2',
-	key_increase_knee = 'F3',
-	key_decrease_knee = 'Shift+F3',
-	key_increase_makeup = 'F4',
-	key_decrease_makeup = 'Shift+F4',
-	key_increase_attack = 'F5',
-	key_decrease_attack = 'Shift+F5',
-	key_increase_release = 'F6',
-	key_decrease_release = 'Shift+F6',
-
-	default_threshold = -25.0,
-	default_ratio = 3.0,
-	default_knee = 2.0,
-	default_makeup = 8.0,
-	default_attack = 20.0,
-	default_release = 250.0,
-
-	step_threshold = -2.5,
-	step_ratio = 1.0,
-	step_knee = 1.0,
-	step_makeup = 1.0,
-	step_attack = 10.0,
-	step_release = 10.0,
-}
-options.read_options(o)
-
-local params = {
-	{ name = 'attack',    min=0.01, max=2000, hide_default=true,  dB=''   },
-	{ name = 'release',   min=0.01, max=9000, hide_default=true,  dB=''   },
-	{ name = 'threshold', min= -30, max=   0, hide_default=false, dB='dB' },
-	{ name = 'ratio',     min=   1, max=  20, hide_default=false, dB=''   },
-	{ name = 'knee',      min=   1, max=  10, hide_default=true,  dB='dB' },
-	{ name = 'makeup',    min=   0, max=  24, hide_default=false, dB='dB' },
-}
-
-local function parse_value(value)
-	-- Using nil here because tonumber differs between lua 5.1 and 5.2 when parsing fractions in combination with explicit base argument set to 10.
-	-- And we can't omit it because gsub returns 2 values which would get unpacked and cause more problems. Gotta love scripting languages.
-	return tonumber(value:gsub('dB$', ''), nil)
-end
-
-local function format_value(value, dB)
-	return string.format('%g%s', value, dB)
-end
-
-local function show_osd(filter)
-	if not o.show_osd then
-		return
-	end
-
-	if not filter.enabled then
-		mp.commandv('show-text', 'Dynamic range compressor: disabled', o.osd_timeout)
-		return
-	end
-
-	local pretty = {}
-	for _,param in ipairs(params) do
-		local value = parse_value(filter.params[param.name])
-		if not (param.hide_default and value == o['default_' .. param.name]) then
-			pretty[#pretty+1] = string.format('%s: %g%s', param.name:gsub("^%l", string.upper), value, param.dB)
-		end
-	end
-
-	if #pretty == 0 then
-		pretty = ''
-	else
-		pretty = '\n(' .. table.concat(pretty, ', ') .. ')'
-	end
-
-	mp.commandv('show-text', 'Dynamic range compressor: enabled' .. pretty, o.osd_timeout)
-end
-
-local function get_filter()
-	local af = mp.get_property_native('af', {})
-
-	for i = 1, #af do
-		if af[i].label == o.filter_label then
-			return af, i
-		end
-	end
-
-	af[#af+1] = {
-		name = 'acompressor',
-		label = o.filter_label,
-		enabled = false,
-		params = {},
-	}
-
-	for _,param in pairs(params) do
-		af[#af].params[param.name] = format_value(o['default_' .. param.name], param.dB)
-	end
-
-	return af, #af
-end
-
-local function toggle_acompressor()
-	local af, i = get_filter()
-	af[i].enabled = not af[i].enabled
-	mp.set_property_native('af', af)
-	show_osd(af[i])
-end
-
-local function update_param(name, increment)
-	for _,param in pairs(params) do
-		if param.name == string.lower(name) then
-			local af, i = get_filter()
-			local value = parse_value(af[i].params[param.name])
-			value = math.max(param.min, math.min(value + increment, param.max))
-			af[i].params[param.name] = format_value(value, param.dB)
-			af[i].enabled = true
-			mp.set_property_native('af', af)
-			show_osd(af[i])
-			return
-		end
-	end
-
-	mp.msg.error('Unknown parameter "' .. name .. '"')
-end
-
-mp.add_key_binding(o.key_toggle, "toggle-acompressor", toggle_acompressor)
-mp.register_script_message('update-param', update_param)
-
-for _,param in pairs(params) do
-	for direction,step in pairs({increase=1, decrease=-1}) do
-		mp.add_key_binding(o['key_' .. direction .. '_' .. param.name],
-		                   'acompressor-' .. direction .. '-' .. param.name,
-		                   function() update_param(param.name, step*o['step_' .. param.name]); end,
-		                   { repeatable = true })
-	end
-end
-
-if o.default_enable then
-	local af, i = get_filter()
-	af[i].enabled = true
-	mp.set_property_native('af', af)
-end
@@ -6,3 +6,8 @@ mp.observe_property("audio-device-list", "native", function(name, val)
        print("  - '" .. e.name .. "' (" .. e.description .. ")")
    end
 end)
+
+mp.observe_property("audio-out-detected-device", "native", function(name, val)
+    print("Detected audio device changed:")
+    print("  - '" .. val)
+end)
@@ -1,329 +1,113 @@
--[[
-This script uses the lavfi cropdetect filter to automatically
-insert a crop filter with appropriate parameters for the
-currently playing video.
-
-It will automatically crop the video, when playback starts.
-
-Also It registers the key-binding "C" (shift+c). You can manually
-crop the video by pressing the "C" (shift+c) key.
-
-If the "C" key is pressed again, the crop filter is removed
-restoring playback to its original state.
-
-The workflow is as follows: First, it inserts the filter
-vf=lavfi=cropdetect. After <detect_seconds> (default is 1)
-seconds, it then inserts the filter vf=crop=w:h:x:y, where
-w,h,x,y are determined from the vf-metadata gathered by
-cropdetect. The cropdetect filter is removed immediately after
-the crop filter is inserted as it is no longer needed.
-
-Since the crop parameters are determined from the 1 second of
-video between inserting the cropdetect and crop filters, the "C"
-key should be pressed at a position in the video where the crop
-region is unambiguous (i.e., not a black frame, black background
-title card, or dark scene).
-
-The default options can be overridden by adding
-script-opts-append=autocrop-<parameter>=<value> into mpv.conf
-
-List of available parameters (For default values, see <options>)：
-
-auto: bool - Whether to automatically apply crop at the start of
-    playback. If you don't want to crop automatically, set it to
-    false or add "script-opts-append=autocrop-auto=no" into
-    mpv.conf.
-
-auto_delay: seconds - Delay before starting crop in auto mode.
-    You can try to increase this value to avoid dark scene or
-    fade in at beginning. Automatic cropping will not occur if
-    the value is larger than the remaining playback time.
-
-detect_limit: number[0-255] - Black threshold for cropdetect.
-    Smaller values will generally result in less cropping.
-    See limit of https://ffmpeg.org/ffmpeg-filters.html#cropdetect
-
-detect_round: number[2^n] -  The value which the width/height
-    should be divisible by. Smaller values have better detection
-    accuracy. If you have problems with other filters,
-    you can try to set it to 4 or 16.
-    See round of https://ffmpeg.org/ffmpeg-filters.html#cropdetect
-
-detect_min_ratio: number[0.0-1.0] - The ratio of the minimum clip
-    size to the original. If the picture is over cropped or under
-    cropped, try adjusting this value.
-
-detect_seconds: seconds - How long to gather cropdetect data.
-    Increasing this may be desirable to allow cropdetect more
-    time to collect data.
-
-suppress_osd: bool - Whether the OSD shouldn't be used when filters
-    are applied and removed.
--]]
-
+-- This script uses the lavfi cropdetect filter to automatically
+-- insert a crop filter with appropriate parameters for the currently
+-- playing video.
+--
+-- It registers the key-binding "C" (shift+c), which when pressed,
+-- inserts the filter vf=lavfi=cropdetect. After 1 second, it then
+-- inserts the filter vf=crop=w:h:x:y, where w,h,x,y are determined
+-- from the vf-metadata gathered by cropdetect. The cropdetect filter
+-- is removed immediately after the crop filter is inserted as it is
+-- no longer needed.
+--
+-- If the "C" key is pressed again, the crop filter is removed
+-- restoring playback to its original state.
+--
+-- Since the crop parameters are determined from the 1 second of video
+-- between inserting the cropdetect and crop filters, the "C" key
+-- should be pressed at a position in the video where the crop region
+-- is unambiguous (i.e., not a black frame, black background title
+-- card, or dark scene).
+--
+-- The default delay between insertion of the cropdetect and
+-- crop filters may be overridden by adding
+--
+-- --script-opts=autocrop.detect_seconds=<number of seconds>
+--
+-- to mpv's arguments. This may be desirable to allow cropdetect more
+-- time to collect data.
 require "mp.msg"
-require 'mp.options'

-local options = {
-    auto = true,
-    auto_delay = 4,
-    detect_limit = "24/255",
-    detect_round = 2,
-    detect_min_ratio = 0.5,
-    detect_seconds = 1,
-    suppress_osd = false,
-}
-read_options(options)
+script_name = mp.get_script_name()
+cropdetect_label = string.format("%s-cropdetect", script_name)
+crop_label = string.format("%s-crop", script_name)

-local label_prefix = mp.get_script_name()
-local labels = {
-    crop = string.format("%s-crop", label_prefix),
-    cropdetect = string.format("%s-cropdetect", label_prefix)
-}
+-- number of seconds to gather cropdetect data
+detect_seconds = tonumber(mp.get_opt(string.format("%s.detect_seconds", script_name)))
+if not detect_seconds then
+    detect_seconds = 1
+end

-timers = {
-    auto_delay = nil,
-    detect_crop = nil
-}
-
-local command_prefix = options.suppress_osd and 'no-osd' or ''
-
-function is_filter_present(label)
-    local filters = mp.get_property_native("vf")
-    for index, filter in pairs(filters) do
-        if filter["label"] == label then
+function del_filter_if_present(label)
+    -- necessary because mp.command('vf del @label:filter') raises an
+    -- error if the filter doesn't exist
+    local vfs = mp.get_property_native("vf")
+    for i,vf in pairs(vfs) do
+        if vf["label"] == label then
+            table.remove(vfs, i)
+            mp.set_property_native("vf", vfs)
            return true
        end
    end
    return false
 end

-function is_enough_time(seconds)
-
-    -- Plus 1 second for deviation.
-    local time_needed = seconds + 1
-    local playtime_remaining = mp.get_property_native("playtime-remaining")
-
-    return playtime_remaining and time_needed < playtime_remaining
-end
-
-function is_cropable()
-    for _, track in pairs(mp.get_property_native('track-list')) do
-        if track.type == 'video' and track.selected then
-            return not track.albumart
-        end
-    end
-
-    return false
-end
-
-function remove_filter(label)
-    if is_filter_present(label) then
-        mp.command(string.format('%s vf remove @%s', command_prefix, label))
-        return true
-    end
-    return false
-end
-
-function cleanup()
-
-    -- Remove all existing filters.
-    for key, value in pairs(labels) do
-        remove_filter(value)
-    end
-
-    -- Kill all timers.
-    for index, timer in pairs(timers) do
-        if timer then
-            timer:kill()
-            timer = nil
-        end
-    end
-end
-
-function detect_crop()
-
-    -- If it's not cropable, exit.
-    if not is_cropable() then
-        mp.msg.warn("autocrop only works for videos.")
+function autocrop_start()
+    -- exit if cropdetection is already in progress
+    if timer then
+        mp.msg.warn("already cropdetecting!")
        return
    end

-    -- Verify if there is enough time to detect crop.
-    local time_needed = options.detect_seconds
-
-    if not is_enough_time(time_needed) then
-        mp.msg.warn("Not enough time to detect crop.")
+    -- if there's a crop filter, remove it and exit
+    if del_filter_if_present(crop_label) then
        return
    end

-    -- Insert the cropdetect filter.
-    local limit = options.detect_limit
-    local round = options.detect_round
-
-    mp.command(
+    -- insert the cropdetect filter
+    ret=mp.command(
        string.format(
-            '%s vf pre @%s:cropdetect=limit=%s:round=%d:reset=0',
-            command_prefix, labels.cropdetect, limit, round
+            'vf add @%s:lavfi=graph="cropdetect=limit=24:round=2:reset=0"',
+            cropdetect_label
        )
    )
-
-    -- Wait to gather data.
-    timers.detect_crop = mp.add_timeout(time_needed, detect_end)
+    -- wait to gather data
+    timer=mp.add_timeout(detect_seconds, do_crop)
 end

-function detect_end()
-
-    -- Get the metadata and remove the cropdetect filter.
-    local cropdetect_metadata =
-        mp.get_property_native(
-            string.format("vf-metadata/%s",
-            labels.cropdetect
-        )
+function do_crop()
+    -- get the metadata
+    local cropdetect_metadata = mp.get_property_native(
+        string.format("vf-metadata/%s", cropdetect_label)
    )
-    remove_filter(labels.cropdetect)
-
-    -- Remove the timer of detect crop.
-    if timers.detect_crop then
-        timers.detect_crop:kill()
-        timers.detect_crop = nil
-    end
-
-    local meta = {}
-
-    -- Verify the existence of metadata.
+    -- use it to crop if its valid
    if cropdetect_metadata then
-        meta = {
-            w = cropdetect_metadata["lavfi.cropdetect.w"],
-            h = cropdetect_metadata["lavfi.cropdetect.h"],
-            x = cropdetect_metadata["lavfi.cropdetect.x"],
-            y = cropdetect_metadata["lavfi.cropdetect.y"],
-        }
-    else
-        mp.msg.error("No crop data.")
-        mp.msg.info("Was the cropdetect filter successfully inserted?")
-        mp.msg.info("Does your version of ffmpeg/libav support AVFrame metadata?")
-        return
-    end
-
-    -- Verify that the metadata meets the requirements and convert it.
-    if meta.w and meta.h and meta.x and meta.y then
-        local width = mp.get_property_native("width")
-        local height = mp.get_property_native("height")
-
-        meta = {
-            w = tonumber(meta.w),
-            h = tonumber(meta.h),
-            x = tonumber(meta.x),
-            y = tonumber(meta.y),
-            min_w = width * options.detect_min_ratio,
-            min_h = height * options.detect_min_ratio,
-            max_w = width,
-            max_h = height
-        }
-    else
-        mp.msg.error("Got empty crop data.")
-        mp.msg.info("You might need to increase detect_seconds.")
-        return
-    end
-
-    apply_crop(meta)
-end
-
-function apply_crop(meta)
-
-    -- Verify if it is necessary to crop.
-    local is_effective = meta.x > 0 or meta.y > 0
-        or meta.w < meta.max_w or meta.h < meta.max_h
-
-    if not is_effective then
-        mp.msg.info("No area detected for cropping.")
-        return
-    end
-
-    -- Verify it is not over cropped.
-    local is_excessive = meta.w < meta.min_w and meta.h < meta.min_h
-
-    if is_excessive then
-        mp.msg.info("The area to be cropped is too large.")
-        mp.msg.info("You might need to decrease detect_min_ratio.")
-        return
-    end
-
-    -- Remove existing crop.
-    remove_filter(labels.crop)
-
-    -- Apply crop.
-    mp.command(
-        string.format("%s vf pre @%s:lavfi-crop=w=%s:h=%s:x=%s:y=%s",
-            command_prefix, labels.crop, meta.w, meta.h, meta.x, meta.y
-        )
-    )
-end
-
-function on_start()
-
-    -- Clean up at the beginning.
-    cleanup()
-
-    -- If auto is not true, exit.
-    if not options.auto then
-        return
-    end
-
-    -- If it is the beginning, wait for detect_crop
-    -- after auto_delay seconds, otherwise immediately.
-    local playback_time = mp.get_property_native("playback-time")
-    local is_delay_needed = playback_time
-        and options.auto_delay > playback_time
-
-    if is_delay_needed then
-
-        -- Verify if there is enough time for autocrop.
-        local time_needed = options.auto_delay + options.detect_seconds
-
-        if not is_enough_time(time_needed) then
-            mp.msg.warn("Not enough time for autocrop.")
-            return
+        if cropdetect_metadata["lavfi.cropdetect.w"]
+            and cropdetect_metadata["lavfi.cropdetect.h"]
+            and cropdetect_metadata["lavfi.cropdetect.x"]
+            and cropdetect_metadata["lavfi.cropdetect.y"]
+        then
+            mp.command(string.format("vf add @%s:crop=%s:%s:%s:%s",
+                                     crop_label,
+                                     cropdetect_metadata["lavfi.cropdetect.w"],
+                                     cropdetect_metadata["lavfi.cropdetect.h"],
+                                     cropdetect_metadata["lavfi.cropdetect.x"],
+                                     cropdetect_metadata["lavfi.cropdetect.y"]))
+        else
+            mp.msg.error(
+                "Got empty crop data. You might need to increase detect_seconds."
+            )
        end
-
-        timers.auto_delay = mp.add_timeout(time_needed,
-            function()
-                detect_crop()
-
-                -- Remove the timer of auto delay.
-                timers.auto_delay:kill()
-                timers.auto_delay = nil
-            end
-        )
    else
-        detect_crop()
+        mp.msg.error(
+            "No crop data. Was the cropdetect filter successfully inserted?"
+        )
+        mp.msg.error(
+            "Does your version of ffmpeg/libav support AVFrame metadata?"
+        )
    end
+    -- remove the cropdetect filter
+    del_filter_if_present(cropdetect_label)
+    timer=nil
 end

-function on_toggle()
-
-    -- If it is during auto_delay, kill the timer.
-    if timers.auto_delay then
-        timers.auto_delay:kill()
-        timers.auto_delay = nil
-    end
-
-    -- Cropped => Remove it.
-    if remove_filter(labels.crop) then
-        return
-    end
-
-    -- Detecting => Leave it.
-    if timers.detect_crop then
-        mp.msg.warn("Already cropdetecting!")
-        return
-    end
-
-    -- Neither => Do delectcrop.
-    detect_crop()
-end
-
-mp.add_key_binding("C", "toggle_crop", on_toggle)
-mp.register_event("end-file", cleanup)
-mp.register_event("file-loaded", on_start)
+mp.add_key_binding("C", "auto_crop", autocrop_start)
@@ -3,13 +3,13 @@
 -- currently playing video.
 --
 -- It registers the key-binding ctrl+d, which when pressed, inserts the filters
-- ``vf=idet,lavfi-pullup,idet``. After 4 seconds, it removes these
+-- ``vf=lavfi=idet,pullup,vf=lavfi=idet``. After 4 seconds, it removes these
 -- filters and decides whether the content is progressive, interlaced, or
 -- telecined and the interlacing field dominance.
 --
 -- Based on this information, it may set mpv's ``deinterlace`` property (which
 -- usually inserts the yadif filter), or insert the ``pullup`` filter if the
-- content is telecined.  It also sets field dominance with lavfi setfield.
+-- content is telecined.  It also sets mpv's ``field-dominance`` property.
 --
 -- OPTIONS:
 -- The default detection time may be overridden by adding
@@ -22,14 +22,16 @@
 -- To see counts of the various types of frames for each detection phase,
 -- the verbosity can be increased with
 --
-- --msg-level=autodeint=v
+-- --msg-level autodeint=v
+--
+-- This script requires a recent version of ffmpeg for which the idet
+-- filter adds the required metadata.

 require "mp.msg"

 script_name = mp.get_script_name()
 detect_label = string.format("%s-detect", script_name)
 pullup_label = string.format("%s", script_name)
-dominance_label = string.format("%s-dominance", script_name)
 ivtc_detect_label = string.format("%s-ivtc-detect", script_name)

 -- number of seconds to gather cropdetect data
@@ -53,10 +55,6 @@ function del_filter_if_present(label)
    return false
 end

-local function add_vf(label, filter)
-    return mp.command(('vf add @%s:%s'):format(label, filter))
-end
-
 function start_detect()
    -- exit if detection is already in progress
    if timer then
@@ -66,13 +64,11 @@ function start_detect()

    mp.set_property("deinterlace","no")
    del_filter_if_present(pullup_label)
-    del_filter_if_present(dominance_label)

-    -- insert the detection filters
-    if not (add_vf(detect_label, 'idet') and
-            add_vf(dominance_label, 'setfield=mode=auto') and
-            add_vf(pullup_label, 'lavfi-pullup') and
-            add_vf(ivtc_detect_label, 'idet')) then
+    -- insert the detection filter
+    local cmd = string.format('vf add @%s:lavfi=graph="idet",@%s:pullup,@%s:lavfi=graph="idet"',
+                              detect_label, pullup_label, ivtc_detect_label)
+    if not mp.command(cmd) then
        mp.msg.error("failed to insert detection filters")
        return
    end
@@ -92,12 +88,12 @@ progressive, interlaced_tff, interlaced_bff, interlaced = 0, 1, 2, 3, 4
 function judge(label)
    -- get the metadata
    local result = mp.get_property_native(string.format("vf-metadata/%s", label))
-    local num_tff          = tonumber(result["lavfi.idet.multiple.tff"])
-    local num_bff          = tonumber(result["lavfi.idet.multiple.bff"])
-    local num_progressive  = tonumber(result["lavfi.idet.multiple.progressive"])
-    local num_undetermined = tonumber(result["lavfi.idet.multiple.undetermined"])
-    local num_interlaced   = num_tff + num_bff
-    local num_determined   = num_interlaced + num_progressive
+    num_tff          = tonumber(result["lavfi.idet.multiple.tff"])
+    num_bff          = tonumber(result["lavfi.idet.multiple.bff"])
+    num_progressive  = tonumber(result["lavfi.idet.multiple.progressive"])
+    num_undetermined = tonumber(result["lavfi.idet.multiple.undetermined"])
+    num_interlaced   = num_tff + num_bff
+    num_determined   = num_interlaced + num_progressive

    mp.msg.verbose(label.." progressive    = "..num_progressive)
    mp.msg.verbose(label.." interlaced-tff = "..num_tff)
@@ -120,33 +116,26 @@ end

 function select_filter()
    -- handle the first detection filter results
-    local verdict = judge(detect_label)
-    local ivtc_verdict = judge(ivtc_detect_label)
-    local dominance = "auto"
+    verdict = judge(detect_label)
    if verdict == progressive then
        mp.msg.info("progressive: doing nothing")
        stop_detect()
-        del_filter_if_present(dominance_label)
-        del_filter_if_present(pullup_label)
        return
-    else
-        if verdict == interlaced_tff then
-            dominance = "tff"
-            add_vf(dominance_label, 'setfield=mode='..dominance)
-        elseif verdict == interlaced_bff then
-            dominance = "bff"
-            add_vf(dominance_label, 'setfield=mode='..dominance)
-        else
-            del_filter_if_present(dominance_label)
-        end
+    elseif verdict == interlaced_tff then
+        mp.set_property("field-dominance", "top")
+    elseif verdict == interlaced_bff then
+        mp.set_property("field-dominance", "bottom")
+    elseif verdict == interlaced then
+        mp.set_property("field-dominance", "auto")
    end

    -- handle the ivtc detection filter results
-    if ivtc_verdict == progressive then
-        mp.msg.info(string.format("telecined with %s field dominance: using pullup", dominance))
+    verdict = judge(ivtc_detect_label)
+    if verdict == progressive then
+        mp.msg.info(string.format("telecinied with %s field dominance: using pullup", mp.get_property("field-dominance")))
        stop_detect()
    else
-        mp.msg.info(string.format("interlaced with %s field dominance: setting deinterlace property", dominance))
+        mp.msg.info(string.format("interlaced with %s field dominance: setting deinterlace property", mp.get_property("field-dominance")))
        del_filter_if_present(pullup_label)
        mp.set_property("deinterlace","yes")
        stop_detect()
@@ -2,78 +2,30 @@
 -- the currently played file. It does so by scanning the directory a file is
 -- located in when starting playback. It sorts the directory entries
 -- alphabetically, and adds entries before and after the current file to
-- the internal playlist. (It stops if it would add an already existing
+-- the internal playlist. (It stops if the it would add an already existing
 -- playlist entry at the same position - this makes it "stable".)
 -- Add at most 5000 * 2 files when starting a file (before + after).
-
--[[
-To configure this script use file autoload.conf in directory script-opts (the "script-opts"
-directory must be in the mpv configuration directory, typically ~/.config/mpv/).
-
-Example configuration would be:
-
-disabled=no
-images=no
-videos=yes
-audio=yes
-ignore_hidden=yes
-
--]]
-
 MAXENTRIES = 5000

-local msg = require 'mp.msg'
-local options = require 'mp.options'
-local utils = require 'mp.utils'
-
-o = {
-    disabled = false,
-    images = true,
-    videos = true,
-    audio = true,
-    ignore_hidden = true
-}
-options.read_options(o)
-
 function Set (t)
    local set = {}
    for _, v in pairs(t) do set[v] = true end
    return set
 end

-function SetUnion (a,b)
-    local res = {}
-    for k in pairs(a) do res[k] = true end
-    for k in pairs(b) do res[k] = true end
-    return res
-end
-
-EXTENSIONS_VIDEO = Set {
-    '3g2', '3gp', 'avi', 'flv', 'm2ts', 'm4v', 'mj2', 'mkv', 'mov',
-    'mp4', 'mpeg', 'mpg', 'ogv', 'rmvb', 'webm', 'wmv', 'y4m'
+EXTENSIONS = Set {
+    'mkv', 'avi', 'mp4', 'ogv', 'webm', 'rmvb', 'flv', 'wmv', 'mpeg', 'mpg', 'm4v', '3gp',
+    'mp3', 'wav', 'ogv', 'flac', 'm4a', 'wma',
 }

-EXTENSIONS_AUDIO = Set {
-    'aiff', 'ape', 'au', 'flac', 'm4a', 'mka', 'mp3', 'oga', 'ogg',
-    'ogm', 'opus', 'wav', 'wma'
-}
-
-EXTENSIONS_IMAGES = Set {
-    'avif', 'bmp', 'gif', 'j2k', 'jp2', 'jpeg', 'jpg', 'jxl', 'png',
-    'svg', 'tga', 'tif', 'tiff', 'webp'
-}
-
-EXTENSIONS = Set {}
-if o.videos then EXTENSIONS = SetUnion(EXTENSIONS, EXTENSIONS_VIDEO) end
-if o.audio then EXTENSIONS = SetUnion(EXTENSIONS, EXTENSIONS_AUDIO) end
-if o.images then EXTENSIONS = SetUnion(EXTENSIONS, EXTENSIONS_IMAGES) end
+mputils = require 'mp.utils'

 function add_files_at(index, files)
    index = index - 1
    local oldcount = mp.get_property_number("playlist-count", 1)
    for i = 1, #files do
        mp.commandv("loadfile", files[i], "append")
-        mp.commandv("playlist-move", oldcount + i - 1, index + i - 1)
+        mp.commandv("playlist_move", oldcount + i - 1, index + i - 1)
    end
 end

@@ -94,99 +46,46 @@ table.filter = function(t, iter)
    end
 end

-- splitbynum and alnumcomp from alphanum.lua (C) Andre Bogus
-- Released under the MIT License
-- http://www.davekoelle.com/files/alphanum.lua
-
-- split a string into a table of number and string values
-function splitbynum(s)
-    local result = {}
-    for x, y in (s or ""):gmatch("(%d*)(%D*)") do
-        if x ~= "" then table.insert(result, tonumber(x)) end
-        if y ~= "" then table.insert(result, y) end
-    end
-    return result
-end
-
-function clean_key(k)
-    k = (' '..k..' '):gsub("%s+", " "):sub(2, -2):lower()
-    return splitbynum(k)
-end
-
-- compare two strings
-function alnumcomp(x, y)
-    local xt, yt = clean_key(x), clean_key(y)
-    for i = 1, math.min(#xt, #yt) do
-        local xe, ye = xt[i], yt[i]
-        if type(xe) == "string" then ye = tostring(ye)
-        elseif type(ye) == "string" then xe = tostring(xe) end
-        if xe ~= ye then return xe < ye end
-    end
-    return #xt < #yt
-end
-
-local autoloaded = nil
-
-function get_playlist_filenames()
-  local filenames = {}
-  for n = 0, pl_count - 1, 1 do
-    local filename = mp.get_property('playlist/'..n..'/filename')
-    local _, file = utils.split_path(filename)
-    filenames[file] = true
-  end
-  return filenames
-end
-
 function find_and_add_entries()
    local path = mp.get_property("path", "")
-    local dir, filename = utils.split_path(path)
-    msg.trace(("dir: %s, filename: %s"):format(dir, filename))
-    if o.disabled then
-        msg.verbose("stopping: autoload disabled")
-        return
-    elseif #dir == 0 then
-        msg.verbose("stopping: not a local path")
+    local dir, filename = mputils.split_path(path)
+    if #dir == 0 then
        return
    end
-
-    pl_count = mp.get_property_number("playlist-count", 1)
-    -- check if this is a manually made playlist
-    if (pl_count > 1 and autoloaded == nil) or
+    local pl_count = mp.get_property_number("playlist-count", 1)
+    if (pl_count > 1 and autoload == nil) or
       (pl_count == 1 and EXTENSIONS[string.lower(get_extension(filename))] == nil) then
-        msg.verbose("stopping: manually made playlist")
        return
    else
-        autoloaded = true
+        autoload = true
    end

-    local pl = mp.get_property_native("playlist", {})
-    local pl_current = mp.get_property_number("playlist-pos-1", 1)
-    msg.trace(("playlist-pos-1: %s, playlist: %s"):format(pl_current,
-        utils.to_string(pl)))
-
-    local files = utils.readdir(dir, "files")
+    local files = mputils.readdir(dir, "files")
    if files == nil then
-        msg.verbose("no other files in directory")
        return
    end
    table.filter(files, function (v, k)
-        -- The current file could be a hidden file, ignoring it doesn't load other
-        -- files from the current directory.
-        if (o.ignore_hidden and not (v == filename) and string.match(v, "^%.")) then
-            return false
-        end
        local ext = get_extension(v)
        if ext == nil then
            return false
        end
        return EXTENSIONS[string.lower(ext)]
    end)
-    table.sort(files, alnumcomp)
+    table.sort(files, function (a, b)
+        local len = string.len(a) - string.len(b)
+        if len ~= 0 then -- case for ordering filename ending with such as X.Y.Z
+            local ext = string.len(get_extension(a)) + 1
+            return string.sub(a, 1, -ext) < string.sub(b, 1, -ext)
+        end
+        return string.lower(a) < string.lower(b)
+    end)

    if dir == "." then
        dir = ""
    end

+    local pl = mp.get_property_native("playlist", {})
+    local pl_current = mp.get_property_number("playlist-pos", 0) + 1
    -- Find the current pl entry (dir+"/"+filename) in the sorted dir list
    local current
    for i = 1, #files do
@@ -198,28 +97,31 @@ function find_and_add_entries()
    if current == nil then
        return
    end
-    msg.trace("current file position in files: "..current)

    local append = {[-1] = {}, [1] = {}}
-    local filenames = get_playlist_filenames()
    for direction = -1, 1, 2 do -- 2 iterations, with direction = -1 and +1
        for i = 1, MAXENTRIES do
            local file = files[current + i * direction]
+            local pl_e = pl[pl_current + i * direction]
            if file == nil or file[1] == "." then
                break
            end

            local filepath = dir .. file
-            -- skip files already in playlist
-            if filenames[file] then break end
+            if pl_e then
+                -- If there's a playlist entry, and it's the same file, stop.
+                if pl_e.filename == filepath then
+                    break
+                end
+            end

            if direction == -1 then
                if pl_current == 1 then -- never add additional entries in the middle
-                    msg.info("Prepending " .. file)
+                    mp.msg.info("Prepending " .. file)
                    table.insert(append[-1], 1, filepath)
                end
            else
-                msg.info("Adding " .. file)
+                mp.msg.info("Adding " .. file)
                table.insert(append[1], filepath)
            end
        end
@@ -1,124 +0,0 @@
-- Test script for some command API details.
-
-local utils = require("mp.utils")
-
-function join(sep, arr, count)
-    local r = ""
-    if count == nil then
-        count = #arr
-    end
-    for i = 1, count do
-        if i > 1 then
-            r = r .. sep
-        end
-        r = r .. utils.to_string(arr[i])
-    end
-    return r
-end
-
-mp.observe_property("vo-configured", "bool", function(_, v)
-    if v ~= true then
-        return
-    end
-
-    print("async expand-text")
-    mp.command_native_async({"expand-text", "hello ${path}!"},
-        function(res, val, err)
-            print("done async expand-text: " .. join(" ", {res, val, err}))
-        end)
-
-    -- make screenshot writing very slow
-    mp.set_property("screenshot-format", "png")
-    mp.set_property("screenshot-png-compression", "9")
-
-    timer = mp.add_periodic_timer(0.1, function() print("I'm alive") end)
-    timer:resume()
-
-    print("Slow screenshot command...")
-    res, err = mp.command_native({"screenshot"})
-    print("done, res: " .. utils.to_string(res))
-
-    print("Slow screenshot async command...")
-    res, err = mp.command_native_async({"screenshot"}, function(res)
-        print("done (async), res: " .. utils.to_string(res))
-        timer:kill()
-    end)
-    print("done (sending), res: " .. utils.to_string(res))
-
-    print("Broken screenshot async command...")
-    mp.command_native_async({"screenshot-to-file", "/nonexistent/bogus.png"},
-        function(res, val, err)
-            print("done err scr.: " .. join(" ", {res, val, err}))
-        end)
-
-    mp.command_native_async({name = "subprocess", args = {"sh", "-c", "echo hi && sleep 10s"}, capture_stdout = true},
-        function(res, val, err)
-            print("done subprocess: " .. join(" ", {res, val, err}))
-        end)
-
-    local x = mp.command_native_async({name = "subprocess", args = {"sleep", "inf"}},
-        function(res, val, err)
-            print("done sleep inf subprocess: " .. join(" ", {res, val, err}))
-        end)
-    mp.add_timeout(15, function()
-        print("aborting sleep inf subprocess after timeout")
-        mp.abort_async_command(x)
-    end)
-
-    -- (assuming this "freezes")
-    local y = mp.command_native_async({name = "sub-add", url = "-"},
-        function(res, val, err)
-            print("done sub-add stdin: " .. join(" ", {res, val, err}))
-        end)
-    mp.add_timeout(20, function()
-        print("aborting sub-add stdin after timeout")
-        mp.abort_async_command(y)
-    end)
-
-
-    mp.command_native_async({name = "subprocess", args = {"wc", "-c"},
-                             stdin_data = "hello", capture_stdout = true},
-        function(res, val, err)
-            print("Should be '5': " .. val.stdout)
-        end)
-    -- blocking stdin by default
-    mp.command_native_async({name = "subprocess", args = {"cat"},
-                             capture_stdout = true},
-        function(res, val, err)
-            print("Should be 0: " .. #val.stdout)
-        end)
-    -- stdin + detached
-    mp.command_native_async({name = "subprocess",
-                             args = {"bash", "-c", "(sleep 5s ; cat)"},
-                             stdin_data = "this should appear after 5s.\n",
-                             detach = true},
-        function(res, val, err)
-            print("5s test: " .. val.status)
-        end)
-
-    -- This should get killed on script exit.
-    mp.command_native_async({name = "subprocess", playback_only = false,
-                             args = {"sleep", "inf"}}, function()end)
-
-    -- Runs detached; should be killed on player exit (forces timeout)
-    mp.command_native({_flags={"async"}, name = "subprocess",
-                       playback_only = false, args = {"sleep", "inf"}})
-end)
-
-function freeze_test(playback_only)
-    -- This "freezes" the script, should be killed via timeout.
-    counter = counter and counter + 1 or 0
-    print("freeze! " .. counter)
-    local x = mp.command_native({name = "subprocess",
-                                 playback_only = playback_only,
-                                 args = {"sleep", "inf"}})
-    print("done, killed=" .. utils.to_string(x.killed_by_us))
-end
-
-mp.register_event("shutdown", function()
-    freeze_test(false)
-end)
-
-mp.register_event("idle", function()
-    freeze_test(true)
-end)
@@ -0,0 +1,99 @@
+-- This script enables live control of the dynamic range compression
+-- (drc) audio filter while the video is playing back. This can be
+-- useful to avoid having to stop and restart mpv to adjust filter
+-- parameters. See the entry for "drc" under the "AUDIO FILTERS"
+-- section of the man page for a complete description of the filter.
+--
+-- This script registers the key-binding "\" to toggle the filter between
+--
+-- * off
+-- * method=1 (single-sample smoothing)
+-- * method=2 (multi-sample smoothing)
+--
+-- It registers the keybindings ctrl+9/ctrl+0 to decrease/increase the
+-- target ampltiude. These keys will insert the filter at the default
+-- target amplitude of 0.25 if it was not previously present.
+--
+-- OSD feedback of the current filter state is displayed on pressing
+-- each bound key.
+
+script_name = mp.get_script_name()
+
+function print_state(params)
+    if params then
+        mp.osd_message(script_name..":\n"
+                           .."method = "..params["method"].."\n"
+                           .."target = "..params["target"])
+    else
+        mp.osd_message(script_name..":\noff")
+    end
+end
+
+function get_index_of_drc(afs)
+    for i,af in pairs(afs) do
+        if af["label"] == script_name then
+            return i
+        end
+    end
+end
+
+function append_drc(afs)
+    afs[#afs+1] = {
+        name   = "drc",
+        label  = script_name,
+        params = {
+            method = "1",
+            target = "0.25"
+        }
+    }
+    print_state(afs[#afs]["params"])
+end
+
+function modify_or_create_af(fun)
+    afs = mp.get_property_native("af")
+    i = get_index_of_drc(afs)
+    if not i then
+        append_drc(afs)
+    else
+        fun(afs, i)
+    end
+    mp.set_property_native("af", afs)
+end
+
+function drc_toggle_method_handler()
+    modify_or_create_af(
+        function (afs, i)
+            new_method=(afs[i]["params"]["method"]+1)%3
+            if new_method == 0 then
+                table.remove(afs, i)
+                print_state(nil)
+            else
+                afs[i]["params"]["method"] = tostring((afs[i]["params"]["method"])%2+1)
+                print_state(afs[i]["params"])
+            end
+        end
+    )
+end
+
+function drc_scale_target(factor)
+    modify_or_create_af(
+        function (afs)
+            afs[i]["params"]["target"] = tostring(afs[i]["params"]["target"]*factor)
+            print_state(afs[i]["params"])
+        end
+    )
+end
+
+function drc_louder_handler()
+    drc_scale_target(2.0)
+end
+
+function drc_quieter_handler()
+    drc_scale_target(0.5)
+end
+
+-- toggle between off, method 1 and method 2
+mp.add_key_binding("\\", "drc_toggle_method", drc_toggle_method_handler)
+-- increase or decrease target volume
+mp.add_key_binding("ctrl+9", "drc_quieter", drc_quieter_handler)
+mp.add_key_binding("ctrl+0", "drc_louder", drc_louder_handler)
@@ -1,37 +0,0 @@
-- Test a float property which internally uses NaN.
-- Run with --no-config (or just scale-param1 not set).
-
-local utils = require 'mp.utils'
-
-prop_name = "scale-param1"
-
-- internal NaN, return string "default" instead of NaN
-v = mp.get_property_native(prop_name, "fail")
-print("Exp:", "string", "\"default\"")
-print("Got:", type(v), utils.to_string(v))
-
-v = mp.get_property(prop_name)
-print("Exp:", "default")
-print("Got:", v)
-
-- not representable -> return provided fallback value
-v = mp.get_property_number(prop_name, -100)
-print("Exp:", -100)
-print("Got:", v)
-
-mp.set_property_native(prop_name, 123)
-v = mp.get_property_number(prop_name, -100)
-print("Exp:", "number", 123)
-print("Got:", type(v), utils.to_string(v))
-
-- try to set an actual NaN
-st, msg = mp.set_property_number(prop_name, 0.0/0)
-print("Exp:", nil, "<message>")
-print("Got:", st, msg)
-
-- set default
-mp.set_property(prop_name, "default")
-
-v = mp.get_property(prop_name)
-print("Exp:", "default")
-print("Got:", v)
@@ -6,17 +6,9 @@

 local utils = require("mp.utils")

-function observe(name)
+for i,name in ipairs(mp.get_property_native("property-list")) do
    mp.observe_property(name, "native", function(name, val)
        print("property '" .. name .. "' changed to '" ..
              utils.to_string(val) .. "'")
    end)
 end
-
-for i,name in ipairs(mp.get_property_native("property-list")) do
-    observe(name)
-end
-
-for i,name in ipairs(mp.get_property_native("options")) do
-    observe("options/" .. name)
-end
@@ -1,35 +0,0 @@
-local assdraw = require 'mp.assdraw'
-local utils = require 'mp.utils'
-
-things = {}
-for i = 1, 2 do
-    things[i] = {
-        osd1 = mp.create_osd_overlay("ass-events"),
-        osd2 = mp.create_osd_overlay("ass-events")
-    }
-end
-things[1].text = "{\\an5}hello\\Nworld"
-things[2].text = "{\\pos(400, 200)}something something"
-
-mp.add_periodic_timer(2, function()
-    for i, thing in ipairs(things) do
-        thing.osd1.data = thing.text
-        thing.osd1.compute_bounds = true
-        --thing.osd1.hidden = true
-        local res = thing.osd1:update()
-        print("res " .. i .. ": " .. utils.to_string(res))
-
-        thing.osd2.hidden = true
-        if res ~= nil and res.x0 ~= nil then
-            local draw = assdraw.ass_new()
-            draw:append("{\\alpha&H80}")
-            draw:draw_start()
-            draw:pos(0, 0)
-            draw:rect_cw(res.x0, res.y0, res.x1, res.y1)
-            draw:draw_stop()
-            thing.osd2.hidden = false
-            thing.osd2.data = draw.text
-        end
-        thing.osd2:update()
-    end
-end)
@@ -1,265 +0,0 @@
--[[
-
-Automatically skip in files if video frames with pre-supplied fingerprints are
-detected. This will skip ahead by a pre-configured amount of time if a matching
-video frame is detected.
-
-This requires the vf_fingerprint video filter to be compiled in. Read the
-documentation of this filter for caveats (which will automatically apply to
-this script as well), such as no support for zero-copy hardware decoding.
-
-You need to manually gather and provide fingerprints for video frames and add
-them to a configuration file in script-opts/skip-logo.conf (the "script-opts"
-directory must be in the mpv configuration directory, typically ~/.config/mpv/).
-
-Example script-opts/skip-logo.conf:
-
-
-    cases = {
-        {
-            -- Skip ahead 10 seconds if a black frame was detected
-            -- Note: this is dangerous non-sense. It's just for demonstration.
-            name = "black frame",   -- print if matched
-            skip = 10,              -- number of seconds to skip forward
-            score = 0.3,            -- required score
-            fingerprint = "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
-        },
-        {
-            -- Skip ahead 20 seconds if a white frame was detected
-            -- Note: this is dangerous non-sense. It's just for demonstration.
-            name = "fun2",
-            skip = 20,
-            fingerprint = "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
-        },
-    }
-
-This is actually a lua file. Lua was chosen because it seemed less of a pain to
-parse. Future versions of this script may change the format.
-
-The fingerprint is a video frame, converted to "gray" (8 bit per pixels), full
-range, each pixel concatenated into an array, converted to a hex string. You
-can produce these fingerprints by running this manually:
-
-   mpv --vf=fingerprint:print yourfile.mkv
-
-This will log the fingerprint of each video frame to the console, along with its
-timestamp. You find the fingerprint of a unique-enough looking frame, and add
-it as entry to skip-logo.conf.
-
-You can provide a score for "fuzziness". If no score is provided, a default
-value of 0.3 is used. The score is inverse: 0 means exactly the same, while a
-higher score means a higher difference. Currently, the score is computed as
-euclidean distance between the video frame and the pre-provided fingerprint,
-thus the highest score is 16. You probably want a score lower than 1 at least.
-(This algorithm is very primitive, but also simple and fast to compute.)
-
-There's always the danger of false positives, which might be quite annoying.
-It's up to you what you hate more, the logo, or random skips if false positives
-are detected. Also, it's always active, and might eat too much CPU with files
-that have a high resolution or framerate. To temporarily disable the script,
-having a keybind like this in your input.conf will be helpful:
-
-    ctrl+k vf toggle @skip-logo
-
-This will disable/enable the fingerprint filter, which the script automatically
-adds at start.
-
-Another important caveat is that the script currently disables matching during
-seeking or playback initialization, which means it cannot match the first few
-frames of a video. This could be fixed, but the author was too lazy to do so.
-
--]]
-
-local utils = require "mp.utils"
-local msg = require "mp.msg"
-
-local label = "skip-logo"
-local meta_property = string.format("vf-metadata/%s", label)
-
-local config = {}
-local cases = {}
-local cur_bmp
-local seeking = false
-local playback_start_pts = nil
-
-- Convert a  hex string to an array. Convert each byte to a [0,1] float by
-- interpreting it as normalized uint8_t.
-- The data parameter, if not nil, may be used as storage (avoiding garbage).
-local function hex_to_norm8(hex, data)
-    local size = math.floor(#hex / 2)
-    if #hex ~= size * 2 then
-        return nil
-    end
-    local res
-    if (data ~= nil) and (#data == size) then
-        res = data
-    else
-        res = {}
-    end
-    for i = 1, size do
-        local num = tonumber(hex:sub(i * 2, i * 2 + 1), 16)
-        if num == nil then
-            return nil
-        end
-        res[i] = num / 255.0
-    end
-    return res
-end
-
-local function compare_bmp(a, b)
-    if #a ~= #b then
-        return nil -- can't compare
-    end
-    local sum = 0
-    for i = 1, #a do
-        local diff = a[i] - b[i]
-        sum = sum + diff * diff
-    end
-    return math.sqrt(sum)
-end
-
-local function load_config()
-    local conf_file = mp.find_config_file("script-opts/skip-logo.conf")
-    local conf_fn
-    local err = nil
-    if conf_file then
-        if setfenv then
-            conf_fn, err = loadfile(conf_file)
-            if conf_fn then
-                setfenv(conf_fn, config)
-            end
-        else
-            conf_fn, err = loadfile(conf_file, "t", config)
-        end
-    else
-        err = "config file not found"
-    end
-
-    if conf_fn and (not err) then
-        local ok, err2 = pcall(conf_fn)
-        err = err2
-    end
-
-    if err then
-        msg.error("Failed to load config file:", err)
-    end
-
-    if config.cases then
-        for n, case in ipairs(config.cases) do
-            local err = nil
-            case.bitmap = hex_to_norm8(case.fingerprint)
-            if case.bitmap == nil then
-                err = "invalid or missing fingerprint field"
-            end
-            if case.score == nil then
-                case.score = 0.3
-            end
-            if type(case.score) ~= "number" then
-                err = "score field is not a number"
-            end
-            if type(case.skip) ~= "number" then
-                err = "skip field is not a number or missing"
-            end
-            if case.name == nil then
-                case.name = ("Entry %d"):format(n)
-            end
-            if err == nil then
-                cases[#cases + 1] = case
-            else
-                msg.error(("Entry %s: %s, ignoring."):format(case.name, err))
-            end
-        end
-    end
-end
-
-load_config()
-
-- Returns true on match and if something was done.
-local function check_fingerprint(hex, pts)
-    local bmp = hex_to_norm8(hex, cur_bmp)
-    cur_bmp = bmp
-
-    -- If parsing the filter's result failed (well, it shouldn't).
-    assert(bmp ~= nil, "filter returned nonsense")
-
-    for _, case in ipairs(cases) do
-        local score = compare_bmp(case.bitmap, bmp)
-        if (score ~= nil) and (score <= case.score) then
-            msg.warn(("Matching %s: score=%f (required: %f) at %s, skipping %f seconds"):
-                format(case.name, score, case.score, mp.format_time(pts), case.skip))
-            mp.commandv("seek", pts + case.skip, "absolute+exact")
-            return true
-        end
-    end
-
-    return false
-end
-
-local function read_frames()
-    local result = mp.get_property_native(meta_property)
-    if result == nil then
-        return
-    end
-
-    -- Try to get all entries. Out of laziness, assume that there are at most
-    -- 100 entries. (In fact, vf_fingerprint limits it to 10.)
-    for i = 0, 99 do
-        local prefix = string.format("fp%d.", i)
-        local hex = result[prefix .. "hex"]
-
-        local pts = tonumber(result[prefix .. "pts"])
-        if (hex == nil) or (pts == nil) then
-            break
-        end
-
-        local skip = false -- blame Lua for not having "continue" or "goto", not me
-
-        -- If seeking just stopped, there will be frames before the seek target,
-        -- ignore them by checking the timestamps.
-        if playback_start_pts ~= nil then
-            if pts >= playback_start_pts then
-                playback_start_pts = nil -- just for robustness
-            else
-                skip = true
-            end
-        end
-
-        if not skip then
-            if check_fingerprint(hex, pts) then
-                break
-            end
-        end
-    end
-end
-
-mp.observe_property(meta_property, "none", function()
-    -- Ignore frames that are decoded/filtered during seeking.
-    if seeking then
-        return
-    end
-
-    read_frames()
-end)
-
-mp.observe_property("seeking", "bool", function(name, val)
-    seeking = val
-    if seeking == false then
-        playback_start_pts = mp.get_property_number("playback-time")
-        read_frames()
-    end
-end)
-
-local filters = mp.get_property_native("option-info/vf/choices", {})
-local found = false
-for _, f in ipairs(filters) do
-    if f == "fingerprint" then
-        found = true
-        break
-    end
-end
-
-if found then
-    mp.command(("no-osd vf add @%s:fingerprint"):format(label, filter))
-else
-    msg.warn("vf_fingerprint not found")
-end
@@ -18,10 +18,10 @@ function update_status_line()
        atsl("(Buffering) ")
    end

-    if mp.get_property("aid") ~= "no" then
+    if mp.get_property("vid") ~= "no" then
        atsl("A")
    end
-    if mp.get_property("vid") ~= "no" then
+    if mp.get_property("aid") ~= "no" then
        atsl("V")
    end

@@ -43,7 +43,7 @@ function update_status_line()

    r = mp.get_property_number("avsync", nil)
    if r ~= nil then
-        atsl(string.format(" A-V: %f", r))
+        atsl(string.format(" A-V: %7.3f", r))
    end

    r = mp.get_property("total-avsync-change", 0)
@@ -51,24 +51,12 @@ function update_status_line()
        atsl(string.format(" ct:%7.3f", r))
    end

-    r = mp.get_property_number("decoder-drop-frame-count", -1)
+    r = mp.get_property_number("drop-frame-count", -1)
    if r > 0 then
        atsl(" Late: ")
        atsl(r)
    end

-    r = mp.get_property_osd("video-bitrate")
-    if r ~= nil and r ~= "" then
-        atsl(" Vb: ")
-        atsl(r)
-    end
-
-    r = mp.get_property_osd("audio-bitrate")
-    if r ~= nil and r ~= "" then
-        atsl(" Ab: ")
-        atsl(r)
-    end
-
    r = mp.get_property_number("cache", 0)
    if r > 0 then
        atsl(string.format(" Cache: %d%% ", r))
@@ -78,15 +66,6 @@ function update_status_line()
    mp.set_property("options/term-status-msg", newStatus)
 end

-timer = mp.add_periodic_timer(1, update_status_line)
+-- Register the event
+mp.register_event("tick", update_status_line)

-function on_pause_change(name, value)
-    if value == false then
-        timer:resume()
-    else
-        timer:stop()
-    end
-    mp.add_timeout(0.1, update_status_line)
-end
-mp.observe_property("pause", "bool", on_pause_change)
-mp.register_event("seek", update_status_line)
@@ -1,32 +0,0 @@
-local utils = require("mp.utils")
-
-function hardsleep()
-    os.execute("sleep 1s")
-end
-
-local hooks = {"on_before_start_file", "on_load", "on_load_fail",
-               "on_preloaded", "on_unload", "on_after_end_file"}
-
-for _, name in ipairs(hooks) do
-    mp.add_hook(name, 0, function()
-        print("--- hook: " .. name)
-        hardsleep()
-        print("    ... continue")
-    end)
-end
-
-local events = {"start-file", "end-file", "file-loaded", "seek",
-                "playback-restart", "idle", "shutdown"}
-for _, name in ipairs(events) do
-    mp.register_event(name, function()
-        print("--- event: " .. name)
-    end)
-end
-
-local props = {"path", "metadata"}
-for _, name in ipairs(props) do
-    mp.observe_property(name, "native", function(name, val)
-        print("property '" .. name .. "' changed to '" ..
-              utils.to_string(val) .. "'")
-    end)
-end
Author	SHA1	Message	Date
Martin Herkt	9d2980dab7	Release 0.16.0	2016-02-29 00:22:04 +01:00
Martin Herkt	21cd4ff05b	Merge branch 'master' into release/current	2016-02-28 23:31:51 +01:00
Martin Herkt	d1d6257731	Release 0.15.0	2016-01-18 07:28:12 +01:00
Martin Herkt	ba9b2f1e49	Merge branch 'master' into release/current	2016-01-18 07:27:03 +01:00
Martin Herkt	e1993d5ad2	Release 0.14.0	2015-12-11 19:20:29 +01:00
Martin Herkt	0607dcebff	Merge branch 'master' into release/current	2015-12-11 18:33:38 +01:00
Martin Herkt	a33a44cf4e	Release 0.13.0	2015-11-10 19:14:14 +01:00
Martin Herkt	273607c1c6	Merge branch 'master' into release/current	2015-11-10 18:45:08 +01:00
Martin Herkt	5b7d0fbab3	Release 0.12.0	2015-10-29 03:49:43 +01:00
Martin Herkt	ec567d8a77	Merge branch 'master' into release/current	2015-10-29 02:56:49 +01:00
Martin Herkt	f8c57433b9	Release 0.11.0	2015-09-23 01:13:22 +02:00
Martin Herkt	ead2933792	Merge branch 'master' into release/current	2015-09-23 01:12:42 +02:00
Martin Herkt	181e1377b2	Release 0.10.0	2015-09-03 19:59:59 +02:00