Playlist-Tools-SMP

A collection of Spider Monkey Panel Scripts for foobar2000, built within a menu, which serves as a hub for 'usage examples' and shortcuts to the most requested foobar missing functionalities: remove duplicates by tags, revive dead items, check errors on tags, spotify-like playlist creation, advanced queries, etc.

WARNING: MOST OF THESE TOOLS FULLFILL MY PERSONAL NEEDS AND/OR OFFER FEATURES I CONSIDER NOT COVERED BY NATIVE FOOBAR2000, OUTDATED PLUGINS OR ARE LIMITED IN THEIR ORIGINAL COMPONENTS. THESE ARE ADVANCED TOOLS, IF YOU ARE EXPECTING A FOOLPROOF TOOL, LOOK ELSEWHERE. PLEASE, WHILE BUG REPORTS AND CONSTRUCTIVE FEEDBACK ARE WELCOME, DON'T COMPLAIN ABOUT THINGS BEING TOO COMPLEX. THEY ARE MEANT THIS WAY. IF YOU WANT SOMETHING DESIGNED JUST FOR YOU, FEEL FREE TO CONTACT ME FOR PAID WORK.

Features

It's impossible to offer a complete list of the things that can be done with these tools, in a few words: anything related to playlist creation, sorting, library maintenance, automation, etc. but a readme for every utility can be found using the corresponding menu (on configuration).

The collection of scripts provided here are not only an alternative to Random Pools or MusicIp but an improvement and generalization in many aspects of those tools. To use this plugin at its best and to benefit the most from your library, you will want to make sure that your songs have the most possible information on genre, style, key, moods, etc.

• Macros: allows to record and save the menus entries used, as a macro, to be called later. Automatic custom playlist creation and edits without limits. Works with all tools. (only limitation are popups, which still require user input)
• Dynamic Queries: queries which adapt to the currently selected track. i.e. placeholders tags are substituted with the actual values of the currently selected track, then the query is evaluated as usual. Queries created this way are pretty situational, save a lot of writing time and are meant to be used by multiple playlist creation tools. Expands foo_quicksearch contextual menus functionality, and works with multiple selection too.
• Pools[^pools]: playlist creation similar to Random Pools component. Multiple playlists \ library sources (pools) can be set to fill a destination playlist. Configurable selection length per source, query filtering, picking method (random, from start, from end) and final sorting of destination playlist. They may even use dynamic queries changing the way the pools behave according to selection (for ex. a pool which outputs tracks with same key than selected track + another one which outputs same genre tracks), the main limitation of Random Pools component.
• Harmonic mixing: Dj-like selection ordering by key or with special patterns. Compatible with Camelot, Open and Standard keys.
• Fully configurable submenu entries: shift + left click on menu button allows to switch tools functionality. Individual tools or entire submenus may be disabled/enabled. When all entries from a tool are disabled, the entire script files associated are omitted at loading.
• User configurable presets: many tools allow you to add your own presets (for ex. Standard Queries) as menu entries for later use. They may be used along macros to greatly expand their functionality, exported and imported as "addons".
• Keyboard shortcuts: keyboard shortcuts may be assigned to most of the tools (without requiring panel to be in focus). Shown on the related menu entries tabbed to the right. They are assigned the same than native keyboard shortcuts.
• Include other scripts (experimental): easily include ('merge') multiple SMP scripts into the same panel, thus not wasting multiple panels. Useful for those scripts that don't require any UI, user interaction,... like scripts which set the main menu SPM entries (File\Spider Monkey Panel).
• Reduce components loaded: one of the main limitations of windows (and thus foobar) is there is a limit of plugins (dlls) that can be associated to a given process. Thus, in some installations, specially those using VSTs, when the limit is reached strange things start happening, random crashes, bugs, etc. Something I have experienced myself when running a few VSTs. It's not so hard to reach that limit since many components use multiple dlls! When you count the ones by foobar itself, VSTs, etc. as soon as you configure a bit your installation you come into problems. Therefore Playlist Tools is a solution that can help in that sense, replacing multiple components whose functionality is already included (or improved): Random Pools, Playlist Revive, Best version picker, Database Search, ...
• Online controller integration (ajquery-xxx): online controller fully compatible with most of the offered tools, which can be called as any other main menu entry. Also available with CMD scripting.
• Wine - Unix - non IE SOs compatible: all the UI, tools, popups, configuration and external helpers have been carefully designed to work in all systems without requiring IE installation, HTML popups or editing the panel properties. Scripts are expected to work 100% the same in any SO.
• Configurable UI and accessibility design: most of the UI is configurable (size, colors, position, draggable buttons). All the UI is managed within menus, so it may be used with a narrator (for blindness).

The sky is the limit once you use the current scripts to create your own buttons and tools. Currently contains pre-defined use-cases for these scripts:

• Most played tracks from...: from a year or period. (requires Enhanced Playback Statistics)
  .\xxx-scripts\top_tracks.js
  .\xxx-scripts\top_tracks_from_date.js
• Top Rated tracks from...: from a year or range of years.
  .\xxx-scripts\top_rated_tracks.js
• Search same by tags...: dynamic queries matching X tags from selection.
  .\xxx-scripts\search_same_by.js
• Standard Queries: like foobar search but allowing presets.
  .\xxx-scripts\dynamic_query.js
• Dynamic Queries: queries with placeholders evaluated with selection.
  .\xxx-scripts\dynamic_query.js
