diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 4 | ||||
| -rw-r--r-- | doc/plugins.rst | 58 | ||||
| -rw-r--r-- | doc/protocol.rst | 28 |
3 files changed, 77 insertions, 13 deletions
diff --git a/doc/conf.py b/doc/conf.py index d7ec62db9..6a4d89c1d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -30,7 +30,7 @@ master_doc = 'index' # General information about the project. project = 'Music Player Daemon' -copyright = '2003-2018 The Music Player Daemon Project' +copyright = '2003-2019 The Music Player Daemon Project' author = 'Max Kellermann' # The version info for the project you're documenting, acts as replacement for @@ -38,7 +38,7 @@ author = 'Max Kellermann' # built documents. # # The short X.Y version. -version = '0.21.9' +version = '0.22' # The full version, including alpha/beta/rc tags. release = version diff --git a/doc/plugins.rst b/doc/plugins.rst index 06742ca24..f72cdfa70 100644 --- a/doc/plugins.rst +++ b/doc/plugins.rst @@ -130,15 +130,39 @@ Input plugins alsa ~~~~ -Allows :program:`MPD` on Linux to play audio directly from a soundcard using the scheme alsa://. Audio is formatted as 44.1 kHz 16-bit stereo (CD format). Examples: +Allows :program:`MPD` on Linux to play audio directly from a soundcard using the scheme alsa://. Audio is by default formatted as 48 kHz 16-bit stereo, but this default can be overidden by a config file setting or by the URI. Examples: .. code-block:: none - mpc add alsa:// plays audio from device hw:0,0 + mpc add alsa:// plays audio from device default .. code-block:: none - mpc add alsa://hw:1,0 plays audio from device hw:1,0 cdio_paranoia + mpc add alsa://hw:1,0 plays audio from device hw:1,0 + +.. code-block:: none + + mpc add alsa://hw:1,0?format=44100:16:2 plays audio from device hw:1,0 sampling 16-bit stereo at 44.1kHz. + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Setting + - Description + * - **default_device NAME** + - The alsa device id to use to none is specified in the uri. + * - **default_format F** + - The sampling rate, size and channels to use. Wildcards are not allowed. + + Example - "44100:16:2" + + * - **auto_resample yes|no** + - If set to no, then libasound will not attempt to resample. In this case, the user is responsible for ensuring that the requested sample rate can be produced natively by the device, otherwise an error will occur. + * - **auto_channels yes|no** + - If set to no, then libasound will not attempt to convert between different channel numbers. The user must ensure that the device supports the requested channels when sampling. + * - **auto_format yes|no** + - If set to no, then libasound will not attempt to convert between different sample formats (16 bit, 24 bit, floating point, ...). Again the user must ensure that the requested format is available natively from the device. cdio_paranoia ~~~~~~~~~~~~~ @@ -1054,6 +1078,34 @@ The "Solaris" plugin runs only on SUN Solaris, and plays via /dev/audio. Filter plugins -------------- +ffmpeg +~~~~~~ + +Configures a FFmpeg filter graph. + +This plugin requires building with ``libavfilter`` (FFmpeg). + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Setting + - Description + * - **graph "..."** + - Specifies the ``libavfilter`` graph; read the `FFmpeg + documentation + <https://libav.org/documentation/libavfilter.html#Filtergraph-syntax-1>`_ + for details + + +hdcd +~~~~ + +Decode `HDCD +<https://en.wikipedia.org/wiki/High_Definition_Compatible_Digital>`_. + +This plugin requires building with ``libavfilter`` (FFmpeg). + normalize ~~~~~~~~~ diff --git a/doc/protocol.rst b/doc/protocol.rst index 57c23dc13..187c6ed32 100644 --- a/doc/protocol.rst +++ b/doc/protocol.rst @@ -808,11 +808,12 @@ The music database ================== :command:`albumart {URI} {OFFSET}` - Searches the directory the file ``URI`` - resides in and attempts to return a chunk of an album + Locate album art for the given song and return a chunk of an album art image file at offset ``OFFSET``. - Uses the filename "cover" with any of ".png, .jpg, - .tiff, .bmp". + + This is currently implemented by searching the directory the file + resides in for a file called :file:`cover.png`, :file:`cover.jpg`, + :file:`cover.tiff` or :file:`cover.bmp`. Returns the file size and actual number of bytes read at the requested offset, followed @@ -821,7 +822,7 @@ The music database Example:: - albumart + albumart foo/bar.ogg 0 size: 1024768 binary: 8192 <8192 bytes>OK @@ -848,6 +849,17 @@ The music database don't this group tag. It exists only if at least one such song is found. +:command:`getfingerprint {URI}` + + Calculate the song's audio fingerprint. Example (abbreviated fingerprint):: + + getfingerprint "foo/bar.ogg" + chromaprint: AQACcEmSREmWJJmkIT_6CCf64... + OK + + This command is only available if MPD was built with + :file:`libchromaprint` (``-Dchromaprint=enabled``). + .. _command_find: :command:`find {FILTER} [sort {TYPE}] [window {START:END}]` @@ -874,7 +886,7 @@ The music database .. _command_findadd: -:command:`findadd {FILTER}` +:command:`findadd {FILTER} [sort {TYPE}] [window {START:END}]` Search the database for songs matching ``FILTER`` (see :ref:`Filters <filter_syntax>`) and add them to the queue. Parameters have the same meaning as for @@ -989,14 +1001,14 @@ The music database .. _command_searchadd: -:command:`searchadd {FILTER}` +:command:`searchadd {FILTER} [sort {TYPE}] [window {START:END}]` Search the database for songs matching ``FILTER`` (see :ref:`Filters <filter_syntax>`) and add them to the queue. Parameters have the same meaning as for :ref:`search <command_search>`. -:command:`searchaddpl {NAME} {FILTER}` +:command:`searchaddpl {NAME} {FILTER} [sort {TYPE}] [window {START:END}]` Search the database for songs matching ``FILTER`` (see :ref:`Filters <filter_syntax>`) and add them to the playlist named ``NAME``. |