1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>mpd-sima.cfg</title><meta name="generator" content="DocBook XSL-NS Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="mpd-sima.cfg"><a name="idp128"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>mpd-sima.cfg — mpd-sima will try to maintain some titles ahead in your play
list following different policies. This manual document the
configuration file for mpd-sima.</p></div><div class="refsect1" title="DESCRIPTION"><a name="description"></a><h2>DESCRIPTION</h2>
<p>This manual page documents briefly <span class="command"><strong>mpd-sima</strong></span>
configuration options available in user configuration file
(see <a class="xref" href="#files" title="FILES">the section called “FILES”</a>).</p>
</div><div class="refsect1" title="Configuration file"><a name="options"></a><h2>Configuration file</h2>
<p>The configuration file consists of sections, led by a
<span class="command"><strong>[section]</strong></span> header and followed by <code class="option">name:value</code>
entries, with continuations in the style of RFC 822 (see section
3.1.1, “LONG HEADER FIELDS”); <code class="option">name=value</code> is also accepted. Lines
beginning with <em class="parameter"><code>'#'</code></em> or <em class="parameter"><code>';'</code></em>
are ignored and may be used to provide comments.</p>
<p>The default values are used in the options lists below.</p>
<div class="refsect2" title="MPD section"><a name="MPD"></a><h3>MPD section</h3>
<p>This section is meant to configure MPD access, MPD host
address / port and password if necessary.</p>
<div class="variablelist"><dl><dt><span class="term"><code class="option">[MPD]</code></span></dt><dd></dd><dt><span class="term"><code class="option">host=</code><em class="replaceable"><code>localhost</code></em></span></dt><dd><p>Set MPD host. Use IP or FQDN.</p></dd><dt><span class="term"><code class="option">port=</code><em class="replaceable"><code>6600</code></em></span></dt><dd><p>Set host port to access MPD to.</p></dd><dt><span class="term"><code class="option">password=</code><em class="replaceable"><code>false</code></em></span></dt><dd><p>Set MPD password to use. Do not use this option
if you don't have enabled password protected access
on your MPD server.</p></dd></dl></div>
</div>
<div class="refsect2" title="log section"><a name="log"></a><h3>log section</h3>
<p>Configure logging.</p>
<div class="variablelist"><dl><dt><span class="term"><code class="option">[log]</code></span></dt><dd><p></p></dd><dt><span class="term"><code class="option">verbosity=</code><em class="replaceable"><code>info</code></em></span></dt><dd><p>Logging verbosity among
<em class="replaceable"><code>debug</code></em>,
<em class="replaceable"><code>info</code></em>,
<em class="replaceable"><code>warning</code></em>,
<em class="replaceable"><code>error</code></em>.</p></dd></dl></div>
</div>
<div class="refsect2" title="sima section"><a name="sima"></a><h3>sima section</h3>
<p>This section allows you to tweak mpd-sima behaviour such
as how many tracks to add and/or what queue mode you want
<abbr class="abbrev">etc.</abbr>.</p>
<div class="variablelist"><dl><dt><span class="term"><code class="option">[sima]</code></span></dt><dd><p></p></dd><dt><span class="term"><code class="option">queue_mode=</code><em class="replaceable"><code>track</code></em></span></dt><dd><p>Queue mode to use among
<em class="replaceable"><code>track</code></em>,
<em class="replaceable"><code>top</code></em> and
<em class="replaceable"><code>album</code></em> (see <a class="xref" href="#queue_mode" title="QUEUE MODES">the section called “QUEUE MODES”</a> for info about queue modes).</p></dd><dt><span class="term"><code class="option">similarity=</code><em class="replaceable"><code>15</code></em></span></dt><dd><p>Similarity value as a percentage, use to filter similar artists results.<br>
The value of <code class="option">similarity</code> is used to filter similar artists list from database (last.fm and user db).</p></dd><dt><span class="term"><code class="option">dynamic=</code><em class="replaceable"><code>10</code></em></span></dt><dd><p>Dynamic value as an integer. Sets how many similar artists to retrieve from local music library.<br>
mpd-sima will try to gather at most <code class="option">dynamic</code> artists from local media library at least <code class="option">similarity</code>% similar.<br>
If <code class="option">dynamic</code> is zero, then mpd-sima gathers all artists from similar artists list also present in local library and at least <code class="option">similarity</code>% similar.
</p></dd><dt><span class="term"><code class="option">user_db=</code><em class="replaceable"><code>false</code></em></span></dt><dd><p>Look for user defined similarities in user data base.</p></dd><dt><span class="term"><code class="option">history_duration=</code><em class="replaceable"><code>8</code></em></span></dt><dd><p>How far to look back in history to avoid to play twice the same track/title (duration in hours).</p></dd><dt><span class="term"><code class="option">consume=</code><em class="replaceable"><code>0</code></em></span></dt><dd><p>How many played tracks to keep in the play list.
Allow to maintain a fixed length play list.
Set to 0 to keep all played tracks.
</p></dd><dt><span class="term"><code class="option">single_album=</code><em class="replaceable"><code>false</code></em></span></dt><dd><p>Prevent from queueing a track from the same album
(it often happens with OST).<br>
Only relevant in "track" queue mode.</p></dd><dt><span class="term"><code class="option">check_new_version=</code><em class="replaceable"><code>false</code></em></span></dt><dd><p>Checks the forge for new version of MPD_sima.</p></dd></dl></div>
<p>The following options are still part of <code class="option">sima</code>
section but you usually do not need to change them.</p>
<div class="variablelist"><dl><dt><span class="term"><code class="option">queue_length=</code><em class="replaceable"><code>1</code></em></span></dt><dd><p>This value triggers queue process if the play
list length is less than specified
queue_length.</p></dd><dt><span class="term"><code class="option">track_to_add=</code><em class="replaceable"><code>1</code></em></span></dt><dd><p>How many track(s) to add. Only relevant in
<code class="option">top</code> and <code class="option">track</code>
queue modes.</p></dd><dt><span class="term"><code class="option">album_to_add=</code><em class="replaceable"><code>1</code></em></span></dt><dd><p>How many album(s) to add. Only relevant in
<code class="option">album</code> queue modes.</p></dd></dl></div>
</div>
</div><div class="refsect1" title="QUEUE MODES"><a name="queue_mode"></a><h2>QUEUE MODES</h2>
<p>mpd-sima offers different queue modes. All of them pick up
tracks from artists similar to the one currently played.</p>
<p>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.</p>
<div class="variablelist"><dl><dt><span class="term"><code class="option">track</code></span></dt><dd><p>Queue a similar track chosen at random from a similar artist.</p></dd><dt><span class="term"><code class="option">top</code></span></dt><dd><p>Queue a track from a similar artist, chosen among
"top tracks" according to last.fm data mining.</p></dd><dt><span class="term"><code class="option">album</code></span></dt><dd><p>Queue a whole album chosen at random from a similar artist.</p><p><span class="emphasis"><em>Nota Bene:</em></span><br> 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.<br>
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.<br>
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.</p><p>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't be queued.<br>
It is planned to allow users to set the values of
AlbumArtists tag triggering this behaviour. cf.
feature request #2085 on the tracker.</p></dd></dl></div>
</div><div class="refsect1" title="FILES"><a name="files"></a><h2>FILES</h2>
<p>Unless you override it mpd-sima will try to read the
configuration file name <code class="filename">mpd_sima.cfg</code> in the
standard location within <code class="envar">XDG_CONFIG_HOME</code>.</p>
<div class="variablelist"><dl><dt><span class="term"><code class="filename">${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg</code></span></dt><dd><p>The per-user configuration file. Usually
<code class="envar">XDG_CONFIG_HOME</code> is set to
<code class="filename">${HOME}/.config</code>.</p></dd></dl></div>
</div><div class="refsect1" title="EXAMPLES"><a name="examples"></a><h2>EXAMPLES</h2>
<div class="refsect2" title="Album queue mode."><a name="album"></a><h3>Album queue mode.</h3>
<p>Here is an example of album queue configuration.</p>
<pre class="programlisting">[MPD]
host=example.org
port=8000
[sima]
queue_mode = album
consume = 30 # keep 30 played tracks in playlist
</pre>
</div>
</div><div class="refsect1" title="BUGS"><a name="bugs"></a><h2>BUGS</h2>
<p>The upstream <acronym class="acronym">BTS</acronym> can be found
at <a class="ulink" href="http://codingteam.net/project/sima/bugs" target="_top">http://codingteam.net/project/sima/bugs</a>.</p>
</div><div class="refsect1" title="FEEDBACK"><a name="feedback"></a><h2>FEEDBACK</h2>
<p>The maintainer would be more than happy to ear from you, don't hesitate to send feedback on the forge, via the upstream <acronym class="acronym">BTS</acronym>, the forum or the chat room, all available on the forge at <a class="ulink" href="http://codingteam.net/project/sima" target="_top">http://codingteam.net/project/sima</a>.</p>
<p><acronym class="acronym">XMPP</acronym> users are welcome to join the dedicated chat room at <a class="ulink" href="sima@conference.codingteam.net" target="_top">sima@conference.codingteam.net</a>.</p>
</div><div class="refsect1" title="SEE ALSO"><a name="see_also"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">mpd-sima</span>(1)</span>, <span class="citerefentry"><span class="refentrytitle">simadb_cli</span>(1)</span></p>
<p>
<code class="filename">/usr/share/doc/mpd-sima/</code>
</p>
</div></div></body></html>
|
