summaryrefslogtreecommitdiffstats
path: root/DOCS/interface-changes.rst
blob: 857697bc4c92fd4eb16929faf2145c76e130614d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
Introduction
============

mpv provides access to its internals via the following means:

- options
- 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.

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

::

 --- mpv 0.33.0 ---
    - 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
 --- 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)
    - 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)
    - add --audio-normalize-downmix
    - change the default downmix behavior (--audio-normalize-downmix=yes to get
      the old default)
    - VO opengl custom shaders must now use "sample_pixel" as function name,
      instead of "sample"
    - change VO opengl scaler-resizes-only default to enabled
    - add VO opengl "interpolation-threshold" suboption (introduces new default
      behavior, which can change e.g. ``--video-sync=display-vdrop`` to the
      worse, but is usually what you want)
    - make "volume" and "mute" properties changeable even if no audio output is
      active (this gives not-ideal behavior if --softvol=no is used)
    - add "volume-max" and "mixer-active" properties
    - ignore --input-cursor option for events injected by input commands like
      "mouse", "keydown", etc.
 --- mpv 0.15.0 ---
    - change "yadif" video filter defaults
 --- mpv 0.14.0 ---
    - vo_opengl interpolation now requires --video-sync=display-... to be set
    - change some vo_opengl defaults (including changing tscale)
    - add "vsync-ratio", "estimated-display-fps" properties
    - add --rebase-start-time option
      This is a breaking change to start time handling. Instead of making start
      time handling an aspect of different options and properties (like
      "time-pos" vs. "playback-time"), make it dependent on the new option. For
      compatibility, the "time-start" property now always returns 0, so code
      which attempted to handle rebasing manually will not break.
 --- mpv 0.13.0 ---
    - remove VO opengl-cb frame queue suboptions (no replacement)
 --- mpv 0.12.0 ---
    - remove --use-text-osd (useless; fontconfig isn't a requirement anymore,
      and text rendering is also lazily initialized)
    - some time properties (at least "playback-time", "time-pos",
      "time-remaining", "playtime-remaining") now are unavailable if the time
      is unknown, instead of just assuming that the internal playback position
      is 0
    - add --audio-fallback-to-null option
    - replace vf_format outputlevels suboption with "video-output-levels" global
      property/option; also remove "colormatrix-output-range" property
    - vo_opengl: remove sharpen3/sharpen5 scale filters, add sharpen sub-option
 --- mpv 0.11.0 ---
    - add "af-metadata" property
 --- mpv 0.10.0 ---
    - add --video-aspect-method option
    - add --playlist-pos option
    - add --video-sync* options
      "display-sync-active" property
      "vo-missed-frame-count" property
      "audio-speed-correction" and "video-speed-correction" properties
    - remove --demuxer-readahead-packets and --demuxer-readahead-bytes
      add --demuxer-max-packets and --demuxer-max-bytes
      (the new options are not replacement and have very different semantics)
    - change "video-aspect" property: always settable, even if no video is
      running; always return the override - if no override is set, return
      the video's aspect ratio
    - remove disc-nav (DVD, BD) related properties and commands
    - add "option-info/<name>/set-locally" property
    - add --cache-backbuffer; change --cache-default default to 75MB
      the new total cache size is the sum of backbuffer and the cache size
      specified by --cache-default or --cache
    - add ``track-list/N/audio-channels`` property
    - change --screenshot-tag-colorspace default value
    - add --stretch-image-subs-to-screen
    - add "playlist/N/title" property
    - add --video-stereo-mode=no to disable auto-conversions
    - add --force-seekable, and change default seekability in some cases
    - add vf yadif/vavpp/vdpaupp interlaced-only suboptions
      Also, the option is enabled by default (Except vf_yadif, which has
      it enabled only if it's inserted by the deinterlace property.)
    - add --hwdec-preload
    - add ao coreaudio exclusive suboption
    - add ``track-list/N/forced`` property
    - add audio-params/channel-count and ``audio-params-out/channel-count props.
    - add af volume replaygain-fallback suboption
    - add video-params/stereo-in property
    - add "keypress", "keydown", and "keyup" commands
    - deprecate --ad-spdif-dtshd and enabling passthrough via --ad
      add --audio-spdif as replacement
    - remove "get_property" command
    - remove --slave-broken
    - add vo opengl custom shader suboptions (source-shader, scale-shader,
      pre-shaders, post-shaders)
    - completely change how the hwdec properties work:
        - "hwdec" now reflects the --hwdec option
        - "hwdec-detected" does partially what the old "hwdec" property did
          (and also, "detected-hwdec" is removed)
        - "hwdec-active" is added
    - add protocol-list property
    - deprecate audio-samplerate and audio-channels properties
      (audio-params sub-properties are the replacement)
    - add audio-params and audio-out-params properties
    - deprecate "audio-format" property, replaced with "audio-codec-name"
    - deprecate --media-title, replaced with --force-media-title
    - deprecate "length" property, replaced with "duration"
    - change volume property:
        - the value 100 is now always "unchanged volume" - with softvol, the
          range is 0 to --softvol-max, without it is 0-100
        - the minimum value of --softvol-max is raised to 100
    - remove vo opengl npot suboption
    - add relative seeking by percentage to "seek" command
    - add playlist_shuffle command
    - add --force-window=immediate
    - add ao coreaudio change-physical-format suboption
    - remove vo opengl icc-cache suboption, add icc-cache-dir suboption
    - add --screenshot-directory
    - add --screenshot-high-bit-depth
    - add --screenshot-jpeg-source-chroma
    - default action for "rescan_external_files" command changes
 --- mpv 0.9.0 ---