• Similar by...: spotify-like playlist generation. (aka Search-by-Distance-SMP)
  .\xxx-scripts\search_bydistance.js
• Special Playlists...: contains functionality from the other scripts
  .\xxx-scripts\search_bydistance.js
  .\xxx-scripts\search_same_by.js
• Playlist manipulation: multiple tools for playlist edits.
  • Remove duplicates: using configurable tags.
    .\xxx-scripts\remove_duplicates.js
  • Query filtering: filters current playlist with a query.
    .\xxx-scripts\filter_by_query.js
  • Harmonic mix: Dj-like playlist generation by key. (aka Camelot-Wheel-Notation)
    .\xxx-scripts\harmonic_mixing.js
  • Find or create playlist
  • Cut playlist length (for macros)
  • Send playlist's tracks to (for macros)
  • Go to playlist (for macros)
  • Close playlist (for macros)
• Selection manipulation:
  • Harmonic mix: Dj-like selection ordering by key. (aka Camelot-Wheel-Notation)
    .\xxx-scripts\harmonic_mixing.js
  • Sort
    • Randomize
    • Reverse
    • By Mood
    • By Date
    • By BPM
    • By key: translates keys (Fm -> 4A) and sorts them. (aka Camelot-Wheel-Notation)
      .\xxx-scripts\sort_by_key.js
    • By Dyngenre: similar genres/styles are grouped together. (aka Search-by-Distance-SMP)
      .\xxx-scripts\search_bydistance.js
  • Scatter by tags: reorders selection to avoid consecutive tracks with the same configurable tag.
    .\xxx-scripts\scatter_by_tags.js
  • Find now playling track in...
    .\xxx-scripts\find_remove_from_playlists.js
  • Find track(s) in...
    .\xxx-scripts\find_remove_from_playlists.js
  • Remove track(s) from...
    .\xxx-scripts\find_remove_from_playlists.js
  • Send selection to playlist... (for macros)
  • Select (for macros)
    • By halves
    • By thirds
    • By quarters
    • First / Last track
    • Random track / Random # tracks
    • Delete selected / non selected tracks
• Other tools:
  • Check tags: checks selection to find errors on tags (useful on entire library).
    .\xxx-scripts\check_library_tags.js
  • Write tags: "macro" to write some tags.
    .\xxx-scripts\tags_automation.js
  • Playlist Revive: replaces and expands playlist revive component.
    .\xxx-scripts\playlist_revive.js
  • Playlist History: history of previously active playlists (for macros).
    .\xxx-scripts\helpers\playlist_history.js
  • Include scripts: add multiple SMP scripts into the same panel.
• Pools: use playlist(s), (dynamic) queries, etc. as source pool(s) for a destination playlist. [^pools]
• Macros: record and save menus entries used, as a macro, to be called later.
  .\xxx-scripts\helpers\playlist_tools_menu_macros.js
• Other scripts integration:
  • Playlist-Manager-SMP: Pools may use tracks from playlists files tracked by the manager, not requiring to have playlists loaded within foobar. i.e. Random Pools component-like playlist creation, using not only queries as sources, but also other playlists or playlists files.
  • ajquery-xxx: Online controller fully compatible which allow to use most of the available tools within the web browser.
  • SMP Dynamic menus: tools are also available as main menu entries -if enabled-, which allows to bind them to keyboard shortcuts, toolbar buttons or executing them using command line.

The menus are highly customizable. They are created on demand according to the selected tracks or current playlist, and many entries can be added, removed or edited to suit your needs. Also if some scripts are missing, the menu is rebuilt skipping those entries (letting you to install selectively what you need).

[^pools]: Note for sensitive souls: SQL database functionality from Random Pools will not be replicated since I consider it an inferior and user-inaccessible feature -with slower performance- which may be easily replicated by other means. On the other hand, things like duplication removal are totally absent on the original plugin, which may be a reason to switch to this alternative in some libraries. Advanced pools may be created using JSON presets, which allow to create really complex actions with different sources or built-in harmonic mixing. It's not a matter of which implementation is "better"; so if you feel some functionality is missing (not replicable in conjuction with the other tools available), let me know. ;)

Compatible with (toolbar)

1. Search-by-Distance-SMP: creates intelligent "spotify-like" playlist using high-level data from tracks and computing their similarity using genres/styles.
2. ListenBrainz-SMP: Integrates Listenbrainz's feedback and recommendations.
3. Autobackup-SMP: Automatic saving and backup of configuration and other data in foobar2000.
4. Device-Priority-SMP: Automatic output device selection.
5. Fingerprint-Tools-SMP: ChromaPrint and FooId fingerprinting tools.
6. Wrapped-SMP: Outputs a report similar to Spotify's wrapped and personalized playlists.

Also integrates

1. Search-by-Distance-SMP: creates intelligent "spotify-like" playlist using high-level data from tracks and computing their similarity using genres/styles.
2. Music-Graph: An open source graph representation of most genres and styles found on popular, classical and folk music.
3. Camelot-Wheel-Notation: Javascript implementation of the Camelot Wheel, ready to use "harmonic mixing" rules and translations for standard key notations.
4. Menu-Framework-SMP: Helper which allows to easily create customizable and dynamic menus.

Installation

See _TIPS and INSTALLATION (txt) and the Wiki. Not properly following the installation instructions will result in scripts not working as intended. Please don't report errors before checking this.