Add backports of mpd and related recipes
[AGL/meta-agl-demo.git] / recipes-multimedia / musicpd / files / mpd.conf.in
1 # An example configuration file for MPD
2 # See the mpd.conf man page for a more detailed description of each parameter.
3
4
5 # Files and directories #######################################################
6 #
7 # This setting controls the top directory which MPD will search to discover the
8 # available audio files and add them to the daemon's online database. This
9 # setting defaults to the XDG directory, otherwise the music directory will be
10 # be disabled and audio files will only be accepted over ipc socket (using
11 # file:// protocol) or streaming files over an accepted protocol.
12 #
13 music_directory         "/media"
14 #
15 # This setting sets the MPD internal playlist directory. The purpose of this
16 # directory is storage for playlists created by MPD. The server will use
17 # playlist files not created by the server but only if they are in the MPD
18 # format. This setting defaults to playlist saving being disabled.
19 #
20 playlist_directory              "%playlist_directory%"
21 #
22 # This setting sets the location of the MPD database. This file is used to
23 # load the database at server start up and store the database while the
24 # server is not up. This setting defaults to disabled which will allow
25 # MPD to accept files over ipc socket (using file:// protocol) or streaming
26 # files over an accepted protocol.
27 #
28 db_file                 "%db_file%"
29 #
30 # These settings are the locations for the daemon log files for the daemon.
31 # These logs are great for troubleshooting, depending on your log_level
32 # settings.
33 #
34 # The special value "syslog" makes MPD use the local syslog daemon. This
35 # setting defaults to logging to syslog, otherwise logging is disabled.
36 #
37 log_file                        "syslog"
38 #
39 # This setting sets the location of the file which stores the process ID
40 # for use of mpd --kill and some init scripts. This setting is disabled by
41 # default and the pid file will not be stored.
42 #
43 #pid_file                       "/var/run/mpd/mpd.pid"
44 #
45 # This setting sets the location of the file which contains information about
46 # most variables to get MPD back into the same general shape it was in before
47 # it was brought down. This setting is disabled by default and the server
48 # state will be reset on server start up.
49 #
50 state_file              "%state_file%"
51 #
52 # The location of the sticker database.  This is a database which
53 # manages dynamic information attached to songs.
54 #
55 #sticker_file                   "~/.mpd/sticker.sql"
56 #
57 ###############################################################################
58
59
60 # General music daemon options ################################################
61 #
62 # This setting specifies the user that MPD will run as. MPD should never run as
63 # root and you may use this setting to make MPD change its user ID after
64 # initialization. This setting is disabled by default and MPD is run as the
65 # current user.
66 #
67 user "mpd"
68 #
69 # This setting specifies the group that MPD will run as. If not specified
70 # primary group of user specified with "user" setting will be used (if set).
71 # This is useful if MPD needs to be a member of group such as "audio" to
72 # have permission to use sound card.
73 #
74 #group "audio"
75 #
76 # This setting sets the address for the daemon to listen on. Careful attention
77 # should be paid if this is assigned to anything other then the default, any.
78 # This setting can deny access to control of the daemon.
79 #
80 # For network
81 bind_to_address         "any"
82 #
83 # And for Unix Socket
84 #bind_to_address                "~/.mpd/socket"
85 #
86 # This setting is the TCP port that is desired for the daemon to get assigned
87 # to.
88 #
89 #port                           "6600"
90 #
91 # This setting controls the type of information which is logged. Available
92 # setting arguments are "default", "secure" or "verbose". The "verbose" setting
93 # argument is recommended for troubleshooting, though can quickly stretch
94 # available resources on limited hardware storage.
95 #
96 #log_level                      "default"
97 #
98 # If you have a problem with your MP3s ending abruptly it is recommended that
99 # you set this argument to "no" to attempt to fix the problem. If this solves
100 # the problem, it is highly recommended to fix the MP3 files with vbrfix
101 # (available from <http://www.willwap.co.uk/Programs/vbrfix.php>), at which
102 # point gapless MP3 playback can be enabled.
103 #
104 #gapless_mp3_playback                   "yes"
105 #
106 # This setting enables MPD to create playlists in a format usable by other
107 # music players.
108 #
109 #save_absolute_paths_in_playlists       "no"
110 #
111 # This setting defines a list of tag types that will be extracted during the
112 # audio file discovery process. Optionally, 'comment' can be added to this
113 # list.
114 #
115 #metadata_to_use        "artist,album,title,track,name,genre,date,composer,performer,disc"
116 #
117 # This setting enables automatic update of MPD's database when files in
118 # music_directory are changed.
119 #
120 auto_update     "yes"
121 #
122 # Limit the depth of the directories being watched, 0 means only watch
123 # the music directory itself.  There is no limit by default.
124 #
125 auto_update_depth "3"
126 #
127 ###############################################################################
128
129
130 # Symbolic link behavior ######################################################
131 #
132 # If this setting is set to "yes", MPD will discover audio files by following
133 # symbolic links outside of the configured music_directory.
134 #
135 follow_outside_symlinks "no"
136 #
137 # If this setting is set to "yes", MPD will discover audio files by following
138 # symbolic links inside of the configured music_directory.
139 #
140 #follow_inside_symlinks         "yes"
141 #
142 ###############################################################################
143
144
145 # Zeroconf / Avahi Service Discovery ##########################################
146 #
147 # If this setting is set to "yes", service information will be published with
148 # Zeroconf / Avahi.
149 #
150 #zeroconf_enabled               "yes"
151 #
152 # The argument to this setting will be the Zeroconf / Avahi unique name for
153 # this MPD server on the network.
154 #
155 #zeroconf_name                  "Music Player"
156 #
157 ###############################################################################
158
159
160 # Permissions #################################################################
161 #
162 # If this setting is set, MPD will require password authorization. The password
163 # can setting can be specified multiple times for different password profiles.
164 #
165 #password                        "password@read,add,control,admin"
166 #
167 # This setting specifies the permissions a user has who has not yet logged in.
168 #
169 #default_permissions             "read,add,control,admin"
170 #
171 ###############################################################################
172
173
174 # Input #######################################################################
175 #
176
177 #input {
178 #        plugin "curl"
179 #       proxy "proxy.isp.com:8080"
180 #       proxy_user "user"
181 #       proxy_password "password"
182 #}
183
184 #
185 ###############################################################################
186
187 # Audio Output ################################################################
188 #
189 # MPD supports various audio output types, as well as playing through multiple
190 # audio outputs at the same time, through multiple audio_output settings
191 # blocks. Setting this block is optional, though the server will only attempt
192 # autodetection for one sound card.
193 #
194 # See <http://mpd.wikia.com/wiki/Configuration#Audio_Outputs> for examples of
195 # other audio outputs.
196 #
197 # board specific examples #####################################################
198 # (feel free to add futher)
199 #
200 # gumstix overo (tested with TOBI expansion board)
201 #audio_output {
202 #       type            "alsa"
203 #       name            "overo"
204 #       mixer_control   "Headset"
205 #       mixer_index     "0"
206 #}
207
208 audio_output {
209         type "pipewire"
210         name "AGL PipeWire"
211 }
212
213 # general examples ############################################################
214 #
215 # An example of an ALSA output:
216 #
217 #audio_output {
218 #       type            "alsa"
219 #       name            "My ALSA Device"
220 ##      device          "hw:0,0"        # optional
221 ##      format          "44100:16:2"    # optional
222 ##      mixer_type      "hardware"      # optional
223 ##      mixer_device    "default"       # optional
224 ##      mixer_control   "PCM"           # optional
225 ##      mixer_index     "0"             # optional
226 #}
227 #
228 # An example of an OSS output:
229 #
230 #audio_output {
231 #       type            "oss"
232 #       name            "My OSS Device"
233 ##      device          "/dev/dsp"      # optional
234 ##      format          "44100:16:2"    # optional
235 ##      mixer_type      "hardware"      # optional
236 ##      mixer_device    "/dev/mixer"    # optional
237 ##      mixer_control   "PCM"           # optional
238 #}
239 #
240 # An example of a shout output (for streaming to Icecast):
241 #
242 #audio_output {
243 #       type            "shout"
244 #       encoding        "ogg"                   # optional
245 #       name            "My Shout Stream"
246 #       host            "localhost"
247 #       port            "8000"
248 #       mount           "/mpd.ogg"
249 #       password        "hackme"
250 #       quality         "5.0"
251 #       bitrate         "128"
252 #       format          "44100:16:1"
253 ##      protocol        "icecast2"              # optional
254 ##      user            "source"                # optional
255 ##      description     "My Stream Description" # optional
256 ##      genre           "jazz"                  # optional
257 ##      public          "no"                    # optional
258 ##      timeout         "2"                     # optional
259 ##      mixer_type      "software"              # optional
260 #}
261 #
262 # An example of a recorder output:
263 #
264 #audio_output {
265 #       type            "recorder"
266 #       name            "My recorder"
267 #       encoder         "vorbis"                # optional, vorbis or lame
268 #       path            "/var/lib/mpd/recorder/mpd.ogg"
269 ##      quality         "5.0"                   # do not define if bitrate is defined
270 #       bitrate         "128"                   # do not define if quality is defined
271 #       format          "44100:16:1"
272 #}
273 #
274 # An example of a httpd output (built-in HTTP streaming server):
275 #
276 #audio_output {
277 #       type            "httpd"
278 #       name            "My HTTP Stream"
279 #       encoder         "vorbis"                # optional, vorbis or lame
280 #       port            "8000"
281 #       bind_to_address "0.0.0.0"               # optional, IPv4 or IPv6
282 ##      quality         "5.0"                   # do not define if bitrate is defined
283 #       bitrate         "128"                   # do not define if quality is defined
284 #       format          "44100:16:1"
285 #       max_clients     "0"                     # optional 0=no limit
286 #}
287 #
288 # An example of a pulseaudio output (streaming to a remote pulseaudio server)
289 #
290 #audio_output {
291 #       type            "pulse"
292 #       name            "My Pulse Output"
293 ##      server          "remote_server"         # optional
294 ##      sink            "remote_server_sink"    # optional
295 #}
296 #
297 ## Example "pipe" output:
298 #
299 #audio_output {
300 #       type            "pipe"
301 #       name            "my pipe"
302 #       command         "aplay -f cd 2>/dev/null"
303 ## Or if you're want to use AudioCompress
304 #       command         "AudioCompress -m | aplay -f cd 2>/dev/null"
305 ## Or to send raw PCM stream through PCM:
306 #       command         "nc example.org 8765"
307 #       format          "44100:16:2"
308 #}
309 #
310 ## An example of a null output (for no audio output):
311 #
312 #audio_output {
313 #       type            "null"
314 #       name            "My Null Output"
315 #       mixer_type      "none"                  # optional
316 #}
317 #
318 # This setting will change all decoded audio to be converted to the specified
319 # format before being passed to the audio outputs. By default, this setting is
320 # disabled.
321 #
322 #audio_output_format            "44100:16:2"
323 #
324 # If MPD has been compiled with libsamplerate support, this setting specifies
325 # the sample rate converter to use.  Possible values can be found in the
326 # mpd.conf man page or the libsamplerate documentation. By default, this is
327 # setting is disabled.
328 #
329 #samplerate_converter           "Fastest Sinc Interpolator"
330 #
331 ###############################################################################
332
333
334 # Normalization automatic volume adjustments ##################################
335 #
336 # This setting specifies the type of ReplayGain to use. This setting can have
337 # the argument "off", "album" or "track". See <http://www.replaygain.org>
338 # for more details. This setting is off by default.
339 #
340 #replaygain                     "album"
341 #
342 # This setting sets the pre-amp used for files that have ReplayGain tags. By
343 # default this setting is disabled.
344 #
345 #replaygain_preamp              "0"
346 #
347 # This setting enables on-the-fly normalization volume adjustment. This will
348 # result in the volume of all playing audio to be adjusted so the output has
349 # equal "loudness". This setting is disabled by default.
350 #
351 #volume_normalization           "no"
352 #
353 ###############################################################################
354
355
356 # MPD Internal Buffering ######################################################
357 #
358 # This setting adjusts the size of internal decoded audio buffering. Changing
359 # this may have undesired effects. Don't change this if you don't know what you
360 # are doing.
361 #
362 #audio_buffer_size              "2048"
363 #
364 # This setting controls the percentage of the buffer which is filled before
365 # beginning to play. Increasing this reduces the chance of audio file skipping,
366 # at the cost of increased time prior to audio playback.
367 #
368 #buffer_before_play             "10%"
369 #
370 ###############################################################################
371
372
373 # Resource Limitations ########################################################
374 #
375 # These settings are various limitations to prevent MPD from using too many
376 # resources. Generally, these settings should be minimized to prevent security
377 # risks, depending on the operating resources.
378 #
379 connection_timeout              "120"
380 #max_connections                "10"
381 #max_playlist_length            "16384"
382 #max_command_list_size          "2048"
383 #max_output_buffer_size         "8192"
384 #
385 ###############################################################################
386
387
388 # Character Encoding ##########################################################
389 #
390 # If file or directory names do not display correctly for your locale then you
391 # may need to modify this setting.
392 #
393 #filesystem_charset             "UTF-8"
394 #
395 # This setting controls the encoding that ID3v1 tags should be converted from.
396 #
397 #id3v1_encoding                 "ISO-8859-1"
398 #
399 ###############################################################################
400
401
402 # SIDPlay decoder #############################################################
403 #
404 # songlength_database:
405 #  Location of your songlengths file, as distributed with the HVSC.
406 #  The sidplay plugin checks this for matching MD5 fingerprints.
407 #  See http://www.c64.org/HVSC/DOCUMENTS/Songlengths.faq
408 #
409 # default_songlength:
410 #  This is the default playing time in seconds for songs not in the
411 #  songlength database, or in case you're not using a database.
412 #  A value of 0 means play indefinitely.
413 #
414 # filter:
415 #  Turns the SID filter emulation on or off.
416 #
417 #decoder {
418 #       plugin                  "sidplay"
419 #       songlength_database     "/media/C64Music/DOCUMENTS/Songlengths.txt"
420 #       default_songlength      "120"
421 #       filter "true"
422 #}
423 #
424 ###############################################################################
425