From 2bdb311df29a1524223c606e52c72d0524ed6bda Mon Sep 17 00:00:00 2001 From: kaliko Date: Tue, 15 Dec 2020 16:31:53 +0100 Subject: [PATCH] Releasing 0.16.0 --- data/man/mpd-sima.1 | 4 +- data/man/mpd_sima.1.html | 2 +- data/man/mpd_sima.cfg.5 | 20 ++++++-- data/man/mpd_sima.cfg.5.html | 97 ++++++++++++++++++++++++------------ data/man/mpd_sima.cfg.5.xml | 74 +++++++++++++-------------- data/man/simadb_cli.1 | 4 +- data/man/simadb_cli.1.html | 2 +- doc/Changelog | 2 +- sima/info.py | 2 +- 9 files changed, 127 insertions(+), 80 deletions(-) diff --git a/data/man/mpd-sima.1 b/data/man/mpd-sima.1 index e6a09da..6189e70 100644 --- a/data/man/mpd-sima.1 +++ b/data/man/mpd-sima.1 @@ -2,12 +2,12 @@ .\" Title: mpd-sima .\" Author: kaliko .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 05/11/2020 +.\" Date: 12/15/2020 .\" Manual: mpd-sima 0.16.0 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "MPD\-SIMA" "1" "05/11/2020" "mpd-sima" "mpd-sima 0.16.0 User Manual" +.TH "MPD\-SIMA" "1" "12/15/2020" "mpd-sima" "mpd-sima 0.16.0 User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/data/man/mpd_sima.1.html b/data/man/mpd_sima.1.html index 18c6329..6e97c9c 100644 --- a/data/man/mpd_sima.1.html +++ b/data/man/mpd_sima.1.html @@ -34,6 +34,6 @@ system please look in /usr/share/doc/mpd-sima.

DEFAULTS

Default is to look for MPD server at localhost:6600 (or MPD_HOST/MPD_PORT env. var. if set).

The get the defaults as detected by mpd-sima on your system you can run mpd-sima to print the config:

mpd-sima --generate-config

For details about mpd_sima.cfg refer to the manual mpd_sima.cfg(5) -

FEEDBACK/BUGS

The maintainer would be more than happy to ear from you, don't hesitate to send feedback, http://kaliko.me/id/.

XMPP users are welcome to join the dedicated chat room at kaliko.me@conf.azylum.org.

SEE ALSO

mpc(1), mpd(1)

+

FEEDBACK/BUGS

The maintainer would be more than happy to ear from you, don't hesitate to send feedback, https://kaliko.me/contact/.

XMPP users are welcome to join the dedicated chat room at kaliko.me@conf.azylum.org.

SEE ALSO

mpc(1), mpd(1)

/usr/share/doc/mpd-sima/

