mpv/RELEASE_NOTES

Release 0.9.0 (Draft)
=====================

Changes
-------

Changes that may break users' config files have been annotated with a `(!)`.

- Note: mpv is not compatible with Lua 5.3. Lua 5.1 or 5.2 is required.
- The minimum required libass version is now 0.12.1 or newer.
- The minimum required FFmpeg version is now 2.4.0 (equiv. Libav 11) or newer.
- The internal libmpg123 support was removed. This was already not used by default in
  the previous release.
- `(!)` The LIRC support was removed. Configure LIRC remotes as input devices instead.
- `(!)` The Linux Joystick support was removed.
- `(!)` `--ass-use-margins` has been renamed to `--sub-use-margins` and applies
  only to plain-text (non-ASS) subtitles (enabled by default). The new
  `--ass-force-margins` option applies only to ASS subtitles (disabled by
  default). To get the old behaviour back, enable both at the same time.
- `(!)` The `--sub-scale-with-window` option now only applies to plain text
  (non-ASS) subtitles (enabled by default). The new `--ass-scale-with-window`
  option does the same but only with ASS subtitles (disabled by default).
- `(!)` The range for the `param1` for the `gaussian` `vo_opengl` scaler has
  been redefined. Instead of being an arbitrary 1-100 range, have a default
  value of 1.0, and anything higher is blurrier.
