From 0004aaf7884b51b56b04a6dbe1812237b7201fad Mon Sep 17 00:00:00 2001
From: wm4 <wm4@nowhere>
Date: Thu, 3 Jul 2014 01:24:41 +0200
Subject: DOCS: add a file listing API changes for the client API

---
 DOCS/client-api-changes.rst | 35 +++++++++++++++++++++++++++++++++++
 DOCS/man/input.rst          |  1 +
 2 files changed, 36 insertions(+)
 create mode 100644 DOCS/client-api-changes.rst

(limited to 'DOCS')

diff --git a/DOCS/client-api-changes.rst b/DOCS/client-api-changes.rst
new file mode 100644
index 0000000000..548832be5f
--- /dev/null
+++ b/DOCS/client-api-changes.rst
@@ -0,0 +1,35 @@
+Introduction
+============
+
+This file lists all changes that can cause compatibility issues when using
+mpv through the client API (libmpv and ``client.h``). Since the client API
+interfaces to input handling (commands, properties) as well as command line
+options, this list is interesting for other uses of mpv, such as the Lua
+scripting interface, key bindings in ``input.rst``, or plain command line
+usage.
+
+Normally, changes to the C API that are incompatible to previous iterations
+receive a major version bump (i.e. the first version number is increased),
+while C API additions bump the minor version (i.e. the second number is
+increased). Changes to properties/commands/options may also lead to a minor
+version bump, in particular if they are incompatible.
+
+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``.
+
+API changes
+===========
+
+ 1.1    - remap dvdnav:// to dvd://
+        - add "--cache-file", "--cache-file-size"
+        - add "--colormatrix-primaries" (and property)
+        - add "primaries" sub-field to image format properties
+        - add "playback-time" property
+        - extend the "--start" option; a leading "+", which was previously
+          insignificant is now significant
+        - add "cache-free" and "cache-used" properties
+        - OSX: the "coreaudio" AO spdif code is split into a separate AO
+ 1.0    - the API is declared stable
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 2e0f06c252..da3bd8f2a1 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -987,6 +987,7 @@ Property list
                 "par"               MPV_FORMAT_DOUBLE
                 "colormatrix"       MPV_FORMAT_STRING
                 "colorlevels"       MPV_FORMAT_STRING
+                "primaries"         MPV_FORMAT_STRING
                 "chroma-location"   MPV_FORMAT_STRING
                 "rotate"            MPV_FORMAT_INT64
 
-- 
cgit v1.2.3