diff --git a/data/man/mpd_sima.cfg.5 b/data/man/mpd_sima.cfg.5 index 345864f..877eced 100644 --- a/data/man/mpd_sima.cfg.5 +++ b/data/man/mpd_sima.cfg.5 @@ -2,12 +2,12 @@ .\" Title: mpd_sima.cfg .\" Author: kaliko .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/14/2020 +.\" Date: 12/15/2020 .\" Manual: mpd-sima 0.16.0 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "MPD_SIMA\&.CFG" "5" "12/14/2020" "mpd-sima" "mpd-sima 0.16.0 User Manual" +.TH "MPD_SIMA\&.CFG" "5" "12/15/2020" "mpd-sima" "mpd-sima 0.16.0 User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -276,6 +276,11 @@ Random plugin\*(Aqs configuration: .RS 4 .RE .PP +\fBtrack_to_add=\fR\fI1\fR +.RS 4 +How many track(s) to add\&. +.RE +.PP \fBflavour=\fR\fIsensible\fR .RS 4 When no similar tracks are found, falling back to random queuing\&. Different mode, aka random flavour, are available: @@ -461,11 +466,18 @@ You can use here any valid MPD filter as defined in MPD protocol documentation\& .RS 4 Plugin priority .RE +.PP +\fBtrack_to_add=\fR\fI1\fR +.RS 4 +How many track(s) to add\&. +.RE .SH "QUEUE MODES" .PP -mpd\-sima offers different queue modes with lastfm plugin\&. All of them pick up tracks from artists similar to the last track in the queue\&. +Different queue modes are available with some plugins (check for +\fBqueue_mode\fR +presence in plugin config)\&. .PP -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\&. +mpd\-sima tries preferably to chose among unplayed artists or at least not recently played artist\&. .PP \fBtrack\fR .RS 4 diff --git a/data/man/mpd_sima.cfg.5.html b/data/man/mpd_sima.cfg.5.html index b1d40d0..5efec5d 100644 --- a/data/man/mpd_sima.cfg.5.html +++ b/data/man/mpd_sima.cfg.5.html @@ -2,7 +2,25 @@ following different policies. This manual document the configuration file for mpd-sima.

DESCRIPTION

This manual page documents briefly mpd-sima configuration options available in user configuration file - (see the section called “FILES”).

EXAMPLES

Album queue mode.

Here is an example of album queue configuration.

[MPD]
+            (see the section called “FILES”).

EXAMPLES

File tags queue mode (offline mode).

Here is an example of autoqueue using file tags only.

[MPD]
+host=example.org
+port=6601
+
+[sima]
+# Setup internal plugins
+internal = Tags, Crop
+history_duration=48  # 2 days
+queue_length=2
+
+[tags]
+# Look for files with tagged with genre "electonica" OR "IDM" OR "glitch"
+genre = electonica, IDM, glitch
+
+[crop]
+# keep 30 played tracks in playlist
+consume=30
+
+

Album queue mode using last.fm recommendations (online mode).

Here is an example of album queue configuration using online recommendations system.

[MPD]
 host=example.org
 port=8000
 
@@ -41,8 +59,7 @@ consume=30
                             
The default list of plugins to load at startup: Lastfm,Random,Crop.

                                 Crop is an utility plugin, it does not queue any tracks (cf. below).

                                 Random will queue a track at random if other plugins did not return any tracks.

-                            
You can add here as many plugins you want,
-                                currently shipping Lastfm only.

+                            
You can add, combine here as many plugins you want.

                                 The priority may be used to order them.
                             
history_duration=8
How far to look back in history to avoid to play
                                 twice the same track/title (duration in
@@ -62,7 +79,7 @@ consume=30
                             Set to some negative integer to keep all played tracks.
                         
priority=10

                             Plugin priority
-

Random section

Random plugin's configuration:

[random]
flavour=sensible

When no similar tracks are found, falling back to +

Random section

Random plugin's configuration:

[random]
track_to_add=1

How many track(s) to add.

flavour=sensible

When no similar tracks are found, falling back to random queuing. Different mode, aka random flavour, are available: pure, @@ -91,10 +108,10 @@ consume=30 top and track queue modes. This is actually an upper limit, min(max_art, - track_to_add) will be used, and - max_art might be inferior lower - than value set in config.

album_to_add=1

How many album(s) to add. Only relevant in - album queue modes.

cache=True

Whether or not to use on-disk persistent http + track_to_add) will be used.

album_to_add=1

How many album(s) to add. Only relevant in + album queue modes.

track_to_add_from_album=0

How many track(s) to add from each selected albums. Only relevant in + album queue modes. When set to 0 or lower the whole album is queued. +

cache=True

Whether or not to use on-disk persistent http cache.
When set to "true", sima will use a persistent cache for its http client. The cache is written along with the dbfile in:
@@ -102,31 +119,49 @@ consume=30 If set to "false", caching is still done but in memory.

priority=100

Plugin priority -

QUEUE MODES

mpd-sima offers different queue modes. All of them pick up - tracks from artists similar to the last track in the queue.

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.

track

Queue a similar track chosen at random from a similar artist.

top

Queue a track from a similar artist, chosen among - "top tracks" according to last.fm data mining.

album

Queue a whole album chosen at random from a similar artist.

Nota Bene:
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.
- 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.
- 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.

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.

FILES

${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg

Configuration file.

${XDG_DATA_HOME}/mpd_sima/sima.db

SQLite DB file.

${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/

Persistent http cache.

Usually XDG_DATA_HOME is set to +

Tags section

Tags plugin's configuration. There is no default configuration for this plugin, it does not work out of the box.

+ This plugin permits offline autoqueuing based on files tags only. Supported tags are + 'comment', 'date', 'genre', 'label' and + 'originaldate'. It currently supports single track queuing only, no album mode for this plugin. +

+ In addition to supported tags above you can use an MPD filter. Please refer to MPD protocol documentation for more. +

+ All entries in this section are ANDed as a single MPD filter to look for titles + in the library. Moreover, with tags, comma separated values are also ANDed.
+ For instance setting "genre=rock" and + "date=1982,1983,1984,1985,1986,1987,1988,1989" + will end up looking for track tagged with genre rock + and date within 1985 through 1990.
+ Using an MPD filter to replace date you can achieve + the same with the following setting: "genre=rock" and + "filter=(date =~ '198[2-9]')" (provided your MPD server + was compiled with libpcre). +

[tags]
filter=

You can use here any valid MPD filter as defined in MPD protocol documentation.

comment=
date=
genre=
label=
priority=80

+ Plugin priority +

track_to_add=1

How many track(s) to add.

QUEUE MODES

Different queue modes are available with some plugins (check for + queue_mode presence in plugin config). +

mpd-sima tries preferably to chose among unplayed artists or + at least not recently played artist.

track

Queue a similar track chosen at random from a similar artist.

top

Queue a track from a similar artist, chosen among + "top tracks" according to last.fm data mining.

album

Queue a whole album chosen at random from a similar artist.

Nota Bene:
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.
+ 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.
+ 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.

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.

FILES

${XDG_CONFIG_HOME}/mpd_sima/mpd_sima.cfg

Configuration file.

${XDG_DATA_HOME}/mpd_sima/sima.db

SQLite DB file.

${XDG_DATA_HOME}/mpd_sima/WEB_SERVICE/

Persistent http cache.

Usually XDG_DATA_HOME is set to ${HOME}/.local/share and XDG_CONFIG_HOME to ${HOME}/.config.
You may override them using command line option --var-dir and --config (cf. - mpd-sima(1))

FEEDBACK/BUGS

The maintainer would be more than happy to ear from you, don't hesitate to send feedback, http://kaliko.me/id/.

XMPP users are welcome to join the dedicated chat room at kaliko.me@conf.azylum.org.

SEE ALSO

mpc(1), mpd(1)

+ mpd-sima(1))

FEEDBACK/BUGS

The maintainer would be more than happy to ear from you, don't hesitate to send feedback, https://kaliko.me/contact/.

XMPP users are welcome to join the dedicated chat room at kaliko.me@conf.azylum.org.

SEE ALSO

mpc(1), mpd(1)

/usr/share/doc/mpd-sima/

diff --git a/data/man/mpd_sima.cfg.5.xml b/data/man/mpd_sima.cfg.5.xml index 153448c..149087f 100644 --- a/data/man/mpd_sima.cfg.5.xml +++ b/data/man/mpd_sima.cfg.5.xml @@ -493,43 +493,43 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ &dhpackage; tries preferably to chose among unplayed artists or at least not recently played artist. - - - - Queue a similar track chosen at random from a similar artist. - - - - - - Queue a track from a similar artist, chosen among - "top tracks" according to last.fm data mining. - - - - - - Queue a whole album chosen at random from a similar artist. - Nota Bene: 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. - 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. - 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. - &dhpackage; 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. - - + + + + Queue a similar track chosen at random from a similar artist. + + + + + + Queue a track from a similar artist, chosen among + "top tracks" according to last.fm data mining. + + + + + + Queue a whole album chosen at random from a similar artist. + Nota Bene: 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. + 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. + 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. + &dhpackage; 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. + + diff --git a/data/man/simadb_cli.1 b/data/man/simadb_cli.1 index 9d6adf8..be2300a 100644 --- a/data/man/simadb_cli.1 +++ b/data/man/simadb_cli.1 @@ -2,12 +2,12 @@ .\" Title: simadb_cli .\" Author: kaliko .\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 05/11/2020 +.\" Date: 12/15/2020 .\" Manual: mpd-sima 0.16.0 User Manual .\" Source: mpd-sima .\" Language: English .\" -.TH "SIMADB_CLI" "1" "05/11/2020" "mpd-sima" "mpd-sima 0.16.0 User Manual" +.TH "SIMADB_CLI" "1" "12/15/2020" "mpd-sima" "mpd-sima 0.16.0 User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/data/man/simadb_cli.1.html b/data/man/simadb_cli.1.html index 62ed362..bb46123 100644 --- a/data/man/simadb_cli.1.html +++ b/data/man/simadb_cli.1.html @@ -37,6 +37,6 @@ currently playing) you can use --bl_ar="Artist name to black list".

OPTIONS

The program follows the usual GNU command line syntax, with long options starting with two dashes ("-"). A summary of - options is included below.

-h, --help

Print help and exit.

--version

Print version and exit.

--bl_art=artist_name

Use to black list artist_name. simadb_cli is checking artist_name is actually in MPD music library (cf -S and -P options to set MPD host/address if necessary).

If artist_name is not found the script print out a list of matching artists.

--bl_curr_trk | --bl_curr_art | --bl_curr_alb

Use to black list the currently playing track|artist|album. You need access to your MPD server, use -S and -P to set MPD host/address if necessary.

-d db_file, --dbfile=db_file

Use the specific file db_file as database.
Default is too use XDG_DATA_HOME (see the section called “FILES”).

--purge_hist

Purge history, you may supply an alternative DB file with --dbfile option.

--remove_bl=row_id

Use to remove a black list entry. To get the row_id to suppress use --view_bl option.

--view_bl

Get all entries in the black list.

-P mpd_port, --port=mpd_port

Use the specific port number mpd_port on MPD server. This overrides MPD_PORT environment variable.
Default is 6600.

-S mpd_host, --host=mpd_host

Use the specific host mpd_host as MPD server.
mpd_host can be an IP or a fully qualified domain name as long as your system can resolve it. This overrides MPD_HOST environment variable.
Default is localhost.

FILES

${XDG_DATA_HOME}/mpd_sima/sima.db

SQLite DB file. Usually XDG_DATA_HOME is set to ${HOME}/.local/share.

FEEDBACK/BUGS

The maintainer would be more than happy to ear from you, don't hesitate to send feedback, http://kaliko.me/id/.

XMPP users are welcome to join the dedicated chat room at kaliko.me@conf.azylum.org.

SEE ALSO

mpc(1), mpd(1)

+ options is included below.

-h, --help

Print help and exit.

--version

Print version and exit.

--bl_art=artist_name

Use to black list artist_name. simadb_cli is checking artist_name is actually in MPD music library (cf -S and -P options to set MPD host/address if necessary).

If artist_name is not found the script print out a list of matching artists.

--bl_curr_trk | --bl_curr_art | --bl_curr_alb

Use to black list the currently playing track|artist|album. You need access to your MPD server, use -S and -P to set MPD host/address if necessary.

-d db_file, --dbfile=db_file

Use the specific file db_file as database.
Default is too use XDG_DATA_HOME (see the section called “FILES”).

--purge_hist

Purge history, you may supply an alternative DB file with --dbfile option.

--remove_bl=row_id

Use to remove a black list entry. To get the row_id to suppress use --view_bl option.

--view_bl

Get all entries in the black list.

-P mpd_port, --port=mpd_port

Use the specific port number mpd_port on MPD server. This overrides MPD_PORT environment variable.
Default is 6600.

-S mpd_host, --host=mpd_host

Use the specific host mpd_host as MPD server.
mpd_host can be an IP or a fully qualified domain name as long as your system can resolve it. This overrides MPD_HOST environment variable.
Default is localhost.

FILES

${XDG_DATA_HOME}/mpd_sima/sima.db

SQLite DB file. Usually XDG_DATA_HOME is set to ${HOME}/.local/share.

FEEDBACK/BUGS

The maintainer would be more than happy to ear from you, don't hesitate to send feedback, https://kaliko.me/contact/.

XMPP users are welcome to join the dedicated chat room at kaliko.me@conf.azylum.org.

SEE ALSO

mpc(1), mpd(1)

/usr/share/doc/mpd-sima/

diff --git a/doc/Changelog b/doc/Changelog index 12d5a1e..7d286bb 100644 --- a/doc/Changelog +++ b/doc/Changelog @@ -6,7 +6,7 @@ MPD_sima v0.16.0 * Fixed bug when http client fetches a corrupted cached entry (closes #35) * Need at least python 3.6 - -- kaliko UNRELEASED + -- kaliko Tue, 15 Dec 2020 16:17:05 +0100 MPD_sima v0.16.0.dev0 diff --git a/sima/info.py b/sima/info.py index 1651c69..4c29c02 100644 --- a/sima/info.py +++ b/sima/info.py @@ -12,7 +12,7 @@ short. """ -__version__ = '0.16.0.dev1' +__version__ = '0.16.0' __author__ = 'kaliko' __email__ = 'kaliko@azylum.org' __url__ = 'git://git.kaliko.me/sima.git' -- 2.39.5