- `(!)` The `seek`, `playlist_next, `playlist_prev`, `loadfile` and `loadlist`
  parameters no longer accept numerical parameters where symbolic parameter
  names exist.
- `(!)` `vo_opengl` changes:
  - `(!)` The `smoothmotion` suboption has been renamed to `interpolation`.
    The old name is still supported for now.
  - `(!)` The `bilinear_slow` scaler has been renamed to `triangle`.
  - `(!)` `scale-down` has been renamed to `dscale` and now has its own set of
    config options (e.g. `dscale-radius`).
  - `(!)` Scaler radius no longer defaults to `3` but to a preferred value
    that may be different for each filter.
  - The `scale-radius` option may now go down as low as `0.5`, which is the
    value used by the `nearest` filter.
  - `spline36` is the new `cscale` default for `opengl-hq`. This might break
    setups that use `fbo-format=rgb8`. To work around it, leave `fbo-format`
    as its default, or set to something higher than 8, or set `cscale=bilinear`,
    the previous default.
- `(!)` `vf_format` no longer converts video to YUYV if there is no parameter.
  Video is now passed unchanged unless a format is specifically requested.
- `(!)` The `--colormatrix`, `--colormatrix-input-range`,
  `--colormatrix-output-range` and `--colormatrix-primaries` options have been
  converted into `vf_format` suboptions. See commit 27715b7 and the manual for
  details.
- The `device` subption to `ao_wasapi` has been deprecated in favor of
  `--audio-device`.
- `--video-rotate` now allows 360 as an argument instead of stopping at 359.
- Several improvements to `af_scaletempo`.
- Options that have multiple options and also include a "yes" option now
  default to that if specified with no arguments.
- The default value of `--cache-default` is now 150000 (153.6 MB, ~146 MiB).
- JPEG screenshots now use the same subsampling as the source video. The images
  are still RGB regardless of source format though.

Bug fixes
---------

- mpv no longer saves position on files that can't be resumed (issue #1701).
- (X11) Fix the player thinking the mouse has left the window in some WMs /
  embeddings (issue #1672).
- mpv no longer freezes on wayland when the compositor stops asking it to draw
  itself (e.g. when minimized) (issue #249).
- `.ac3` files are no longer rejected by `--audio-file-auto` (issue #1759).
- `ao_wasapi` now automatically enables `exclusive` when passthrough is
  attempted (issue #1742).
- Attempt to fix flickering on Intel VAAPI drivers with `--hwdec=vaapi` and
  `--vo=opengl` (issue #1765).
- `youtube-dl` will no longer download video streams when video playback
  is disabled with `--no-video`.

New features
------------

- `vo_opengl` features:
  - Added `ewa_ginseng`, `ewa_hanning`, `robidoux`, `robidouxsharp`,
    `oversample` and `haasnsoft` scalers.
  - There are now `ewa_lanczonsoft` and `ewa_lanczossharp` aliases to
    `ewa_lanczos` that are tuned to be blurrier and sharper, respectively.
  - Added `gamma-auto` option that uses ambient light sensors to automatically
    adjust the video gamma. See commit c028d78 for details.
  - Added `blend-subtitles` option to draw subtitles directly into the video
    instead of rendered afterwards. Potentially necessary for correct rendering
    with files that use ASS subtitles for typesetting in combination with an
    `icc-profile`. There is a default option for drawing after upscaling,
    and a `video` option for drawing before upscaling. See details and warning
    on the manual.
  - There is now a `tscale` option, used to choose the temporal scaler used
    in the `interpolation` mode (previously `smoothmotion`).
  - There is a new `scale-blur` parameter to adjust the amount of blur that
    most of the filters produce. Deviating from the default may introduce
    artifacts in EWA filters.
  - (Windows) There is now a `dwmflush` option that might help improve
    rendering of high-fps video. Disabled by default. See manual for options.
- New `pseudo-gui` builtin profile, automatically used when launched from
  `mpv.desktop` or by opening `mpv.exe` on windows (`mpv.com` still works as
  usual). The `pseudo-gui` tries to make the player window behave closer to
  what a desktop player would do, by not immediately closing and allowing the
  user to drag&drop files for playback. See manual for details.
- Add support to pitch correct stretched audio with librubberband.
- Add support for the Raspberry Pi 2's hardware decoder when FFmpeg (or Libav)
  is built with `--enable-mmal`. See commit 8fff125 for details.
- The `--cache` option now accepts a "yes" option, that always enables a
  `--cache-default`-sized cache on all cases a cache can be used, unless
  `--cache-default` disables caching.
- `ao_pulse`, `ao_coreaudio` and `ao_wasapi` now support device hotplugging.
- New `--osd-align-x` and `--osd-align-y` options can be used to align the OSD
  independently from subtitles.
- New `--osd-bold` and `--sub-text-bold` options can be enabled to bold all
  OSD or plain-text subtitle text, respectively.
- Added a default keybind to the `u` key that enables/disables ASS style
  overriding. When enabled, is equivalent to `--ass-style-override=force`.
- There is now a `MOUSE_ENTER` keybind, that is called when the mouse cursor
  enters the VO from outside.
- The new `--ytdl-params` option can be set to arguments that are always given
  to `youtube-dl` invocations. There is no sanity checking, so invalid options
  can prevent `mpv` from working with http URLs.
- `vo_direct3d_shaders` now supports NV12 colorspace without using stretchrect,
  but it seems no drivers actually support that.
- (Client API) Added a `rescan_external_files` command, as requested on issue
  #1586.
- (Client API) If enabled, initializing the Client API will now also load the
  user's `mpv.conf`.
- (Client API) There's a new `mpv_opengl_cb_report_flip()` call for API users
  to call to inform mpv of when exactly a frame was displayed.
- (Client API) The `mpv_opengl_cb_render()` function was deprecated in favor
  of the new, simpler `mpv_opengl_cb_draw()` function.
- The `--input-file` argument may now also be a file descriptor in the form
  "fd://N", where N is the FD number.

This listing is not complete. A complete changelog can be seen by running
`git log v0.8.0..v0.9.0` in the git repository.

Release 0.8.3
=============

Changes
-------

- Documentation fixes and updates.
- (Client API) Clarify `mpv_opengl_cb_render`'s viewport parameter behavior.

Bug fixes
---------

- (X11) Fix crash on `vo_xv:no-colorkey` with the Overlay adapter. (bug #1629)
- Make the video equalizer work correctly on some VAAPI drivers. (bug #1647)
- Prevent OSD from disappearing when clicking on mozplugger. (bug #1672)
- The new DVB-S2 support code, using S2API, now builds on FreeBSD.
- Fix decoding of seekable matroska from unseekable network stream. (bug #1656)
- (OSX) Fix crashing when closing a VO's window (usually at exit). (bug #1657)
- (OSX) Unhide the mouse cursor when over the Dock or Launchpad. (bug #513)
- (OSX) Fix mouse cursor autohiding when the player is fullscreen.
- `vf_vavpp` (VAAPI postprocessing) now deinterlaces video correctly.
- `smb://` streams now use the stream cache (used to be inefficient).
- (Windows) Do not hide the mouse cursor when it is hovering the window menu.
- Fix 8-channel output on `ao_jack`. (bug #1688)
- Fix `--mf-fps` parameter on JPEG files. (bug #1689)
- Fix anamorphic scaling being ignored if it was very minor.

This listing is not complete. A complete changelog can be seen by running
`git log v0.8.2..v0.8.3` in the git repository.

Release 0.8.2
=============

Bug fixes
---------

- Fix OSD placement accidentally messed up in 0.8.1.

Release 0.8.1
=============

Changes
-------

- DOCS/client-api-changes has been correctly updated for the v0.8.0 release
  series.
- Quality and major perfomance improvements to smoothmotion.
- Silence the "[ytdl_hook] WARNING: video doesn't have subtitles" warning.
- Other documentation updates.

Bug fixes
---------

- Attempt to fix OpenGL shader compilation on Intel windows drivers. (bug
  #1536)
- Attempt to improve the OpenGL shader's compatibility with GLES2.
- (Windows) Fix noise when seeking while using wasapi:exclusive. (bug #1529)
- Fix the waf-based build system when used with newer versions of waf with
  python3.
- Documentation fixes. (includes bug #1608)

New features
------------

- mpv now tries to load '.vtt' subtitles.

This listing is not complete. A complete changelog can be seen by running
`git log v0.8.0..v0.8.1` in the git repository.

Release 0.8.0
=============

Changes
-------

Changes that may break users' config files have been annotated with a `(!)`.

- `(!)` vo_opengl_old has been removed. OpenGL rendering now requires hardware
  that can do at least OpenGL 2.1, the oldest version supported by vo_opengl.
- `(!)` vf_pp has been removed. A version of it can still be accessed through
  lavfilter (e.g. --vf=lavfi=[pp...]), but it receives no QP information.
  Also, vf_dlopen no longer passes QP information to its loaded plugin either
  (it's always 0).
- `(!)` vf_softpulldown, vf_swapuv, vf_phase, vf_divtc and vf_ilpack have all
  been removed. Ports or alternative versions of these filters are available
  through libavfilter (vf_lavfi).
- vf_pullup and vf_noise now are simply wrappers to their libavfilter
  equivalents. Both are only currently available on FFmpeg (not Libav).
- `(!)` ao_portaudio has been removed. There is good support for the native
  audio drivers of all major desktop platforms, as well as ao_sdl and
  ao_openal as fallbacks.
- `(!)` vo_opengl's `lscale` suboption has been renamed to `scale`; `lradius`
  is now `scale-radius`, `lparam1` and `lparam2` are now respectively
  `scale-param1` and `scale-param2`; `lscale-down` is now `scale-down`.
  The `cscale` suboption remains as is.
- `(!)` Several of the `vo_opengl` radius-preset aliases supported by `scale`
  have been removed; use `scale-radius` to set if needed. For example, use
  `--vo=opengl:scale=lanczos:scale-radius=2` instead of `scale=lanczos2`.
  The default radius is recommended for most filters.
- `(!)` vo_opengl no longer supports the `stereo` suboption. The anaglyph
  effect can be reproduced with the stereo3d filter. The quadbuffer support,
  which requires expensive specialized hardware to begin with, is removed.
- `(!)` The `approx-gamma` suboption to vo_opengl has been removed. The
  BT.1886 specification says that it's actually how it's supposed to be done
  so it is now the default when `srgb` or `icc-profile` are enabled. This does
  not include BT.1886's gamma drop.
- `(!)` The `no-scale-sep` and `indirect` suboptions to vo_opengl have been
  removed. These are now autodetected and enabled whenever they would have
  benefit.
- `(!)` The `--lua` and `--lua-opts` parameters / options are now called
  `--script` and `--script-opts`, respectively. The `lua` subdir of the mpv
  config dir is also now expected to be called `scripts` instead.
- `(!)` The `--fixed-vo` option has been removed. It has been the default for
  a long time anyway, and disabling fixed-vo is not useful.
- vo_opengl_hq has been updated to take into account new features.
  `fancy-downscaling` and `sigmoid-upscaling` are enabled,
  "mitchell" is now the default for `scale-down`.
- The `sub-visibility` OSD message is now clearer about whether subtitles
  are hidden or just not available / selected.
- The device IDs given to `--audio-device` for use with ao_coreaudio now use
  UIDs, so they don't change when devices are added/removed or after reboots.
- `--msg-level` now also accepts ',' as separator.
- (Client API) The client API now refuses to initialize if the LC_NUMERIC
  locale is not "C".
- (Client API) The native type of the `msg-level` parameter is now a key-value
  list. Setting or reading it as a string still works.
- (Slave API) The `get_property` command is now deprecated.
- Documentation updates.
- PDF documentation is now disabled by default due to rst2pdf being fickle,
  causing weird build errors.
- Print desync messages with negative A/V sync as well. While rare, it could
  happen with some uses of `--autosync`.

Bug fixes
---------

- (Windows) Avoid resizing the video window when player is minimized, might
  address bug #1547.
- (NetBSD) Fix build with v4l2.
- (Linux) Attempt to address conflicts with the pulseaudio mixer. (bug #1578)
- Multiple cdda:// fixes. (bugs #1555, #1560)
- VP9 timestamps no longer cause "missing PTS" warnings with new enough FFmpeg
  builds.
- Fix a crash when using H.264 hardware decoding on new enough libavcodecs.
  (bug #1587)

New features
------------

- vo_opengl now supports frame blending to eliminate stuttering when the video
  framerate does not nicely match the display framerate through the
  `smoothmotion` suboption. This is not meant to artificially increase the
  video's FPS, so there is no "soap opera effect" or difficulties with some
  video types (e.g. anime).
- vo_opengl now supports sigmoidal upscaling (e.g. for fullscreen), which
  reduces ringing induced by upscaling, enabled through the
  `sigmoid-upscaling` suboption.
- vo_opengl now supports ewa_lanczos (Jinc) scaling, which provides higher
  quality with less aliasing. It supports an experimental `scale-antiringing`
  parameter, which tries to further reduce video ringing.
- vo_opengl now has a `linear-scaling` suboption, that makes the scalers work
  in linear light. Implied by the `srgb`, `icc-profile` or the new
  `sigmoid-upscaling` suboption.
- vo_opengl has improved downscaling for higher downscale ratios when
  `fancy-downscaling` is enabled.
- Add `--keep-open=always` to make `--keep-open` apply to all files instead of
  only the last.
- mpv now filters the tags that are printed on the console to try to hide
  useless metadata. The filter works as a whitelist, and can be configured
  with the `--display-tags` option.
- Add a `--sub-scale-by-window` option that, when set to 'no', prevents
  subtitles from changing their pixel size when the window changes sizes.
- vo_opengl now technically has GLES 2 and 3 support (but not GLES 1). GLES 3
  support is only tested on Mesa's software emulation. GLES 2 has been tested
  on nvidia drivers. Both GLES modes are feature deficient and inefficient due
  to GLES limitations, so they should not be preferred over the standard
  OpenGL mode.
- (X11) vo_opengl now supports the `icc-profile-auto` option on X11 hosts.
- The 'A' key now by default cycles through a list of preset aspect ratios.
  Meant to be used to work around broken files.
- There is now a "force" mode for `--loop`. Works like "inf", but tries to
  open files/streams even if there was an error on the previous attempt.
- There is now a `--log-file` option to write mpv's log messages to a specifed
  file.
- There is now a `--audio-file-auto` option to automatically load an external
  audio file with certain constraints. Will only load external audio if the
  playing file has a video stream. Set to "exact" by default. (bug #967)
- There is now a `--network-timeout` option to specify a timeout in seconds
  for network access. If 0 (default), uses the libavformat default. If a
  protocol that doesn't support timeouts is used, this option is ignored.
- (X11) The XF86 special keys are now all mappable in `input.conf`. All keys
  documented in `XF86keysym.h` are available, but only as their numeric codes.
- (Linux) The DVB implementation now supports DVB-S2 through S2API.
- (Linux) The VDR format for `channels.conf` is now supported and preferred.
  See http://linuxtv.org/vdrwiki/index.php/Syntax_of_channels.conf for the
  syntax. Tuning to DVB-S2 channels requires the VDR-format `channels.conf`.
- (Linux) There is now a `--dvbin-full-transponder` option for handling
  special broadcast cases where PIDs switch, or just to work around incomplete
  PID data.
- (Client API) There is now an opengl_cb VO, which receives the OpenGL context
  from the libmpv client. This allows a client to render libmpv video directly
  to a provided OpenGL context without having to use --wid embedding.
- (Client API) The aforementioned --wid parameter can now be set at any time,
  but has no effect if a file is already loaded.
- (Client API) The list of DVD titles can now be queried.
- (Client API) There is now a `filtered-metadata` property, containing only
  the tags allowed by `--display-tags`.
- (Client API) There is now support for XEmbed `--wid` targets, such as a
  `GtkSocket`'s `gtk_socket_get_id()`.
- (Client API) There is now a `file-format` property with a symbolic name
  for the file format. In some cases this might be a comma separated list
  of various different extensions due to libavformat idiosyncrasies.
- (Client API) There is now a `mouse` command for generating mouse events
  over the video window.
- (Client API) There is now a `partially-seekable` property that indicates
  whether a file is only considered `seekable` because of the stream cache,
  but would not be seekable otherwise (e.g. realtime stream, or HTTP with
  no resume support). Small relative seeks may be fine, but larger seeks
  will likely fail.
- (Client API) There is now an MPV_EVENT_QUEUE_OVERFLOW event that is posted
  whenever events have to be dropped because the queue is full. No further
  events are posted until the MPV_EVENT_QUEUE_OVERFLOW is consumed to avoid
  duplicated posting.
- (Client API) There is now a helper `mpv_wait_async_requests()` function
  that blocks until all known async requests have completed. (bug #1542)
- (Client API) There is now a `detected-hwdec` property that returns the
  detected hardware decoder when one is successfully opened. This probably
  only returns a valid value after playback has started.
- (Client API) There are now `audio_add`, `audio_remove` and `audio_reload`
  counterparts to the equivalent `sub_` commands for handling external audio
  files.

This listing is not complete. A complete changelog can be seen by running
`git log v0.7.0..v0.8.0` in the git repository.