diff options
author | wm4 <wm4@nowhere> | 2018-02-20 13:30:18 +0100 |
---|---|---|
committer | Kevin Mitchell <kevmitch@gmail.com> | 2018-02-28 00:55:06 -0800 |
commit | b03712143012f08591de59d09675fdd3a0eaeed8 (patch) | |
tree | 34bdfe31802573c1452dcbe023610acad3f1b5a9 /DOCS | |
parent | e76fda8594a7fa19888260c86d95396c5e799cad (diff) | |
download | mpv-b03712143012f08591de59d09675fdd3a0eaeed8.tar.bz2 mpv-b03712143012f08591de59d09675fdd3a0eaeed8.tar.xz |
client API: deprecate opengl-cb API and introduce a replacement API
The purpose of the new API is to make it useable with other APIs than
OpenGL, especially D3D11 and vulkan. In theory it's now possible to
support other vo_gpu backends, as well as backends that don't use the
vo_gpu code at all.
This also aims to get rid of the dumb mpv_get_sub_api() function. The
life cycle of the new mpv_render_context is a bit different from
mpv_opengl_cb_context, and you explicitly create/destroy the new
context, instead of calling init/uninit on an object returned by
mpv_get_sub_api().
In other to make the render API generic, it's annoyingly EGL style, and
requires you to pass in API-specific objects to generic functions. This
is to avoid explicit objects like the internal ra API has, because that
sounds more complicated and annoying for an API that's supposed to never
change.
The opengl_cb API will continue to exist for a bit longer, but
internally there are already a few tradeoffs, like reduced
thread-safety.
Mostly untested. Seems to work fine with mpc-qt.
Diffstat (limited to 'DOCS')
-rw-r--r-- | DOCS/client-api-changes.rst | 13 | ||||
-rw-r--r-- | DOCS/interface-changes.rst | 2 | ||||
-rw-r--r-- | DOCS/man/options.rst | 3 | ||||
-rw-r--r-- | DOCS/man/vo.rst | 9 |
4 files changed, 23 insertions, 4 deletions
diff --git a/DOCS/client-api-changes.rst b/DOCS/client-api-changes.rst index df2b42aa70..845953580a 100644 --- a/DOCS/client-api-changes.rst +++ b/DOCS/client-api-changes.rst @@ -33,6 +33,19 @@ API changes :: --- mpv 0.29.0 --- + 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". 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 diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst index e18fec4c1d..5830b413e0 100644 --- a/DOCS/interface-changes.rst +++ b/DOCS/interface-changes.rst @@ -72,6 +72,8 @@ Interface changes will probably stall. - deprecate the OpenGL cocoa backend, option choice --gpu-context=cocoa when used with --gpu-api=opengl (use --vo=opengl-cb) + - rename --vo=opengl-cb to --vo=libmpv (goes in hand with the opengl-cb + API deprecation, see client-api-changes.rst) - 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. diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index 8246dd0f49..2716302e72 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -5221,6 +5221,9 @@ The following video options are currently all specific to ``--vo=gpu`` and NOTE: On Windows, the default profile must be an ICC profile. WCS profiles are not supported. + Applications using libmpv with the render API need to provide the ICC + profile via ``MPV_RENDER_PARAM_ICC_PROFILE``. + ``--icc-cache-dir=<dirname>`` Store and load the 3D LUTs created from the ICC profile in this directory. This can be used to speed up loading, since LittleCMS 2 can take a while to diff --git a/DOCS/man/vo.rst b/DOCS/man/vo.rst index 8e8b9803be..672f3c68f6 100644 --- a/DOCS/man/vo.rst +++ b/DOCS/man/vo.rst @@ -428,13 +428,14 @@ Available video output drivers are: ``--vo-image-outdir=<dirname>`` Specify the directory to save the image files to (default: ``./``). -``opengl-cb`` - For use with libmpv direct OpenGL embedding. As a special case, on OS X it +``libmpv`` + For use with libmpv direct embedding. As a special case, on OS X it is used like a normal VO within mpv (cocoa-cb). Otherwise useless in any other contexts. - (See ``<mpv/opengl_cb.h>``.) + (See ``<mpv/render.h>``.) - This also supports many of the options the ``gpu`` VO has. + This also supports many of the options the ``gpu`` VO has, depending on the + backend. ``rpi`` (Raspberry Pi) Native video output on the Raspberry Pi using the MMAL API. |