300
300
<varname>format</varname>
303
Always open the audio output with the specified audio
304
format (samplerate:bits:channels), regardless of the
305
format of the input file. This is optional for most
304
Always open the audio output with the specified audio
305
format (samplerate:bits:channels), regardless of the
306
format of the input file. This is optional for most
310
Any of the three attributes may be an asterisk to
311
specify that this attribute should not be enforced,
312
example: <parameter>48000:16:*</parameter>.
313
<parameter>*:*:*</parameter> is equal to not having
314
a <varname>format</varname> specification.
317
The following values are valid for
318
<varname>bits</varname>: <varname>8</varname>
319
(signed 8 bit integer samples),
320
<varname>16</varname>, <varname>24</varname> (signed
321
24 bit integer samples padded to 32 bit),
322
<varname>24_3</varname> (signed 24 bit integer
323
samples, no padding, 3 bytes per sample),
324
<varname>32</varname> (signed 32 bit integer
322
<varname>mixer_enabled</varname>
342
<varname>always_on</varname>
343
<parameter>yes|no</parameter>
346
If set to "yes", then MPD attempts to keep this audio
347
output always open. This may be useful for streaming
348
servers, when you don't want to disconnect all
349
listeners even when playback is accidently stopped.
354
<varname>mixer_type</varname>
355
<parameter>hardware|software|none</parameter>
358
Specifies which mixer should be used for this audio
359
output: the hardware mixer (available for ALSA, OSS
360
and PulseAudio), the software mixer or no mixer
361
("none"). By default, the hardware mixer is used for
362
devices which support it, and none for the others.
367
<varname>replay_gain_handler</varname>
368
<parameter>software|mixer|none</parameter>
371
Specifies how replay gain is applied. The default is
372
"software", which uses an internal software volume
373
control. "mixer" uses the configured (hardware) mixer
374
control. "none" disables replay gain on this audio
384
<title>Configuring filters</title>
387
Filters are plugins which modify an audio stream.
391
To configure a filter, add a <varname>filter</varname> block
392
to <filename>mpd.conf</filename>:
395
<programlisting>filter {
397
name "software volume"
402
The following table lists the <varname>filter</varname>
403
options valid for all plugins:
421
<varname>plugin</varname>
424
The name of the plugin.
429
<varname>name</varname>
432
The name of the filter.
441
<title>Configuring playlist plugins</title>
444
Playlist plugins are used to load remote playlists. This is
445
not related to MPD's playlist directory.
449
To configure a filter, add a
450
<varname>playlist_plugin</varname> block to
451
<filename>mpd.conf</filename>:
454
<programlisting>playlist_plugin {
461
The following table lists the
462
<varname>playlist_plugin</varname> options valid for all
481
<varname>name</varname>
484
The name of the plugin.
489
<varname>enabled</varname>
323
490
<parameter>yes|no</parameter>
326
Specifies whether the hardware mixer of this audio
327
output should be used. By default, all hardware
328
mixers are enabled if available.
493
Allows you to disable a input plugin without
494
recompiling. By default, all plugins are enabled.
504
<title>Using MPD</title>
507
<title>The client</title>
510
After you have installed, configured and started MPD, you
511
choose a client to control the playback.
515
The most basic client is <filename>mpc</filename>, which
516
provides a command line interface. It is useful in shell
517
scripts. Many people bind specific <filename>mpc</filename>
522
The <ulink url="http://mpd.wikia.com/wiki/Clients">MPD
523
Wiki</ulink> contains an extensive list of clients to choose
529
<title>The music directory and the database</title>
532
The "music directory" is where you store your music files.
533
MPD stores all relevant meta information about all songs in
534
its "database". Whenever you add, modify or remove songs in
535
the music directory, you have to update the database, for
536
example with <filename>mpc</filename>:
539
<programlisting>mpc update</programlisting>
542
Depending on the size of your music collection and the speed
543
of the storage, this can take a while.
547
To exclude a file from the update, create a file called
548
<filename>.mpdignore</filename> in its parent directory. Each
549
line of that file may contain a list of shell wildcards.
554
<title>The queue</title>
557
The queue (sometimes called "current playlist") is a list of
558
songs to be played by MPD. To play a song, add it to the
559
queue and start playback. Most clients offer an interface to
338
566
<title>Plugin reference</title>
627
<title>Decoder plugins</title>
630
<title><varname>mikmod</varname></title>
633
Module player based on MikMod.
640
<entry>Setting</entry>
641
<entry>Description</entry>
647
<varname>sample_rate</varname>
650
Sets the sample rate generated by
651
<filename>libmikmod</filename>. Default is 44100.
408
661
<title>Output plugins</title>
792
<title><varname>ffado</varname></title>
795
The <varname>ffado</varname> plugin connects to FireWire
796
audio devices via <filename>libffado</filename>.
800
Warning: this plugin was not tested successfully. I just
801
couldn't keep libffado2 from crashing. Use at your own
809
<entry>Setting</entry>
810
<entry>Description</entry>
816
<varname>device</varname>
817
<parameter>NAME</parameter>
820
Sets the device which should be used, e.g. "hw:0".
539
829
<title><varname>jack</varname></title>
542
832
The <varname>jack</varname> plugin connects to a JACK
840
<entry>Setting</entry>
841
<entry>Description</entry>
847
<varname>client_name</varname>
848
<parameter>NAME</parameter>
851
The name of the JACK client. Defaults to "Music
857
<varname>server_name</varname>
858
<parameter>NAME</parameter>
861
Optional name of the JACK server.
866
<varname>autostart</varname>
867
<parameter>yes|no</parameter>
870
If set to <parameter>yes</parameter>, then
871
<filename>libjack</filename> will automatically
872
launch the JACK daemon. Disabled by default.
877
<varname>source_ports</varname>
878
<parameter>A,B</parameter>
881
The names of the JACK source ports to be created.
882
By default, the ports "left" and "right" are
883
created. To use more ports, you have to tweak this
889
<varname>destination_ports</varname>
890
<parameter>A,B</parameter>
893
The names of the JACK destination ports to connect to.
898
<varname>ringbuffer_size</varname>
899
<parameter>NBYTES</parameter>
902
Sets the size of the ring buffer for each channel.
903
Do not configure this value unless you know what
1081
<title><varname>openal</varname></title>
1084
The "OpenAL" plugin uses <filename>libopenal</filename>.
1085
It is supported on many platforms.
1092
<entry>Setting</entry>
1093
<entry>Description</entry>
1099
<varname>device</varname>
1100
<parameter>NAME</parameter>
1103
Sets the device which should be used. This can be
1104
any valid OpenAL device name. If not specified, then
1105
<filename>libopenal</filename> will choose a default device.
697
1114
<title><varname>osx</varname></title>
1196
<title><varname>recorder</varname></title>
1199
The <varname>recorder</varname> plugin writes the audio
1200
played by MPD to a file. This may be useful for recording
1205
You must configure either <varname>quality</varname> or
1206
<varname>bitrate</varname>.
1213
<entry>Setting</entry>
1214
<entry>Description</entry>
1220
<varname>path</varname>
1221
<parameter>P</parameter>
1229
<varname>encoder</varname>
1230
<parameter>NAME</parameter>
1233
Chooses an encoder plugin,
1234
e.g. <parameter>vorbis</parameter>.
1239
<varname>quality</varname>
1240
<parameter>Q</parameter>
1243
Configures the encoder quality (for VBR) in the
1249
<varname>bitrate</varname>
1250
<parameter>BR</parameter>
1253
Sets a constant encoder bit rate, in kilobit per
779
1263
<title><varname>shout</varname></title>
939
1423
</informaltable>
1428
<title>Playlist plugins</title>
1431
<title><varname>lastfm</varname></title>
1434
Plays last.fm radio.
1441
<entry>Setting</entry>
1442
<entry>Description</entry>
1448
<varname>user</varname>
1449
<parameter>USERNAME</parameter>
1452
The last.fm user name.
1457
<varname>password</varname>
1458
<parameter>PWD</parameter>
1461
The last.fm password.
1470
<title><varname>m3u</varname></title>
1473
Reads <filename>.m3u</filename> playlist files.
1478
<title><varname>extm3u</varname></title>
1481
Reads extended <filename>.m3u</filename> playlist files.
1486
<title><varname>pls</varname></title>
1489
Reads <filename>.pls</filename> playlist files.
1494
<title><varname>xspf</varname></title>
1497
Reads <ulink url="http://www.xspf.org/">XSPF</ulink>
added
removed
doc/user.xml
