From b8086ec822095570ff5095410b558df9ac75bc32 Mon Sep 17 00:00:00 2001
From: Wil-B <35600752+Wil-B@users.noreply.github.com>
Date: Sat, 13 May 2023 12:19:08 +0100
Subject: [PATCH] v1.4.0
---
CHANGELOG.md | 49 ++++
LICENSE.txt | 2 +-
README.md | 2 +-
assets/html/config.html | 160 ++++++++-----
assets/html/confirm.html | 3 +-
assets/images/Logo.png | Bin 51464 -> 119862 bytes
main.js | 2 +
package.json | 2 +-
scripts/allmusic.js | 24 +-
scripts/buttons.js | 109 ++++-----
scripts/callbacks.js | 89 +++++--
scripts/filmstrip.js | 21 +-
scripts/helpers.js | 11 +-
scripts/images.js | 90 +++++---
scripts/interface.js | 231 +++++++++++++------
scripts/language.js | 484 +++++++++++++++++++++++++++++++++++++++
scripts/lastfm.js | 24 +-
scripts/library.js | 2 +
scripts/lyrics.js | 39 +++-
scripts/menu.js | 214 ++++++++---------
scripts/names.js | 21 +-
scripts/panel.js | 258 ++++++++++++---------
scripts/popupbox.js | 16 +-
scripts/properties.js | 47 ++--
scripts/resize.js | 10 +-
scripts/scrollbar.js | 1 +
scripts/server.js | 8 +-
scripts/settings.js | 151 +++++++++++-
scripts/tagger.js | 54 +++--
scripts/text.js | 395 ++++++++++++++++++--------------
scripts/wikipedia.js | 52 +++--
31 files changed, 1822 insertions(+), 749 deletions(-)
create mode 100644 scripts/language.js
diff --git a/CHANGELOG.md b/CHANGELOG.md
index a7d8d37..43f726f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,52 @@
+# v1.4.0
+
+### Added
+- summary
+ - option to disable compact style for the summary
+ - allows showing all genres, moods, members & composers in summary rather than limiting each to one line
+ - menu > display or click summary to toggle
+- nowplaying display
+ - image effects
+ - user configurable (options > textreader & lyrics tab)
+ - use in it's own right or as a fallback
+- layout
+ - full overlay preset (menu > layout)
+ - shows text over an album art background
+ - configurable. Press CTRL or options > behaviour tab > overlay where there is also an example of usage
+- advanced radio stream parser
+ - designed for use with streams that contain the artist name and song title in a non-standard format
+ - user configurable (open in a text editor)
+ - location: ...foo_spider_monkey_panel\package_data\{BA9557CE-7B4B-4E0E-9373-99F511E81252}
+ - won't be overwritten if biography is updated
+- language support for menu
+ - simplified Chinese
+ - traditional Chinese
+ - enable: panel properties > 'Language [Menu]...'
+- lyrics
+ - drop shadow effect (options > textreader & lyrics tab)
+ - larger sync line options (options > textreader & lyrics tab)
+- customisable playlist interaction for follow selected item
+ - default settings should be fine for most users. If required:
+ - load delay can now be increased if moving through playlist is laggy (options > advanced tab) [regorxxx]
+ - leading item can now be set to use the delay or load immediately (options > advanced tab)
+
+### Changed
+- improve support for other scripts wishing to use biography virtual tags
+- scripts can now use ```window.NotifyOthers('bio_syncTags', focus)``` when the current track changes. Focus is either false (prefer nowplaying) or true (follow selected track)
+ - overrides biography tag settings so that:
+ - biography always notifies the tags
+ - that the notified tags include a core set of tags
+ - that the notified tags include the correct selection mode
+- the notification also now has the artist and album name
+
+### Fixed
+- rare on_size error
+- occasional ActiveX Object error triggered by a site change
+- title format regression introduced in 1.3.4 with certain special characters
+- workaround for apparent folder locking stopping some film strip images loading during downloading
+
+
+
# v1.3.6
### Added
diff --git a/LICENSE.txt b/LICENSE.txt
index b0512e1..c7fca6b 100644
--- a/LICENSE.txt
+++ b/LICENSE.txt
@@ -1,6 +1,6 @@
License
-Copyright (c) 2021-2022 WilB
+Copyright (c) 2021-2023 WilB
The above copyright notice shall be included in all
copies or substantial portions of the Software.
diff --git a/README.md b/README.md
index 6a0d725..19d25cc 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@ Feature rich biography plug-in for [foobar2000](https://www.foobar2000.org)
- Lyrics: synced and unsynced
- Textreader
- Item properties
+- Nowplaying display
- Layout presets: top, left, right, bottom and overlay. Fully customisable with freestyle layouts
- Themes: user interface, dark, blend, light and random
- Custom colours and fonts
@@ -63,4 +64,3 @@ Standard grouping
Alternative grouping
-
diff --git a/assets/html/config.html b/assets/html/config.html
index b14aacd..bb4777d 100644
--- a/assets/html/config.html
+++ b/assets/html/config.html
@@ -46,12 +46,11 @@
.div_text8 {padding:1.25em 0 0.31em;}
.div_text9 {padding:1.57em 0 0;}
.div_text10 {padding:0 0 0.7em;}
- .div_text11 {padding:3.57em 0 0.5em;}
- .div_text12 {padding:1.57em 0 0.31em;}
- .div_text14 {padding:1.25em 0 0.91em;}
- .div_text15 {padding:0.725em 0 0;}
- .div_text16 {padding:0.58em 0 0;}
- .alignLH, .alignRH, .alignLeftH, .alignRightH, .div_text1, .div_text2, .div_text3, .div_text6, .div_text7, .div_text8, .div_text9, .div_text10, .div_text11, .div_text12, .div_text14, .div_text15, .div_text16 {
+ .div_text11 {padding:1.57em 0 0.31em;}
+ .div_text12 {padding:1.25em 0 0.91em;}
+ .div_text13 {padding:0.725em 0 0;}
+ .div_text14 {padding:0.58em 0 0;}
+ .alignLH, .alignRH, .alignLeftH, .alignRightH, .div_text1, .div_text2, .div_text3, .div_text6, .div_text7, .div_text8, .div_text9, .div_text10, .div_text11, .div_text12, .div_text13, .div_text14 {
font:bold 1.15em Segoe UI; color:#0066CC; word-wrap:break-word; white-space:pre-wrap;
}
@@ -129,6 +128,7 @@
.input35, .input40, .input73, .input96 {
display:inline-block; vertical-align:middle;
}
+ .input99 {display:inline-block; vertical-align:middle; width:98%; border:none !important; background:none}
.inp_label1 {display:block; margin:0.31em 0;}
.inp_label2 {padding-left:0.46em;}
@@ -236,7 +236,7 @@
Fallback text: Heading|NoHeading
-
Scroll
+
Scroll
Bar:
@@ -260,7 +260,11 @@
-
Used by overlay & custom layouts. Flat & rounded support custom colours.
+
Flat & rounded support custom colours.
+
+As an alternative for lyrics, try menu > layout > full overlay with: flat style,
+
+
Extra menu items
@@ -293,8 +297,10 @@
Highlight
-
Items disabled if custom colour set.
-
Image and filmStrip size
+
Items disabled if custom colour set. Line option disabled if dark lines enabled.
+
Line style
+
+
Image and filmStrip size
Press Ctrl and drag lines to adjust image:text ratio or filmstrip size (panel needs focus, e.g. click it).
@@ -416,7 +422,7 @@
-
Seeker & counter
+
Seeker & counter
@@ -438,7 +444,7 @@
-
Reflection
+
Reflection
@@ -451,16 +457,16 @@
- Supports text, lyrics and item properties. Uses first found for each view.
+ Displays text, lyrics, item properties and nowplaying info. Uses first found for each view.
-
Artist view
+
Artist view
UseNameFull path or tag*Lyrics source
-
Album view
+
Album view
UseNameFull path or tag*
@@ -468,13 +474,18 @@
- *Evaluated as a path if backslash present, else as a tag. Filename & extension support wildcards.
+ *Evaluated as a path if backslash present, else as a tag. Filename & extension support wildcards.
+
+
+
-
+
+
Check "lyrics sources" to identify which sources require lyrics handling
Images and other sources are all available, so text, lyrics and item properties can be viewed in more interesting ways
@@ -520,8 +540,8 @@
- Supports lyrics offset + on the fly adjustment with mouse wheel (not saved)
Download integration
Biography doesn't download lyrics, but can synchronise with lyrics plug-ins as follows.
-
Check "synchronise..." above
Ensure a lyric show 3 or openlyrics panel is in the layout (can be hidden) & that lyric saving is enabled
Ensure save settings in the lyrics panel match load settings above
-
If lyric show 3 is used, install veksha's multi-source for lyrics. Disable the default lyrics 3 sources as mostly they don't work anymore. Enable NEW DB: Minilyrics, NEW DB: QQ Music & NEW DB: Netease for synced lyrics or others as required.
+
Check "synchronise..." above
Ensure a lyric show 3 or ESLyric panel is in the layout (can be hidden) & that lyric saving is enabled
Ensure save settings in the lyrics panel match load settings above
+
If lyric show 3 is used, install veksha's multi-source for lyrics. Disable the default lyrics 3 sources as mostly they don't work anymore. Enable NEW DB: Minilyrics, NEW DB: QQ Music & NEW DB: Netease for synced lyrics or others as required. Although lyrics obtained by openlyrics can be displayed, that plug-in isn't suited to download integration.
Fade height
Increase if fade effect is too close to top / bottom, e.g. try 0.5.
Lyrics in tags
@@ -531,15 +551,15 @@
Scroll time is the milliseconds taken to scroll a line. The recommended range is 400-1500. Lyrics cannot be autoscrolled if text sources are amalgamated
Item properties
Item properties can be displayed by pasting in one of the paths below. Both display the same information, but use different groupings.
-
-
-
item_properties splits metadata into organised groups
item_properties_alternative_grouping shows metadata in a single group
both show other groups like youtube, statistics, location, general and replaygain
either can be edited in a text editor to add, remove or re-order groups and properties
-
Overlay
-
Lyrics, item properties, text, biographies and reviews can all be overlayed on top of faded cycling artist images or album cover for an alternative view, e.g.
-
Enable the overlay layout (menu > layout). Press ctrl & drag the red line to top
Image tab: set an auto-fill image type under image+text
Filmstrip: place at bottom*, e.g. with circular image type
Display tab: set image margins to 0 & adjust text margins if required. Set theme to dark, random or personal preference
Use shift + wheel to adjust image strength
-* Other positions work best with the filmstrip set to overlay the image area (menu > layout > filmstrip), with adjustment of text margins and full width heading off (heading tab)
+
+
+
item_properties splits metadata into organised groups
item_properties_alternative_grouping shows metadata in a single group
both show other groups like youtube, statistics, location, general and replaygain
either can be edited in a text editor to add, remove or re-order groups and properties
other files can be used provided item_properties is present in the name
+
Nowplaying
+
Nowplaying info can be displayed by pasting in the path below.
+
+
for ease of editing the nowplaying source uses a saved file
other files can be used provided nowplaying is present in the name
alignment N/A if text sources are amalgamated
Look-up (drop down menu)
-
Usage is optional
Textreader would need to to load info for artists (artist view) or albums (album view). Use %BIO_ARTIST%, %BIO_ALBUMARTIST% or %BIO_ALBUM%, as appropriate
Lyrics and item properties, if displayed, automatically show for the current track
+
Usage is optional
Textreader would need to load info for artists (artist view) or albums (album view). Use %BIO_ARTIST%, %BIO_ALBUMARTIST% or %BIO_ALBUM%, as appropriate
Lyrics, item properties and nowplaying info, if displayed, automatically show for the current track
@@ -593,6 +613,8 @@
Image: Smooth transition level
+
Playlist interaction (follow selected item)
+
Server name
This option enables the server to be set per panel. Panels having the same server name use the same server. The OK button must be clicked after changing the server name.
@@ -607,9 +629,12 @@
-The variables are used in searching, & should be used in save folder paths and headings to ensure correct functionality.
+The variables are used in searching, & should be used in save folder paths and headings to ensure correct functionality.
+
+An advanced radio stream parser designed for use with streams that contain the artist name and song title in a non-standard format is located in foo_spider_monkey_panel\package_data\{BA9557CE-7B4B-4E0E-9373-99F511E81252}. It's user configurable (open in a text editor).
+
-
Classical music extension
+
Classical music extension
Extends auto-download of allmusic & wikipedia reviews to compositions. N/A for last.fm. Enable and set tag below. To display, per panel, use sources\text sub-menu.
If preferred, composer can be used by changing %BIO_ALBUMARTIST% above so $meta(composer,0) is the first item.
@@ -690,11 +715,11 @@
Simple string suitable for most uses
-
+
More complex string that works with artists with a leading dot, e.g. .38 Special. Biography always replaces leading dots with an underscore to stop foobar2000 choking on them
-
+
Put the string in: file>preferences>display>album art>artist pattern
@@ -766,23 +791,27 @@
Scores rank the long-term popularity of artists and albums on a 1-100 scale using total scrobbles and listeners. The highest scoring artist or album at last.fm is set to a score of 100.
Access tags as e.g:
-
-
-
+
+
+
For album statistics, change artist to album.
Remove punctuation from playcount & listeners if used in queries, sorting or arithmetic title formatting functions, e.g.
-
+
Notify tags
If checked, enabled tags for the current track are notified to other Spider Monkey Panels. This includes artist data for radio streams. Notifications are sent on track change and when new or updated data is received.
-The current track will be the playing track or selected track depending on the panel display mode. This may differ between panels if there is more than one biography panel. The selection mode and the handle are sent. Default tag names are used instead of any custom names, so third party scripts know what to expect.
+The current track will be the playing track or selected track depending on the panel display mode. Default tag names are used instead of any custom names, so third party scripts know what to expect.
+
+Additionally, third party scripts can use window.NotifyOthers('bio_syncTags', focus) when the current track changes where focus is either false (prefer nowplaying) or true (follow selected track). This overrides biography tag settings so that biography always notifies the tags, that the notified tags include a core set of tags and that the notified tags include the correct selection mode.
Use on_notify_data(name, info) in the receiving panel to process the notification, where:
name is 'biographyTags'
info is an object:
{
+ artist: 'ARTIST NAME',
+ album: 'ALBUM NAME',
handle: handle of current track,
selectionMode: biography selectionMode - string either 'Prefer nowplaying' or 'Follow selected track (playlist)'
tags: {
@@ -790,7 +819,7 @@
}
}
-Third party scripts can set the biography selection mode* by using window.NotifyOthers('bio_followSelectedTrack', boolean), where boolean is either true [Follow selected track (playlist)] or false [Prefer nowplaying]. *N/A if there is a lyrics source enabled as panel has to be in prefer nowplaying mode.
+Third party scripts can set the biography selection mode* by using window.NotifyOthers('bio_followSelectedTrack', boolean), where boolean is either true [Follow selected track (playlist)] or false [Prefer nowplaying]. *N/A if a lyrics or nowplaying source is enabled as panel has to be in prefer nowplaying mode.