data/man/mpd_sima.cfg.5

   1 '\" t
   2 .\"     Title: mpd_sima.cfg
   3 .\"    Author: Jack Kaliko <kaliko@azylum.org>
   4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
   5 .\"      Date: 01/02/2016
   6 .\"    Manual: mpd-sima 0.14.1 User Manual
   7 .\"    Source: mpd-sima
   8 .\"  Language: English
   9 .\"
  10 .TH "MPD_SIMA\&.CFG" "5" "01/02/2016" "mpd-sima" "mpd-sima 0.14.1 User Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 mpd_sima.cfg \- mpd\-sima will try to maintain some titles ahead in the queue following different policies\&. This manual document the configuration file for mpd\-sima\&.
  32 .SH "DESCRIPTION"
  33 .PP
  34 This manual page documents briefly
  35 \fBmpd\-sima\fR
  36 configuration options available in user configuration file (see
  37 the section called \(lqFILES\(rq)\&.
  38 .SH "EXAMPLES"
  39 .SS "Album queue mode\&."
  40 .PP
  41 Here is an example of album queue configuration\&.
  42 .sp
  43 .if n \{\
  44 .RS 4
  45 .\}
  46 .nf
  47 [MPD]
  48 host=example\&.org
  49 port=8000
  50
  51 [sima]
  52 history_duration=48  # 2 days
  53 queue_length=5
  54
  55 [lastfm]
  56 queue_mode=album
  57 album_to_add=2
  58
  59 [crop]
  60 # keep 30 played tracks in playlist
  61 consume=30
  62
  63
  64 .fi
  65 .if n \{\
  66 .RE
  67 .\}
  68 .SH "CONFIGURATION FILE"
  69 .PP
  70 The configuration file consists of sections, led by a
  71 \fB[section]\fR
  72 header and followed by
  73 \fBname:\ \&value\fR
  74 entries, with continuations in the style of RFC 822 (see section 3\&.1\&.1, \(lqLONG HEADER FIELDS\(rq);
  75 \fBname=value\fR
  76 is also accepted\&. Lines beginning with
  77 \fI\*(Aq#\*(Aq\fR
  78 or
  79 \fI\*(Aq;\*(Aq\fR
  80 are ignored and may be used to provide comments (\fINota Bene:\fR
  81 inline comment are possible using
  82 \fI\*(Aq#\*(Aq\fR)\&.
  83 .PP
  84 The default values are used in the options lists below\&.
  85 .SS "MPD section"
  86 .PP
  87 This section is meant to configure MPD access, MPD host address / port and password if necessary\&.
  88 .PP
  89 \fB[MPD]\fR
  90 .RS 4
  91 .RE
  92 .PP
  93 \fBhost=\fR\fIlocalhost\fR
  94 .RS 4
  95 Set MPD host\&. Use IP or FQDN\&.
  96 .RE
  97 .PP
  98 \fBport=\fR\fI6600\fR
  99 .RS 4
 100 Set host port to access MPD to\&.
 101 .RE
 102 .PP
 103 \fBpassword=\fR\fIs3cr3t\fR
 104 .RS 4
 105 Set MPD password to use\&. Do not use this option if you don\*(Aqt have enabled password protected access on your MPD server\&.
 106 .RE
 107 .SS "log section"
 108 .PP
 109 Configure logging\&.
 110 .PP
 111 \fB[log]\fR
 112 .RS 4
 113 .RE
 114 .PP
 115 \fBlogfile=\fR
 116 .RS 4
 117 File to log to, usually in d\(aemon mode\&.
 118 .br
 119 Defaut (empty or unset) is to log to stdin/stdout\&.
 120 .RE
 121 .PP
 122 \fBverbosity=\fR\fIinfo\fR
 123 .RS 4
 124 Logging verbosity among
 125 \fIdebug\fR,
 126 \fIinfo\fR,
 127 \fIwarning\fR,
 128 \fIerror\fR\&.
 129 .RE
 130 .SS "Process daemonization"
 131 .PP
 132 Configure process daemon\&.
 133 .PP
 134 \fB[daemon]\fR
 135 .RS 4
 136 .RE
 137 .PP
 138 \fBdaemon=false\fR
 139 .RS 4
 140 whether to daemonize process or not\&.
 141 .RE
 142 .PP
 143 \fBpidfile=\fR
 144 .RS 4
 145 Where to store process ID\&.
 146 .RE
 147 .SS "sima section"
 148 .PP
 149 Core mpd_sima\&.cfg configuration\&.
 150 .PP
 151 \fB[sima]\fR
 152 .RS 4
 153 .RE
 154 .PP
 155 \fBcontrib=\fR
 156 .RS 4
 157 .RE
 158 .PP
 159 \fBinternal=\fR\fILastfm, Random, Crop\fR
 160 .RS 4
 161 mpd\-sima\*(Aqs plugin management for internal source plugin and contrib (ie\&. external plugins)\&.
 162 .br
 163
 164 Plugins list is a comma separated string list\&.
 165 .br
 166
 167 Optional plugin\*(Aqs configuration lays in its own section\&.
 168 .br
 169 For instance a "AwesomePlugin" declared here gets its configuration from the corresponding section "[awesomeplugin]"\&.
 170 .sp
 171 The default list of plugins to load at startup:
 172 \fBLastfm\fR,\fBRandom\fR,\fBCrop\fR\&.
 173 .br
 174 \fBCrop\fR
 175 is an utility plugin, it does not queue any tracks (cf\&. below)\&.
 176 .br
 177 \fBRandom\fR
 178 will queue a track at random if other plugins did not return any tracks\&.
 179 .br
 180
 181 .sp
 182 You can add here as many plugins you want, currently shipping
 183 \fBLastfm\fR
 184 and
 185 \fBEchoNest\fR
 186 only\&.
 187 .br
 188
 189 The priority may be used to order them\&.
 190 .RE
 191 .PP
 192 \fBhistory_duration=\fR\fI8\fR
 193 .RS 4
 194 How far to look back in history to avoid to play twice the same track/title (duration in hours)\&.
 195 .br
 196
 197 The
 198 \fBhistory_duration\fR
 199 is also used to give priority to not recently played artists\&.
 200 .RE
 201 .PP
 202 \fBqueue_length=\fR\fI2\fR
 203 .RS 4
 204 Threshold value triggering queue process\&.
 205 .RE
 206 .PP
 207 \fBmusicbrainzid=\fR\fItrue\fR
 208 .RS 4
 209 Use MusicBrainzIdentifier to search music (mainly for artists)\&. Default is True, switch to False if you don\*(Aqt have MusicBrainzIdentifier set for at least 80% of you music library\&.
 210 .br
 211
 212 Consider using these metadata as it enhances a lot artist/album/tracks identification\&. Use Picard to tag your file:
 213 \m[blue]\fB\%https://picard.musicbrainz.org/\fR\m[]\&.
 214 .RE
 215 .SS "Crop section"
 216 .PP
 217 crop plugin\*(Aqs configuration:
 218 .PP
 219 \fB[crop]\fR
 220 .RS 4
 221 .RE
 222 .PP
 223 \fBconsume=\fR\fI10\fR
 224 .RS 4
 225 How many played tracks to keep in the queue\&. Allows you to maintain a fixed length queue\&. Set to some negative integer to keep all played tracks\&.
 226 .RE
 227 .PP
 228 \fBpriority=\fR\fI10\fR
 229 .RS 4
 230 Plugin priority
 231 .RE
 232 .SS "Random section"
 233 .PP
 234 Random plugin\*(Aqs configuration:
 235 .PP
 236 \fB[random]\fR
 237 .RS 4
 238 .RE
 239 .PP
 240 \fBflavour=\fR\fIsensible\fR
 241 .RS 4
 242 When no similar tracks are found, falling back to random queuing\&. Different mode, aka random flavour, are available:
 243 \fIpure\fR,
 244 \fIsensible\fR,
 245 \fIgenre\fR\&.
 246 .sp
 247 .RS 4
 248 .ie n \{\
 249 \h'-04'\(bu\h'+03'\c
 250 .\}
 251 .el \{\
 252 .sp -1
 253 .IP \(bu 2.3
 254 .\}
 255 \fIpure\fR, pure random choice, even among recently played track\&.
 256 .RE
 257 .sp
 258 .RS 4
 259 .ie n \{\
 260 \h'-04'\(bu\h'+03'\c
 261 .\}
 262 .el \{\
 263 .sp -1
 264 .IP \(bu 2.3
 265 .\}
 266 \fIsensible\fR, use play history to filter chosen tracks\&.
 267 .RE
 268 .sp
 269 .RS 4
 270 .ie n \{\
 271 \h'-04'\(bu\h'+03'\c
 272 .\}
 273 .el \{\
 274 .sp -1
 275 .IP \(bu 2.3
 276 .\}
 277 \fIgenre\fR, Not implemented yet\&.
 278 .RE
 279 .sp
 280 .RE
 281 .PP
 282 \fBpriority=\fR\fI50\fR
 283 .RS 4
 284 Plugin priority
 285 .RE
 286 .SS "LastFm section"
 287 .PP
 288 LastFM plugin\*(Aqs configuration\&.
 289 .PP
 290 \fB[lastfm]\fR
 291 .RS 4
 292 .RE
 293 .PP
 294 \fBqueue_mode=\fR\fItrack\fR
 295 .RS 4
 296 Queue mode to use among
 297 \fItrack\fR,
 298 \fItop\fR
 299 and
 300 \fIalbum\fR
 301 (see
 302 the section called \(lqQUEUE MODES\(rq
 303 for info about queue modes)\&.
 304 .RE
 305 .PP
 306 \fBmax_art=\fR\fI10\fR
 307 .RS 4
 308 Number of similar artist to retrieve from local media library\&.
 309 .br
 310 When set to something superior to zero, it tries to get as much similar artists from media library\&.
 311 .RE
 312 .PP
 313 \fBdepth=\fR\fI1\fR
 314 .RS 4
 315 How many artists to base on similar artists search\&.
 316 .br
 317
 318 The first is the last played artist and so on back in the history\&. Highter depth generates wider suggestions, it might help to reduce looping over same artists\&.
 319 .RE
 320 .PP
 321 \fBsingle_album=\fR\fIfalse\fR
 322 .RS 4
 323 Prevent from queueing a track from the same album (it often happens with OST)\&.
 324 .br
 325
 326 Only relevant in "track" queue mode\&.
 327 .RE
 328 .PP
 329 \fBtrack_to_add=\fR\fI1\fR
 330 .RS 4
 331 How many track(s) to add\&. Only relevant in
 332 \fBtop\fR
 333 and
 334 \fBtrack\fR
 335 queue modes\&.
 336 .RE
 337 .PP
 338 \fBalbum_to_add=\fR\fI1\fR
 339 .RS 4
 340 How many album(s) to add\&. Only relevant in
 341 \fBalbum\fR
 342 queue modes\&.
 343 .RE
 344 .PP
 345 \fBcache=\fR\fITrue\fR
 346 .RS 4
 347 Whether or not to use on\-disk persistent http cache\&.
 348 .br
 349 When set to "true", sima will use a persistent cache for its http client\&. The cache is written along with the dbfile in:
 350 .br
 351 $XDG_CONFIG_HOME/mpd_sima/http/WEB_SERVICE\&.
 352 .br
 353
 354 If set to "false", caching is still done but in memory\&.
 355 .RE
 356 .PP
 357 \fBpriority=\fR\fI100\fR
 358 .RS 4
 359 Plugin priority
 360 .RE
 361 .SS "EchoNest section"
 362 .PP
 363 EchoNest plugin\*(Aqs configuration\&.
 364 .PP
 365 Options for EchoNest are exactly the same as LastFm (same default as well), except for cache plugin which is always needed to limit number of requests to the service\&.
 366 .PP
 367 \fB[echonest]\fR
 368 .RS 4
 369 .RE
 370 .PP
 371 \fBqueue_mode=\fR\fItrack\fR
 372 .RS 4
 373 .RE
 374 .PP
 375 \fBmax_art=\fR\fI10\fR
 376 .RS 4
 377 .RE
 378 .PP
 379 \fBdepth=\fR\fI1\fR
 380 .RS 4
 381 .RE
 382 .PP
 383 \fBsingle_album=\fR\fIfalse\fR
 384 .RS 4
 385 .RE
 386 .PP
 387 \fBtrack_to_add=\fR\fI1\fR
 388 .RS 4
 389 .RE
 390 .PP
 391 \fBalbum_to_add=\fR\fI1\fR
 392 .RS 4
 393 .RE
 394 .PP
 395 \fBpriority=\fR\fI100\fR
 396 .RS 4
 397 .RE
 398 .SH "QUEUE MODES"
 399 .PP
 400 mpd\-sima offers different queue modes\&. All of them pick up tracks from artists similar to the last track in the queue\&.
 401 .PP
 402 mpd\-sima tries preferably to chose among unplayed artists or at least not recently played artist\&. Concerning track and album queue modes titles are chosen purely at random among unplayed tracks\&.
 403 .PP
 404 \fBtrack\fR
 405 .RS 4
 406 Queue a similar track chosen at random from a similar artist\&.
 407 .RE
 408 .PP
 409 \fBtop\fR
 410 .RS 4
 411 Queue a track from a similar artist, chosen among "top tracks" according to last\&.fm data mining\&.
 412 .RE
 413 .PP
 414 \fBalbum\fR
 415 .RS 4
 416 Queue a whole album chosen at random from a similar artist\&.
 417 .sp
 418 \fINota Bene:\fR
 419 .br
 420
 421 Due to the track point of view of database build upon tracks tags an album lookup for a specific artist will return albums as soon as this artist appears in a single track of the album\&.
 422 .br
 423
 424 For instance looking for album from "The Velvet Underground" will fetch "Last Days" and "Juno" OSTs because the band appears on the soundtrack of these two movies\&.
 425 .br
 426
 427 A solution is for you to set AlbumArtists tag to something different than the actual artist of the track\&. For compilations, OSTs etc\&. a strong convention is to use "Various Artists" for this tag\&.
 428 .sp
 429 mpd\-sima is currently looking for AlbumArtists tags and avoid album where this tag is set with "Various Artists"\&. If a single track within an album is found with AlbumArtists:"Various Artists" the complete album is skipped and won\*(Aqt be queued\&.
 430 .RE
 431 .SH "FILES"
 432 .PP
 433 ${XDG_CONFIG_HOME}/mpd_sima/mpd_sima\&.cfg
 434 .RS 4
 435 Configuration file\&.
 436 .RE
 437 .PP
 438 ${XDG_DATA_HOME}/mpd_sima/sima\&.db
 439 .RS 4
 440 SQLite DB file\&.
 441 .RE
 442 .PP
 443 ${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/
 444 .RS 4
 445 Persistent http cache\&.
 446 .RE
 447 .PP
 448 Usually
 449 \fBXDG_DATA_HOME\fR
 450 is set to
 451 ${HOME}/\&.local/share
 452 and
 453 \fBXDG_CONFIG_HOME\fR
 454 to
 455 ${HOME}/\&.config\&.
 456 .br
 457 You may override them using command line option
 458 \fB\-\-var\-dir\fR
 459 and
 460 \fB\-\-config\fR
 461 (cf\&.
 462 \fBmpd-sima\fR(1))
 463 .SH "FEEDBACK/BUGS"
 464 .PP
 465 The maintainer would be more than happy to ear from you, don\*(Aqt hesitate to send feedback,
 466 \m[blue]\fB\%http://kaliko.me/id/\fR\m[]\&.
 467 .PP
 468 XMPP
 469 users are welcome to join the dedicated chat room at
 470 \m[blue]\fBkaliko\&.me@conf\&.azylum\&.org\fR\m[]\&.
 471 .SH "SEE ALSO"
 472 .PP
 473 \fBmpc\fR(1),
 474 \fBmpd\fR(1)
 475 .PP
 476 /usr/share/doc/mpd\-sima/
 477 .SH "AUTHOR"
 478 .PP
 479 \fBJack Kaliko\fR <\&kaliko@azylum\&.org\&>
 480 .RS 4
 481 Wrote this man page and is currently leading MPD_sima project\&.
 482 .RE
 483 .SH "COPYRIGHT"
 484 .br
 485 Copyright \(co 2009-2016 Jack Kaliko
 486 .br
 487 .PP
 488 This manual page was written for the Debian system (and may be used by others)\&.
 489 .PP
 490 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation\&.
 491 .PP
 492 On Debian systems, the complete text of the GNU General Public License can be found in
 493 /usr/share/common\-licenses/GPL\&.
 494 .sp