MusicBrainz Picard/Plugins: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(Please repush to wikidoc; attachment ver. of plugin 404s on wikidoc, up'd to ssh (Imported from MoinMoin))
(Converted the plugins page to a table. Will revert if not desired. (Imported from MoinMoin))
Line 1: Line 1:
=Plugins for Picard=
=Plugins for Picard=


To install a plugin:
To install a plugin, download and copy it to directory named 'plugins' either in the Picard application directory or in <code><nowiki>~/.config/MusicBrainz/Picard/plugins</nowiki></code> on Unix and <code><nowiki>%HOME%\Application Data\MusicBrainz\Picard\plugins</nowiki></code> on Windows.
# download .py file
# create new 'plugins' directory (if not existing already) under
## Windows: either <code><nowiki>C:\Program Files\Musicbrainz Picard\plugins</nowiki></code> (for default Picard application folder) or <code><nowiki>%USER_HOME%\Application Data\MusicBrainz\Picard\plugins</nowiki></code>
## *Nix: either Picard application directory or <code><nowiki>~/.config/MusicBrainz/Picard/plugins</nowiki></code>

# Move downloaded .py folder to 'plugins' directory
# Open Picard, go to Options >> Options... >> Plugins and check the box beside the plugin to enable it.


==Plugins==
==Plugins==


{| border="1"
===Disc Numbers===
|-

| '''Name''' || '''Description''' || '''Author''' || '''Compatibility''' || '''Download''' || '''Known issues/Notes'''
Moves ''(disc X)'' from releases titles into separate tags (''discnumber'' and ''discsubtitle'').
|-

[http://users.musicbrainz.org/~luks/picard-qt/plugins/discnumber.py Download]
| ''' Disc Numbers''' || Moves ''(disc X)'' from releases titles into separate tags (''discnumber'' and ''discsubtitle''). || Lukáš Lalinský || 0.9a - 0.9.0+ || [http://users.musicbrainz.org/~luks/picard-qt/plugins/discnumber.py here] || -
|-

| '''Feat. Artists''' || Removes ''(feat. Artist)'' parts from track titles. || Lukáš Lalinský || 0.9a - 0.9.0+ || [http://users.musicbrainz.org/~luks/picard-qt/plugins/featartist.py here] || -
===Feat. Artists===
|-

| '''Cover Art Downloader''' || Downloads cover art for optional tag embedding and/or saving as a separate image file (using standard Options >> Cover Art Picard settings) || Oliver Charles || 0.9a - 0.9.0+ || [http://users.musicbrainz.org/~luks/picard-qt/plugins/coverart.py here] || ''(remove the old Amazon plugin (amazon.py, amazon.pyc & amazon.pyo) before installing this one)''. See [[Ticket:3528|3528]], [[Ticket:3529|3529]]
Removes ''(feat. Artist)'' parts from track titles.
|-

| '''Last.fm Tags''' || Use Last.fm tags as "genre" || Lukáš Lalinský || 0.9a - 0.9.0+ || [http://users.musicbrainz.org/~luks/picard-qt/plugins/lastfm/__init__.py 1] [http://users.musicbrainz.org/~luks/picard-qt/plugins/lastfm/ui_options_lastfm.py 2] || ''(copy both files to directory <code><nowiki>plugins/lastfm/</nowiki></code>)''
[http://users.musicbrainz.org/~luks/picard-qt/plugins/featartist.py Download]
|-

| '''Add Cluster As A Release''' || Adds right click option to an unmatched cluster to allow adding releases to MB based on tags. || Lukáš Lalinský || 0.9a - 0.9.0+ || [http://users.musicbrainz.org/~luks/picard-qt/plugins/addrelease.py here] || See [[Ticket:2544|2544]], [[Ticket:3159|3159]]
===Cover Art Downloader===
|-

| '''Generate Cuesheet''' || Generates a cuesheet from a release || Lukáš Lalinský || 0.9a - 0.9a14 || [http://users.musicbrainz.org/~luks/picard-qt/plugins/cuesheet.py here] || Not compatible with 0.9.0a14 or higher
Downloads cover art.
|-

| '''Release Type''' || Appends information to EPs and Singles such as " EP" or " (single)" (customisable, see file for details). Useful for separating releases with singles/EPs of the same name. || Elliot Chance || 0.9a - 0.9.0+ || [http://sumafi.com/files/release_type.py here] || This version patches a PLUGIN_API_VERSIONS problem with the original.
[http://users.musicbrainz.org/~luks/picard-qt/plugins/coverart.py Download] ''(remove the old Amazon plugin (amazon.py, amazon.pyc & amazon.pyo) before installing this one)''
|-

| '''Search Plugins''' || Launches searches for clusters or releases to external non-MB websites from Picard. Update: Sept 15, 2007: All search plugins have been updated to work with alpha 14. The Google plugin also has been updated to allow searching from tracks. Sept 29 update: Track names also now work in the Google search! New SoundtrackINFO search plugin also added. October 19: Added GMR plugin. November 11: Added AMG plugin. || [[User:BrianFreud|BrianFreud]] || 0.9a - 0.9.0+ || - || -
===Last.fm Tags===
|-

| [http://users.musicbrainz.org/~brianfreud/SearchAMG.py All Music Guide] || -
Use Last.fm tags as "genre".
|-

| [http://users.musicbrainz.org/~brianfreud/SearchAmazon3.py Amazon] || Supports: .ca, .com, .de, .fr, .jp, and .co.uk
Download: [http://users.musicbrainz.org/~luks/picard-qt/plugins/lastfm/__init__.py 1] [http://users.musicbrainz.org/~luks/picard-qt/plugins/lastfm/ui_options_lastfm.py 2] ''(copy both files to directory <code><nowiki>plugins/lastfm/</nowiki></code>)''
|-

| [http://users.musicbrainz.org/~brianfreud/SearchCastAlbums3.py CastAlbums.org] || -
===Add Cluster As A Release===
|-

| [http://users.musicbrainz.org/~brianfreud/SearchDiscogs3.py Discogs] || -
(''Seems buggy at the moment, see [[Ticket:2900|2900]]'')
|-

[http://users.musicbrainz.org/~luks/picard-qt/plugins/addrelease.py Download]
| [http://users.musicbrainz.org/~brianfreud/SearchFilmMusziek3.py FilmMusziek.be] || (aka "Film Music Search")
|-

| [http://users.musicbrainz.org/~brianfreud/SearchGMR.py Game Music Revolution] || -
===Generate Cuesheet===
|-

[http://users.musicbrainz.org/~luks/picard-qt/plugins/cuesheet.py Download]
| [http://users.musicbrainz.org/~brianfreud/SearchGoogle3.py Google] || -
|-
* This plugin is not compatible with Alpha14. -[[User:AaronCooper|AaronCooper]]
| [http://users.musicbrainz.org/~brianfreud/SearchLortelArchives3.py The Lortel Archives] || (Off-Broadway cast recordings)
* Nor with [[Picard Qt|PicardQt]] 0.9.0beta1, Picard log reads, "I: 3084536000 13:11:33 Plugin 'Generate Cuesheet' from '/home/jdlh/.config/[[MusicBrainz]]/Picard/plugins/cuesheet.py' is not compatible with this version of Picard." -- [[User:JimDeLaHunt|JimDeLaHunt]] 2007-12-05
|-

| [http://users.musicbrainz.org/~brianfreud/SearchSoundtrackCollector3.py SoundtrackCollector.org] || -
===Release Type===
|-

| [http://users.musicbrainz.org/~brianfreud/SearchSoundtrackINFO3.py SoundtrackINFO] || -
Appends information to EPs and Singles such as " EP" or " (single)" (customisable, see file for details). Useful for separating releases with singles/EPs of the same name.
|-

| ''' Bonus Disc''' || Moves ''(bonus disc: Bonus Disc Title)'' from album titles to separate tags. (''bonusdisc'' and ''bonusdisctitle'') || Jan van Thiel || 0.9a - 0.9.0+ || [http://dispuut-ivv.nl/~jan/bonusdisc.py here] || -
[http://www.chancemedia.com/mb/picardqt/release_type.py Download]
|-

| '''Change Encoding''' || Converts the tags of individual files or clusters between different character encodings. This is often necessary with files that have only ID3v1 tags in a non-Latin encoding. || [[User:foolip|foolip]] || 0.9a - 0.9.0+ || [http://foolip.org/mb/encoding.py here] || You will probably only need to change the ''target'' encoding. If the encoding you're looking for isn't in the list, you can type it in yourself and it will hopefully work.
(This release did not work for me until I added PLUGIN_API_VERSIONS = [[0.9.0]] to the plugin file, below PLUGIN_VERSION = '1.0' - Grab an edited version [http://sumafi.com/files/release_type.py here])
|}

===Search Plugins===

<ul><li style="list-style-type:none">Launches searches for clusters or releases from PicardQT.
<ul><li style="list-style-type:none">Please contact [[User:BrianFreud|BrianFreud]] with any problems or to request additional search plugins. Update: Sept 15, 2007: All search plugins have been updated to work with alpha 14. The Google plugin also has been updated to allow searching from tracks. Sept 29 update: Track names also now work in the Google search! New SoundtrackINFO search plugin also added. October 19: Added GMR plugin. November 11: Added AMG plugin.
* '''All Music Guide'''
<ul><li style="list-style-type:none">[http://users.musicbrainz.org/~brianfreud/SearchAMG.py download]
</ul>
* '''Amazon'''
<ul><li style="list-style-type:none">Supports: .ca, .com, .de, .fr, .jp, and .co.uk [http://users.musicbrainz.org/~brianfreud/SearchAmazon3.py Download]
</ul>
* '''CastAlbums.org'''
<ul><li style="list-style-type:none">[http://users.musicbrainz.org/~brianfreud/SearchCastAlbums3.py Download]
</ul>
* '''Discogs'''
<ul><li style="list-style-type:none">[http://users.musicbrainz.org/~brianfreud/SearchDiscogs3.py Download]
</ul>
* '''FilmMusziek.be''' (aka "Film Music Search")
<ul><li style="list-style-type:none">[http://users.musicbrainz.org/~brianfreud/SearchFilmMusziek3.py Download]
</ul>
* '''Game Music Revolution'''
<ul><li style="list-style-type:none">[http://users.musicbrainz.org/~brianfreud/SearchGMR.py Download]
</ul>
* '''Google'''
<ul><li style="list-style-type:none">[http://users.musicbrainz.org/~brianfreud/SearchGoogle3.py Download]
</ul>
* '''The Lortel Archives''' (Off-Broadway cast recordings)
<ul><li style="list-style-type:none">[http://users.musicbrainz.org/~brianfreud/SearchLortelArchives3.py Download]
</ul>
* '''SoundtrackCollector.org'''
<ul><li style="list-style-type:none">[http://users.musicbrainz.org/~brianfreud/SearchSoundtrackCollector3.py Download]
</ul>
* '''SoundtrackINFO'''
<ul><li style="list-style-type:none">[http://users.musicbrainz.org/~brianfreud/SearchSoundtrackINFO3.py Download]
</ul>

</ul>
</ul>

===Bonus Disc===

Moves ''(bonus disc: Bonus Disc Title)'' from album titles to separate tags. (''bonusdisc'' and ''bonusdisctitle'').

[http://dispuut-ivv.nl/~jan/bonusdisc.py Download]
<ul><li style="list-style-type:none">This seems useful, except I'm wondering how media players like iTunes will react when there are now multiple tracks with the same track number and no disc numbers to differentiate/order the tracks. Perhaps I will modify this to set all bonus discs to disc number = 99. -[[User:AaronCooper|AaronCooper]]
<ul><li style="list-style-type:none">Using the Bonus Disc plugin as is, I added the following tagger script functions: $if(%bonusdisc%,$set(discnumber,99),) to set discnumber = 99 for bonus discs and (for iTunes to sort properly) $if(%discnumber%,,$set(discnumber,1)) to make single-disc releases have discnumber = 1. -[[User:AaronCooper|AaronCooper]]
</ul>
</ul>

===Change Encoding===

Converts the tags of individual files or clusters between different character encodings. This is often necessary with files that have only ID3v1 tags in a non-Latin encoding. You will probably only need to change the ''target'' encoding. If the encoding you're looking for isn't in the list, you can type it in yourself and it will hopefully work. Contact [[User:foolip|foolip]] with any questions.

[http://foolip.org/mb/encoding.py Download]


==Comments==
==Comments==
Line 122: Line 76:
* Just a quick request, if it can't be a built in variable... I could easily make use of a %tracklength% variable, be it built in or generated by plugin. -- [[Brian Schweitzer|BrianSchweitzer]] 07:03, 19 October 2007 (UTC)
* Just a quick request, if it can't be a built in variable... I could easily make use of a %tracklength% variable, be it built in or generated by plugin. -- [[Brian Schweitzer|BrianSchweitzer]] 07:03, 19 October 2007 (UTC)
* So, if we make any new plugins that might be interesting, is it OK to just post them here? And if so, how do we go about hosting them here if it's necessary? -- Baldrick 2007-11-12T14:39:00
* So, if we make any new plugins that might be interesting, is it OK to just post them here? And if so, how do we go about hosting them here if it's necessary? -- Baldrick 2007-11-12T14:39:00
* [[Bonus Discs|BonusDiscs]] seems useful, except I'm wondering how media players like iTunes will react when there are now multiple tracks with the same track number and no disc numbers to differentiate/order the tracks. Perhaps I will modify this to set all bonus discs to disc number = 99. -[[User:AaronCooper|AaronCooper]]
** Using the Bonus Disc plugin as is, I added the following tagger script functions: $if(%bonusdisc%,$set(discnumber,99),) to set discnumber = 99 for bonus discs and (for iTunes to sort properly) $if(%discnumber%,,$set(discnumber,1)) to make single-disc releases have discnumber = 1. -[[User:AaronCooper|AaronCooper]]


[[Category:To Be Reviewed]] [[Category:Picard]]
[[Category:To Be Reviewed]] [[Category:Picard]]

Revision as of 07:59, 17 January 2008

Plugins for Picard

To install a plugin:

  1. download .py file
  2. create new 'plugins' directory (if not existing already) under
    1. Windows: either C:\Program Files\Musicbrainz Picard\plugins (for default Picard application folder) or %USER_HOME%\Application Data\MusicBrainz\Picard\plugins
    2. *Nix: either Picard application directory or ~/.config/MusicBrainz/Picard/plugins
  1. Move downloaded .py folder to 'plugins' directory
  2. Open Picard, go to Options >> Options... >> Plugins and check the box beside the plugin to enable it.

Plugins

Name Description Author Compatibility Download Known issues/Notes
Disc Numbers Moves (disc X) from releases titles into separate tags (discnumber and discsubtitle). Lukáš Lalinský 0.9a - 0.9.0+ here -
Feat. Artists Removes (feat. Artist) parts from track titles. Lukáš Lalinský 0.9a - 0.9.0+ here -
Cover Art Downloader Downloads cover art for optional tag embedding and/or saving as a separate image file (using standard Options >> Cover Art Picard settings) Oliver Charles 0.9a - 0.9.0+ here (remove the old Amazon plugin (amazon.py, amazon.pyc & amazon.pyo) before installing this one). See 3528, 3529
Last.fm Tags Use Last.fm tags as "genre" Lukáš Lalinský 0.9a - 0.9.0+ 1 2 (copy both files to directory plugins/lastfm/)
Add Cluster As A Release Adds right click option to an unmatched cluster to allow adding releases to MB based on tags. Lukáš Lalinský 0.9a - 0.9.0+ here See 2544, 3159
Generate Cuesheet Generates a cuesheet from a release Lukáš Lalinský 0.9a - 0.9a14 here Not compatible with 0.9.0a14 or higher
Release Type Appends information to EPs and Singles such as " EP" or " (single)" (customisable, see file for details). Useful for separating releases with singles/EPs of the same name. Elliot Chance 0.9a - 0.9.0+ here This version patches a PLUGIN_API_VERSIONS problem with the original.
Search Plugins Launches searches for clusters or releases to external non-MB websites from Picard. Update: Sept 15, 2007: All search plugins have been updated to work with alpha 14. The Google plugin also has been updated to allow searching from tracks. Sept 29 update: Track names also now work in the Google search! New SoundtrackINFO search plugin also added. October 19: Added GMR plugin. November 11: Added AMG plugin. BrianFreud 0.9a - 0.9.0+ - -
All Music Guide -
Amazon Supports: .ca, .com, .de, .fr, .jp, and .co.uk
CastAlbums.org -
Discogs -
FilmMusziek.be (aka "Film Music Search")
Game Music Revolution -
Google -
The Lortel Archives (Off-Broadway cast recordings)
SoundtrackCollector.org -
SoundtrackINFO -
Bonus Disc Moves (bonus disc: Bonus Disc Title) from album titles to separate tags. (bonusdisc and bonusdisctitle) Jan van Thiel 0.9a - 0.9.0+ here -
Change Encoding Converts the tags of individual files or clusters between different character encodings. This is often necessary with files that have only ID3v1 tags in a non-Latin encoding. foolip 0.9a - 0.9.0+ here You will probably only need to change the target encoding. If the encoding you're looking for isn't in the list, you can type it in yourself and it will hopefully work.

Comments

Luks, I think there's a bug in the Disc# plugin. If you use the following in taggerscript with the plugin enabled, you get more than you'd expect...

$set(album,%album%$if(%discnumber%, \(disc %discnumber%\)))

Ought to give:    ThisIsAnAlbumTitle (disc 1)
Instead, you get: ThisIsAnAlbumTitle (disc 1) (disc 1)

DeleteWhenCooked -- BrianSchweitzer 00:13, 05 June 2007 (UTC)

  • Would it be possible to write a plugin that would fetch and set the year to the earliest release's release date when a EarliestReleaseRelationshipType exists? -AaronCooper (2007-07-11)
    • Seconded. I'd like to be able to name files like "Artist - OriginalYear - Album (releaseyear re-release|remaster)"; I like things to be sorted by original year (ie, the musical "period" of the band), but differentiate between versions (sometimes I have several). So is it possible to retrieve the metadata for a linked object?
  • Is there a reference somewhere with all the commands possible with Picard plugins (like webbrowser2.open(url, …) ? -- jesus2099 11:59, 07 August 2007 (UTC)
  • Just the existing plugins, and the source itself. -- BrianSchweitzer 19:27, 18 September 2007 (UTC)
  • Just a quick request, if it can't be a built in variable... I could easily make use of a %tracklength% variable, be it built in or generated by plugin. -- BrianSchweitzer 07:03, 19 October 2007 (UTC)
  • So, if we make any new plugins that might be interesting, is it OK to just post them here? And if so, how do we go about hosting them here if it's necessary? -- Baldrick 2007-11-12T14:39:00
  • BonusDiscs seems useful, except I'm wondering how media players like iTunes will react when there are now multiple tracks with the same track number and no disc numbers to differentiate/order the tracks. Perhaps I will modify this to set all bonus discs to disc number = 99. -AaronCooper
    • Using the Bonus Disc plugin as is, I added the following tagger script functions: $if(%bonusdisc%,$set(discnumber,99),) to set discnumber = 99 for bonus discs and (for iTunes to sort properly) $if(%discnumber%,,$set(discnumber,1)) to make single-disc releases have discnumber = 1. -AaronCooper