diff options
| -rw-r--r-- | DOCS/man/ao.rst | 8 | ||||
| -rw-r--r-- | DOCS/man/encode.rst | 8 | ||||
| -rw-r--r-- | DOCS/man/input.rst | 15 | ||||
| -rw-r--r-- | DOCS/man/ipc.rst | 8 | ||||
| -rw-r--r-- | DOCS/man/lua.rst | 2 | ||||
| -rw-r--r-- | DOCS/man/mpv.rst | 14 | ||||
| -rw-r--r-- | DOCS/man/options.rst | 51 | ||||
| -rw-r--r-- | DOCS/man/vf.rst | 18 | ||||
| -rw-r--r-- | DOCS/man/vo.rst | 12 |
9 files changed, 71 insertions, 65 deletions
diff --git a/DOCS/man/ao.rst b/DOCS/man/ao.rst index a35b9c1c4e..fafdfd81ae 100644 --- a/DOCS/man/ao.rst +++ b/DOCS/man/ao.rst @@ -165,7 +165,7 @@ Available audio output drivers are: will actually work. The disadvantage is that it will change the system-wide audio settings. This is equivalent to changing the ``Format`` setting in the ``Audio Devices`` dialog in the ``Audio MIDI Setup`` - utility. Note that this does not effect the selected speaker setup. + utility. Note that this does not affect the selected speaker setup. ``exclusive`` Use exclusive mode access. This merely redirects to @@ -205,7 +205,7 @@ Available audio output drivers are: (it used to be required to get good behavior on old PulseAudio versions). If you have stuttering video when using pulse, try to enable this - option. (Or alternatively, try to update PulseAudio.) + option. (Or try to update PulseAudio.) ``dsound`` (Windows only) DirectX DirectSound audio output driver @@ -256,7 +256,7 @@ Available audio output drivers are: ``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 simulating this. + just a little, and this option helps to simulate this. ``latency`` Simulated device latency. This is additional to EOF. @@ -325,7 +325,7 @@ Available audio output drivers are: 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 + 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 diff --git a/DOCS/man/encode.rst b/DOCS/man/encode.rst index b3a212368a..794b8a1df2 100644 --- a/DOCS/man/encode.rst +++ b/DOCS/man/encode.rst @@ -93,8 +93,8 @@ You can encode files from one format/codec to another using this facility. Completely empties the options list. ``--oafirst`` - Force the audio stream to become the first stream in the output. By default - the order is unspecified. + Force the audio stream to become the first stream in the output. + By default, the order is unspecified. ``--ovc=<codec>`` Specifies the output video codec. This can be a comma separated list of @@ -134,8 +134,8 @@ You can encode files from one format/codec to another using this facility. Completely empties the options list. ``--ovfirst`` - Force the video stream to become the first stream in the output. By default - the order is unspecified. + Force the video stream to become the first stream in the output. + By default, the order is unspecified. ``--ocopyts`` Copies input pts to the output video (not supported by some output diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst index c3e69b3731..00c3a007dd 100644 --- a/DOCS/man/input.rst +++ b/DOCS/man/input.rst @@ -418,7 +418,7 @@ List of Input Commands <reselect> (default) Select the default audio and subtitle streams, which typically selects - external files with highest preference. (The implementation is not + external files with the highest preference. (The implementation is not perfect, and could be improved on request.) <keep-selection> @@ -782,7 +782,7 @@ Input sections group a set of bindings, and enable or disable them at once. In ``input.conf``, each key binding is assigned to an input section, rather than actually having explicit text sections. -Also see ``enable_section`` and ``disable_section`` commands. +See also: ``enable_section`` and ``disable_section`` commands. Predefined bindings: @@ -961,9 +961,8 @@ Property list ``playback-time`` (RW) Position in current file in seconds. Unlike ``time-pos``, the time is clamped to the range of the file. (Inaccurate file durations etc. could - make it go out of range. Also helpful when the user attempts to seek - outside of the file, as the seek target time is considered the current - position during seeking.) + make it go out of range. Useful on attempts to seek outside of the file, + as the seek target time is considered the current position during seeking.) ``chapter`` (RW) Current chapter number. The number of the first chapter is 0. @@ -1109,13 +1108,13 @@ Property list ``vf-metadata/<filter-label>`` Metadata added by video filters. Accessed by the filter label, - which if not explicitly specified using the ``@filter-label:`` syntax, + which, if not explicitly specified using the ``@filter-label:`` syntax, will be ``<filter-name>NN``. Works similar to ``metadata`` property. It allows the same access methods (using sub-properties). - An example of these kind of metadata are the cropping parameters + An example of this kind of metadata are the cropping parameters added by ``--vf=lavfi=cropdetect``. ``af-metadata/<filter-label>`` @@ -1142,7 +1141,7 @@ Property list ``cache-size`` (RW) Network cache size in KB. This is similar to ``--cache``. This allows - to set the cache size at runtime. Currently, it's not possible to enable + setting the cache size at runtime. Currently, it's not possible to enable or disable the cache at runtime using this property, just to resize an existing cache. diff --git a/DOCS/man/ipc.rst b/DOCS/man/ipc.rst index 31333a2c6a..e3ff1bd243 100644 --- a/DOCS/man/ipc.rst +++ b/DOCS/man/ipc.rst @@ -111,7 +111,7 @@ rely on this. Commands -------- -Additionally to the commands described in `List of Input Commands`_, a few +In addition to the commands described in `List of Input Commands`_, a few extra commands can also be used as part of the protocol: ``client_name`` @@ -189,7 +189,7 @@ extra commands can also be used as part of the protocol: ``unobserve_property`` Undo ``observe_property`` or ``observe_property_string``. This requires the - numeric id passed to the observe command as argument. + numeric id passed to the observed command as argument. Example: @@ -228,7 +228,9 @@ extra commands can also be used as part of the protocol: ``get_version`` Returns the client API version the C API of the remote mpv instance - provides. (Also see ``DOCS/client-api-changes.rst``.) + provides. + + See also: ``DOCS/client-api-changes.rst``. UTF-8 ----- diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst index d51a6d95c5..c89cfc622e 100644 --- a/DOCS/man/lua.rst +++ b/DOCS/man/lua.rst @@ -389,7 +389,7 @@ The ``mp`` module is preloaded, although it can be loaded manually with ``mp.get_script_name()`` 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 script which would have the same name, it's made unique + there are several scripts which would have the same name, it's made unique by appending a number. .. admonition:: Example diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst index 9527b8a3c9..3d76a266f0 100644 --- a/DOCS/man/mpv.rst +++ b/DOCS/man/mpv.rst @@ -50,7 +50,7 @@ UP and DOWN Ctrl+LEFT and Ctrl+RIGHT Seek to the previous/next subtitle. Subject to some restrictions and - might not work always; see ``sub_seek`` command. + might not always work; see ``sub_seek`` command. [ and ] Decrease/increase current playback speed by 10%. @@ -571,7 +571,7 @@ listed. certainty. - Dropped frames, e.g. ``Dropped: 4``. Shows up only if the count is not 0. Can grow if the video framerate is higher than that of the display, or if video - rendering is too slow. Also can be incremented on "hiccups" and when the video + rendering is too slow. May also be incremented on "hiccups" and when the video frame couldn't be displayed on time. (``vo-drop-frame-count`` property.) If the decoder drops frames, the number of decoder-dropped frames is appended to the display as well, e.g.: ``Dropped: 4/34``. This happens only if @@ -602,7 +602,7 @@ PROTOCOLS Play a path from Samba share. ``bd://[title][/device]`` ``--bluray-device=PATH`` - Play a Blu-Ray disc. Currently, this does not accept ISO files. Instead, + Play a Blu-ray disc. Currently, this does not accept ISO files. Instead, you must mount the ISO file as filesystem, and point ``--bluray-device`` to the mounted directory directly. @@ -728,7 +728,7 @@ EMBEDDING INTO OTHER PROGRAMS (LIBMPV) ====================================== mpv can be embedded into other programs as video/audio playback backend. The -recommended way to to so is using libmpv. See ``libmpv/client.h`` in the mpv +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). @@ -803,7 +803,7 @@ libdvdcss: key is the default method. libdvdcss will use a set of calculated - player keys to try and get the disc key. This can fail if the drive + player keys to try to get the disc key. This can fail if the drive does not recognize any of the player keys. disc @@ -942,8 +942,8 @@ lower priority. Some config files are loaded only once, which means that e.g. of 2 ``input.conf`` files located in two config directories, only the one from the directory with higher priority will be loaded. -A third config directory with lowest priority is the directory named ``mpv`` -in the same directory as ``mpv.exe``. This used to be the directory with +A third config directory with the lowest priority is the directory named ``mpv`` +in the same directory as ``mpv.exe``. This used to be the directory with the highest priority, but is now discouraged to use and might be removed in the future. diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index 14a0a7bec9..8324f6a18b 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -136,7 +136,9 @@ Playback Control ``--chapter=<start[-end]>`` Specify which chapter to start playing at. Optionally specify which - chapter to end playing at. Also see ``--start``. + chapter to end playing at. + + See also: ``--start``. ``--playlist-pos=<no|index>`` Set which file on the internal playlist to start playback with. The index @@ -321,7 +323,7 @@ Program Behavior Files explicitly requested by command line options, like ``--include`` or ``--use-filedir-conf``, will still be loaded. - Also see ``--config-dir``. + See also: ``--config-dir``. ``--list-options`` Prints all available options. @@ -558,7 +560,7 @@ Video ``--display-fps=<fps>`` Set the display FPS used with the ``--video-sync=display-*`` modes. By - default a detected value is used (X11 only, not correct on multi-monitor + default, a detected value is used (X11 only, not correct on multi-monitor systems). Keep in mind that setting an incorrect value (even if slightly incorrect) can ruin video playback. @@ -613,7 +615,7 @@ Video For ``opengl-cb``, if set, load the interop context as soon as the OpenGL context is created. Since ``opengl-cb`` has no on-demand loading, this - allows enabling hardware decoding at runtime at all, without having to + allows enabling hardware decoding at runtime at all, without having to temporarily set the ``hwdec`` option just during OpenGL context initialization with ``mpv_opengl_cb_init_gl()``. @@ -675,7 +677,7 @@ Video example ``--video-zoom`` does nothing if this option is enabled.) The video and monitor aspects aspect will be ignored. Aspect correction - would require to scale the video in the X or Y direction, but this option + would require scaling the video in the X or Y direction, but this option disables scaling, disabling all aspect correction. Note that the scaler algorithm may still be used, even if the video isn't @@ -820,7 +822,7 @@ Video You can get the list of allowed codecs with ``mpv --vd=help``. Remove the prefix, e.g. instead of ``lavc:h264`` use ``h264``. - By default this is set to ``h264,vc1,wmv3,hevc,mpeg2video``. Note that the + By default, this is set to ``h264,vc1,wmv3,hevc,mpeg2video``. Note that the hardware acceleration special codecs like ``h264_vdpau`` are not relevant anymore, and in fact have been removed from Libav in this form. @@ -1027,7 +1029,9 @@ Audio ``--mute=<auto|yes|no>`` Set startup audio mute status. ``auto`` (default) will not change the mute - status. Also see ``--volume``. + status. + + See also: ``--volume``. ``--softvol=<mode>`` Control whether to use the volume controls of the audio output driver or @@ -1152,8 +1156,8 @@ Audio point of file change. Default: ``weak``. :no: Disable gapless audio. - :yes: The audio device is opened using parameters chosen according to the - first file played and is then kept open for gapless playback. This + :yes: The audio device is opened using parameters chosen for the first + file played and is then kept open for gapless playback. This means that if the first file for example has a low sample rate, then the following files may get resampled to the same low sample rate, resulting in reduced sound quality. If you play files with different @@ -1600,10 +1604,10 @@ Subtitles ``<rate>`` > video fps speeds the subtitles up for frame-based subtitle files and slows them down for time-based ones. - Also see ``--sub-speed`` option. + See also: ``--sub-speed``. ``--sub-gauss=<0.0-3.0>`` - Apply Gaussian blur to image subtitles (default: 0). This can help making + Apply Gaussian blur to image subtitles (default: 0). This can help to make pixelated DVD/Vobsubs look nicer. A value other than 0 also switches to software subtitle scaling. Might be slow. @@ -1612,7 +1616,7 @@ Subtitles Never applied to text subtitles. ``--sub-gray`` - Convert image subtitles to grayscale. Can help making yellow DVD/Vobsubs + Convert image subtitles to grayscale. Can help to make yellow DVD/Vobsubs look nicer. .. note:: @@ -1984,8 +1988,8 @@ Window always re-enabled when the player is paused. This is not supported on all video outputs or platforms. Sometimes it is - implemented, but does not work (happens often on GNOME). You might be able - to to work this around using ``--heartbeat-cmd`` instead. + implemented, but does not work (known to happen with GNOME). You might be + able to work around this using ``--heartbeat-cmd`` instead. ``--wid=<ID>`` This tells mpv to attach to an existing window. If a VO is selected that @@ -2004,7 +2008,7 @@ Window parent, like with X11. On OSX/Cocoa, the ID is interpreted as ``NSView*``. Pass it as value cast - to ``intptr_t``. mpv will creates its own sub-view. Because OSX does not + to ``intptr_t``. mpv will create its own sub-view. Because OSX does not support window embedding of foreign processes, this works only with libmpv, and will crash when used from the command line. @@ -2381,7 +2385,7 @@ Input ``--input-key-fifo-size=<2-65000>`` Specify the size of the FIFO that buffers key events (default: 7). If it - is too small some events may be lost. The main disadvantage of setting it + is too small, some events may be lost. The main disadvantage of setting it to a very large value is that if you hold down a key triggering some particularly slow command then the player may be unresponsive while it processes all the queued commands. @@ -2448,7 +2452,7 @@ Input On X11, a sub-window with input enabled grabs all keyboard input as long as it is 1. a child of a focused window, and 2. the mouse is inside of - the sub-window. The can steal away all keyboard input from the + the sub-window. It can steal away all keyboard input from the application embedding the mpv window, and on the other hand, the mpv window will receive no input if the mouse is outside of the mpv window, even though mpv has focus. Modern toolkits work around this weird X11 @@ -2718,7 +2722,7 @@ Screenshot Specify the filename template used to save screenshots. The template specifies the filename without file extension, and can contain format specifiers, which will be substituted when taking a screenshot. - By default the template is ``mpv-shot%n``, which results in filenames like + By default, the template is ``mpv-shot%n``, which results in filenames like ``mpv-shot0012.png`` for example. The template can start with a relative or absolute path, in order to @@ -2874,7 +2878,7 @@ Terminal Particularly useful on slow terminals or broken ones which do not properly handle carriage return (i.e. ``\r``). - Also see ``--really-quiet`` and ``--msg-level``. + See also: ``--really-quiet`` and ``--msg-level``. ``--really-quiet`` Display even less output and status messages than with ``--quiet``. @@ -3007,8 +3011,9 @@ TV maximum size of the capture buffer in megabytes (default: dynamical) ``--tv-norm=<value>`` - See the console output for a list of all available norms, also see the - ``normid`` option below. + See the console output for a list of all available norms. + + See also: ``--tv-normid``. ``--tv-normid=<value> (v4l2 only)`` Sets the TV norm to the given numeric ID. The TV norm depends on the @@ -3218,7 +3223,7 @@ Cache multiple cache streams, and using the same file for them obviously clashes. - Also see ``--cache-file-size``. + See also: ``--cache-file-size``. ``--cache-file-size=<kBytes>`` Maximum size of the file created with ``--cache-file``. For read accesses @@ -3380,7 +3385,7 @@ Miscellaneous implement a perfect audio delay measurement. With this value, if large A/V sync offsets occur, they will only take about 1 or 2 seconds to settle out. This delay in reaction time to sudden A/V offsets should be the only - side-effect of turning this option on, for all sound drivers. + side effect of turning this option on, for all sound drivers. ``--video-sync=<audio|...>`` How the player synchronizes audio and video. diff --git a/DOCS/man/vf.rst b/DOCS/man/vf.rst index 72e1559d76..ff42608d81 100644 --- a/DOCS/man/vf.rst +++ b/DOCS/man/vf.rst @@ -438,9 +438,8 @@ Available filters are: generating an occasional mismatched frame, but it may also cause an excessive number of frames to be dropped during high motion sequences. Conversely, setting it to -1 will make ``pullup`` match fields more - easily. This may help processing of video where there is slight - blurring between the fields, but may also cause there to be interlaced - frames in the output. + easily. This may help process video with slight blurring between the + fields, but may also cause interlaced frames in the output. ``mp`` (metric plane) This option may be set to ``u`` or ``v`` to use a chroma plane instead of the @@ -473,7 +472,7 @@ Available filters are: into ``--vf-defaults`` instead, and enable deinterlacing with ``d`` or ``--deinterlace``. - Also note that the ``d`` key is stupid enough to insert a deinterlacer twice + Also, note that the ``d`` key is stupid enough to insert a deinterlacer twice when inserting yadif with ``--vf``, so using the above methods is recommended. @@ -645,10 +644,11 @@ Available filters are: ``buffered-frames`` Maximum number of decoded video frames that should be buffered before the filter (default: 4). This specifies the maximum number of frames - the script can requests backwards. E.g. if ``buffered-frames=5``, and - the script just requested frame 15, it can still request frame 10, but - frame 9 is not available anymore. If it requests frame 30, mpv will - decode 15 more frames, and keep only frames 25-30. + the script can request in reverse direction. + E.g. if ``buffered-frames=5``, and the script just requested frame 15, + it can still request frame 10, but frame 9 is not available anymore. + If it requests frame 30, mpv will decode 15 more frames, and keep only + frames 25-30. The actual number of buffered frames also depends on the value of the ``concurrent-frames`` option. Currently, both option values are @@ -803,6 +803,6 @@ Available filters are: ``buffer=<num>`` Buffer ``<num>`` frames in the filter chain. This filter is probably pretty - useless, except for debugging. (Note that this won't help smoothing out + useless, except for debugging. (Note that this won't help to smooth out latencies with decoding, because the filter will never output a frame if the buffer isn't full, except on EOF.) diff --git a/DOCS/man/vo.rst b/DOCS/man/vo.rst index 697584ca98..6335b34583 100644 --- a/DOCS/man/vo.rst +++ b/DOCS/man/vo.rst @@ -481,7 +481,7 @@ Available video output drivers are: ``temporal-dither`` Enable temporal dithering. (Only active if dithering is enabled in - general.) This changes between 8 different dithering pattern on each + general.) This changes between 8 different dithering patterns on each frame by changing the orientation of the tiled dithering matrix. Unfortunately, this can lead to flicker on LCD displays, since these have a high reaction time. @@ -492,7 +492,7 @@ Available video output drivers are: video frame, 2 on every other frame, etc. ``debug`` - Check for OpenGL errors, i.e. call ``glGetError()``. Also request a + Check for OpenGL errors, i.e. call ``glGetError()``. Also, request a debug OpenGL context (which does nothing with current graphics drivers as of this writing). @@ -741,7 +741,7 @@ Available video output drivers are: ``glfinish`` Call ``glFinish()`` before and after swapping buffers (default: disabled). - Slower, but might help getting better results when doing framedropping. + Slower, but might improve results when doing framedropping. Can completely ruin performance. The details depend entirely on the OpenGL driver. @@ -770,9 +770,9 @@ Available video output drivers are: The value ``auto`` will try to determine whether the compositor is active, and calls ``DwmFlush`` only if it seems to be. - This may help getting more consistent frame intervals, especially with - high-fps clips - which might also reduce dropped frames. Typically a - value of ``windowed`` should be enough since full screen may bypass the + This may help to get more consistent frame intervals, especially with + high-fps clips - which might also reduce dropped frames. Typically, a + value of ``windowed`` should be enough, since full screen may bypass the DWM. Windows only. |