Difference between revisions of "MusicBrainz Picard/Tags"

From MusicBrainz Wiki
m
(Make tag / variable list comprehensive)
Line 1: Line 1:
==Basic Tags==
+
This page describes both Tags (which are saved inside your music files and can be read by your music player) and Picard variables which can be used in Picard scripts (for tagging, for file renaming and in several other more minor settings).
  
These tags are available for most releases from MusicBrainz, with the default Picard settings.
+
All tags are also available as variables, but additional variables which start with '_' are not saved as Tags within your music files.
  
Tags beginning with an '_' are not mapped to any media header tags by default, but are available for scripts and plugins to use.
+
Variable are used in scripts by wrapping the name between '%' character e.g. '%title%'.
 +
 
 +
Some variables can contain more than one value (for example, <tt>musicbrainz_artistid</tt>), and if you want to use only one of the values then you will need to use special [[Picard Scripting|script functions]] to access / set them. To access all the multiple values at one, use the variable normally and Picard will combine them into a single string separated by <code>; </code>.
 +
 
 +
 
 +
== Basic Tags ==
 +
The following tags are populated from MusicBrainz data for most releases, without any special Picard settings.
 +
 
 +
All of these are also available as variables for use in Picard Scripts (for tagging, for file renaming and in several other more minor settings) by wrapping them between '%' symbols e.g. '%title%'.
  
 
{|
 
{|
Line 9: Line 17:
 
|  title  ||  [[Track Title]]
 
|  title  ||  [[Track Title]]
 
|-
 
|-
| _recordingcomment || [[Recording]] Comment
+
| artist  || [[Artist Name]]
 
|-
 
|-
artist ||  [[Artist Name]]  
+
artistsort ||  [[Artist Sort Name]]
 
|-
 
|-
artistsort ||  [[Artist Sort Name]]  
+
albumartist ||  [[Release Artist]]
 
|-
 
|-
albumartist ||  [[Release Artist]]  
+
albumartistsort ||  [[Release Artist]]'s [[Artist Sort Name|Sort Name]]
 
|-
 
|-
albumartistsort ||  [[Release Artist]]'s [[Artist Sort Name|Sort Name]]  
+
releasestatus ||  [[Release Status]]
 
|-
 
|-
releasestatus ||  [[Release Status]]  
+
releasetype ||  [[Release Type]]
 
|-
 
|-
releasetype ||  [[Release Type]]  
+
album ||  [[Release Title]]
 
|-
 
|-
album ||  [[Release Title]]  
+
asin ||  [[ASIN]]
 
|-
 
|-
asin ||  [[ASIN]]  
+
language ||  Track language as per [http://www.sil.org/iso639-3 ISO 639-3] - taken from the work lyrics language (if track relationships are enabled and a related work exists) otherwise taken from the [[Release_Language#Language_and_script|release language]].  (since Picard 0.10)
 
|-
 
|-
|  language  ||  [[Release_Language#Language_and_script|Release Language]]
+
|  script  ||  [[Release_Language#Language_and_script|Release Script]] (since Picard 0.10)
|-
 
|  script  ||  [[Release_Language#Language_and_script|Release Script]]
 
 
|-
 
|-
 
|  date  ||  [[Release Date]] (YYYY-MM-DD)
 
|  date  ||  [[Release Date]] (YYYY-MM-DD)
 
|-
 
|-
|  originaldate  ||  Original [[Release Date]] (YYYY-MM-DD) (since 0.15, from earliest release in [[Release Group]])
+
|  originaldate  ||  Original [[Release Date]] (YYYY-MM-DD) from earliest release in [[Release Group]] (included in Picard as standard since version 0.15, available using the Original Release Date plugin if you are !!still!! using a non-NGS version of Picard before version 0.15)
 
|-
 
|-
tracknumber ||  Track number
+
discnumber ||  [[Disc Number|DiscNumber]]
 
|-
 
|-
totaltracks ||  Total tracks on the medium/disc
+
totaldiscs ||  Total number of discs of this release
 
|-
 
|-
discnumber ||  [[Disc Number|DiscNumber]]
+
discsubtitle ||  Where an album's discs have been given their own title, this contains the disc title.
 
|-
 
|-
totaldiscs ||  Total number of discs of this release
+
tracknumber ||  Track number
 
|-
 
|-
discsubtitle ||  [[Disc Number Style|DiscNumberStyle]]
+
totaltracks ||  Total tracks on this medium/disc
|-
 
|  _releasecomment  ||  [[Release]] Comment
 
 
|-
 
|-
 
|  releasecountry  ||  [[Release Country]]
 
|  releasecountry  ||  [[Release Country]]
 
|-
 
|-
|  catalognumber  ||  [[Release Catalog Number]]  
+
|  catalognumber  ||  [[Release Catalog Number]]
 
|-
 
|-
 
|  barcode  ||  [[Barcode]]
 
|  barcode  ||  [[Barcode]]
 
|-
 
|-
|  label  ||  [[Label Name]]  
+
|  label  ||  [[Label Name]]
 
|-
 
|-
|  media  ||  [[Release Format]]  
+
|  media  ||  [[Release Format]]
 
|-
 
|-
|  compilation  ||  0 for single artist albums, 1 for multiple artist albums 
+
|  compilation  ||  (since Picard 1.3 compatible with iTunes) 1 for Various Artist albums, 0 otherwise
 +
(Picard 1.2 or previous) 1 if multiple track artists (including featured artists), 0 otherwise
 
|-
 
|-
|  musicbrainz_trackid  ||  [[Track ID]]  
+
|  musicbrainz_trackid  ||  [[Track ID]]
 
|-
 
|-
|  musicbrainz_artistid  ||  [[Artist ID]]  
+
|  musicbrainz_artistid  ||  [[Artist ID]]
 
|-
 
|-
 
|  musicbrainz_albumid  ||  [[Release ID]]  
 
|  musicbrainz_albumid  ||  [[Release ID]]  
 
|-
 
|-
|  musicbrainz_albumartistid  ||  [[Release Artist]]'s [[Artist ID]]  
+
|  musicbrainz_albumartistid  ||  [[Release Artist]]'s [[Artist ID]]
 +
|-
 +
|  musicbrainz_discid  ||  [[Disc ID]] if album added using CD Lookup (since Picard 0.12)
 +
|-
 +
|  isrc || [[ISRC]] (since Picard 0.12)
 +
|-
 +
|  work || [[ISRC]] (since Picard 1.3)
 +
|
 +
|}
 +
 
 +
== Basic Variables ==
 +
These variables are also populated from MusicBrainz data for most releases, without any special Picard settings.
 +
 
 +
{|
 +
|-
 +
|  _totalalbumtracks || The total number of tracks across all discs of this release.
 +
|-
 +
|  _recordingtitle || [[Recording]] title - normally the same as the Track title, but can be different.
 +
|-
 +
|  _recordingcomment || [[Recording]] disambiguation comment (since Picard 0.15)
 +
|-
 +
|  _releasecomment  ||  [[Release]] Disambiguation comment (since Picard 0.15)
 +
|-
 +
|  _releaselanguage  ||  [[Release_Language#Language_and_script|Release Language]] as per [http://www.sil.org/iso639-3 ISO 639-3] (since Picard 0.10)
 +
|-
 +
|  _releasegroup  ||  [[Release_Group#Title|Release Group Title]] which is typically the same as the Album Title, but can be different.
 +
|-
 +
|  _releasegroupcomment  ||  [[Release_Group#Disambiguation_comment|Release Group disambiguation comment]].
 +
|-
 +
|  _primaryreleasetype  ||  One [[Release_Group/Type#Primary_types|Release Group Primary type]] i.e. Album, Single, EP, Broadcast, Other.
 +
|-
 +
|  _secondaryreleasetype  ||  Zero or more [[Release_Group/Type#Secondary_types|Release Group Secondary types]] i.e. Audiobook, Compilation, DJ-mix, Interview, Live, Mixtape/Street, Remix, Soundtrack, Spokenword
 +
|-
 +
|  _rating  ||  [[Rating System|Rating]] 0-5 by Musicbrainz users
 
|-
 
|-
| isrc || [[ISRC]]
+
| _dirname || The name of the directory the file is in at the point of being loaded into Picard. (Since Picard 1.1)
 
|-
 
|-
| _dirname || The name of the directory the file is in at the point of being loaded into Picard. (Since Picard 1.1)
+
| _filename|| The name of the file without extension (since Picard 1.1)
 
|-
 
|-
| _filename|| The name of the file without extension (Since Picard 1.1)
+
| _extension || The files extension (since Picard 0.9)
 
|-
 
|-
| _extension || The files extension (Since Picard 1.1)
+
| _format || Media format of the file e.g. <code>MPEG-1 Audio</code>
 +
|-
 +
|  _bitrate || Approximate bitrate in kbps.
 +
|-
 +
|  _channels || No. of audio channels in the file (.wav only)
 +
|-
 +
|  _sample_rate || Number of digitising samples per second Hz (.wav only)
 +
|-
 +
|  _bits_per_sample || Bits of data per sample (.wav only)
 +
|-
 +
|  _multiartist || 0 if tracks on the album all have the same primary artist, 1 otherwise.
 +
|-
 +
|  _length || The length of the track in format mins:secs.
 
|  
 
|  
 
|}
 
|}
  
 
+
== Advanced Tags ==
 
If you enable tagging with [[Advanced Relationship]]s, you get these extra tags:  
 
If you enable tagging with [[Advanced Relationship]]s, you get these extra tags:  
 
{|
 
{|
 
|-
 
|-
|  writer  ||  [[rt:a255bca1-b157-4518-9108-7b147dc3fc68|Writer Relationship Type]] (since Picard 1.0; not written to most file formats automatically<ref>You can merge this with composers with a [[Picard Scripting|script]] like <pre>$copymerge(composer, writer)</pre></ref>)
+
|  writer  ||  [[rt:a255bca1-b157-4518-9108-7b147dc3fc68|Writer Relationship Type]] (since Picard 1.0; not written to most file formats automatically<ref>You can merge this with composers with a [[Picard Scripting|script]] like <pre>$copymerge(composer, writer)</pre></ref>).
 
|-
 
|-
 
|  composer  ||  [[rt:d59d99ea-23d4-4a80-b066-edca32ee158f|Composer Relationship Type]]  
 
|  composer  ||  [[rt:d59d99ea-23d4-4a80-b066-edca32ee158f|Composer Relationship Type]]  
Line 89: Line 139:
 
|  performer:<type>  ||  Performer Relationship Type ([[rt:888a2320-52e4-4fe8-a8a0-7a4c8dfde167|releases]] - [[rt:eb10f8a0-0f4c-4dce-aa47-87bcb2bc42f3|vocals]]/[[rt:67555849-61e5-455b-96e3-29733f0115f5|instruments]], [[rt:628a9658-f54c-4142-b0c0-95f031b544da|recordings]] - [[rt:0fdbe3c6-7700-4a31-ae54-b53f06ae1cfa|vocals]]/[[rt:59054b12-01ac-43ee-a618-285fd397e461|instruments]]), Orchestra Relationship Type ([[rt:23a2e2e7-81ca-4865-8d05-2243848a77bf|releases]], [[rt:3b6616c5-88ba-4341-b4ee-81ce1e6d7ebb|recordings]]), <type> can be "orchestra", "vocal", "guest guitar", ...  
 
|  performer:<type>  ||  Performer Relationship Type ([[rt:888a2320-52e4-4fe8-a8a0-7a4c8dfde167|releases]] - [[rt:eb10f8a0-0f4c-4dce-aa47-87bcb2bc42f3|vocals]]/[[rt:67555849-61e5-455b-96e3-29733f0115f5|instruments]], [[rt:628a9658-f54c-4142-b0c0-95f031b544da|recordings]] - [[rt:0fdbe3c6-7700-4a31-ae54-b53f06ae1cfa|vocals]]/[[rt:59054b12-01ac-43ee-a618-285fd397e461|instruments]]), Orchestra Relationship Type ([[rt:23a2e2e7-81ca-4865-8d05-2243848a77bf|releases]], [[rt:3b6616c5-88ba-4341-b4ee-81ce1e6d7ebb|recordings]]), <type> can be "orchestra", "vocal", "guest guitar", ...  
 
|-
 
|-
|  arranger  ||  [[Arranger Relationship Type]], [[Instrumentator Relationship Type]], [[Orchestrator Relationship Type]]   
+
|  arranger  ||  [[Arranger Relationship Type]], [[Instrumentator Relationship Type]], [[Orchestrator Relationship Type]] (since Picard 0.10)  
 
|-
 
|-
 
|  lyricist  ||  [[Lyricist Relationship Type]]  
 
|  lyricist  ||  [[Lyricist Relationship Type]]  
Line 99: Line 149:
 
|  engineer  ||  [[Engineer Relationship Type]]  
 
|  engineer  ||  [[Engineer Relationship Type]]  
 
|-
 
|-
|  mixer  ||  [[Engineer Relationship Type]] ("Mixed By")
+
|  mixer  ||  [[Engineer Relationship Type]] ("Mixed By") (since Picard 0.9)
 
|-
 
|-
|  djmixer  ||  [[Mix-DJ Relationship Type]]  
+
|  djmixer  ||  [[Mix-DJ Relationship Type]] (since Picard 0.9)
 
|-
 
|-
 
|  license  ||  License Relationship Type ([[rt:004bd0c3-8a45-4309-ba52-fa99f3aa3d50|releases]], [[rt:f25e301d-b87b-4561-86a0-5d2df6d26c0a|recordings]]) (since Picard 1.0)
 
|  license  ||  License Relationship Type ([[rt:004bd0c3-8a45-4309-ba52-fa99f3aa3d50|releases]], [[rt:f25e301d-b87b-4561-86a0-5d2df6d26c0a|recordings]]) (since Picard 1.0)
Line 110: Line 160:
 
|-
 
|-
 
|  genre  ||  Pseudo-genre based on folksonomy tags  
 
|  genre  ||  Pseudo-genre based on folksonomy tags  
 +
|}
 +
 +
== Advanced Variables ==
 +
If you enable tagging with [[Advanced Relationship]]s, you get these extra variables:
 +
 +
{|
 +
|-
 +
|  _recordingtitle || [[Recording]] title - normally the same as the Track title, but can be different.
 +
|-
 +
|  _recordingcomment || [[Recording]] disambiguation comment (since Picard 0.15)
 +
|
 
|}
 
|}
  
Line 123: Line 184:
 
|}
 
|}
  
===Original Release Date (Pre-NGS plugin) ===
+
===Last.fm Plus===
 +
 
  
{|
 
|-
 
|  originaldate  ||  The original release date (pre-[[NGS]], from "earliest release" advanced relationships)
 
|}
 
  
 
==Other Information==
 
==Other Information==
Line 134: Line 192:
 
For technical details on how these tags are written into files, see [[Picard Tag Mapping]].
 
For technical details on how these tags are written into files, see [[Picard Tag Mapping]].
  
For tags that can contain more than one value (for example, <tt>musicbrainz_artistid</tt>) the values are separated by <code>; </code>
+
For ID3 based tags i.e. mp3 files, you can set ID3 tags directly from your scripts by setting a special variable starting '_id3:'. Currently only ID3 comment (TXXX) frames are supported using '%_id3:TXXX:<description>%', for example <code>$copy(_id3:TXXX:PERFORMERSORTORDER,artistsort)</code>. (Since Picard 0.9)
  
 
==Footnotes==
 
==Footnotes==

Revision as of 14:57, 6 March 2014

This page describes both Tags (which are saved inside your music files and can be read by your music player) and Picard variables which can be used in Picard scripts (for tagging, for file renaming and in several other more minor settings).

All tags are also available as variables, but additional variables which start with '_' are not saved as Tags within your music files.

Variable are used in scripts by wrapping the name between '%' character e.g. '%title%'.

Some variables can contain more than one value (for example, musicbrainz_artistid), and if you want to use only one of the values then you will need to use special script functions to access / set them. To access all the multiple values at one, use the variable normally and Picard will combine them into a single string separated by ; .


Basic Tags

The following tags are populated from MusicBrainz data for most releases, without any special Picard settings.

All of these are also available as variables for use in Picard Scripts (for tagging, for file renaming and in several other more minor settings) by wrapping them between '%' symbols e.g. '%title%'.

title Track Title
artist Artist Name
artistsort Artist Sort Name
albumartist Release Artist
albumartistsort Release Artist's Sort Name
releasestatus Release Status
releasetype Release Type
album Release Title
asin ASIN
language Track language as per ISO 639-3 - taken from the work lyrics language (if track relationships are enabled and a related work exists) otherwise taken from the release language. (since Picard 0.10)
script Release Script (since Picard 0.10)
date Release Date (YYYY-MM-DD)
originaldate Original Release Date (YYYY-MM-DD) from earliest release in Release Group (included in Picard as standard since version 0.15, available using the Original Release Date plugin if you are !!still!! using a non-NGS version of Picard before version 0.15)
discnumber DiscNumber
totaldiscs Total number of discs of this release
discsubtitle Where an album's discs have been given their own title, this contains the disc title.
tracknumber Track number
totaltracks Total tracks on this medium/disc
releasecountry Release Country
catalognumber Release Catalog Number
barcode Barcode
label Label Name
media Release Format
compilation (since Picard 1.3 compatible with iTunes) 1 for Various Artist albums, 0 otherwise

(Picard 1.2 or previous) 1 if multiple track artists (including featured artists), 0 otherwise

musicbrainz_trackid Track ID
musicbrainz_artistid Artist ID
musicbrainz_albumid Release ID
musicbrainz_albumartistid Release Artist's Artist ID
musicbrainz_discid Disc ID if album added using CD Lookup (since Picard 0.12)
isrc ISRC (since Picard 0.12)
work ISRC (since Picard 1.3)

Basic Variables

These variables are also populated from MusicBrainz data for most releases, without any special Picard settings.

_totalalbumtracks The total number of tracks across all discs of this release.
_recordingtitle Recording title - normally the same as the Track title, but can be different.
_recordingcomment Recording disambiguation comment (since Picard 0.15)
_releasecomment Release Disambiguation comment (since Picard 0.15)
_releaselanguage Release Language as per ISO 639-3 (since Picard 0.10)
_releasegroup Release Group Title which is typically the same as the Album Title, but can be different.
_releasegroupcomment Release Group disambiguation comment.
_primaryreleasetype One Release Group Primary type i.e. Album, Single, EP, Broadcast, Other.
_secondaryreleasetype Zero or more Release Group Secondary types i.e. Audiobook, Compilation, DJ-mix, Interview, Live, Mixtape/Street, Remix, Soundtrack, Spokenword
_rating Rating 0-5 by Musicbrainz users
_dirname The name of the directory the file is in at the point of being loaded into Picard. (Since Picard 1.1)
_filename The name of the file without extension (since Picard 1.1)
_extension The files extension (since Picard 0.9)
_format Media format of the file e.g. MPEG-1 Audio
_bitrate Approximate bitrate in kbps.
_channels No. of audio channels in the file (.wav only)
_sample_rate Number of digitising samples per second Hz (.wav only)
_bits_per_sample Bits of data per sample (.wav only)
_multiartist 0 if tracks on the album all have the same primary artist, 1 otherwise.
_length The length of the track in format mins:secs.

Advanced Tags

If you enable tagging with Advanced Relationships, you get these extra tags:

writer Writer Relationship Type (since Picard 1.0; not written to most file formats automatically[1]).
composer Composer Relationship Type
conductor Conductor Relationship Type (releases, recordings), Chorus Master Relationship Type (releases, recordings)
performer:<type> Performer Relationship Type (releases - vocals/instruments, recordings - vocals/instruments), Orchestra Relationship Type (releases, recordings), <type> can be "orchestra", "vocal", "guest guitar", ...
arranger Arranger Relationship Type, Instrumentator Relationship Type, Orchestrator Relationship Type (since Picard 0.10)
lyricist Lyricist Relationship Type
remixer Remixer Relationship Type
producer Producer Relationship Type
engineer Engineer Relationship Type
mixer Engineer Relationship Type ("Mixed By") (since Picard 0.9)
djmixer Mix-DJ Relationship Type (since Picard 0.9)
license License Relationship Type (releases, recordings) (since Picard 1.0)

And if you enable folksonomy tags, you get:

genre Pseudo-genre based on folksonomy tags

Advanced Variables

If you enable tagging with Advanced Relationships, you get these extra variables:

_recordingtitle Recording title - normally the same as the Track title, but can be different.
_recordingcomment Recording disambiguation comment (since Picard 0.15)

Plugins

Plugins from Picard Plugins can add more tags.

Last.fm

genre Pseudo-genre based on folksonomy tags

Last.fm Plus

Other Information

For technical details on how these tags are written into files, see Picard Tag Mapping.

For ID3 based tags i.e. mp3 files, you can set ID3 tags directly from your scripts by setting a special variable starting '_id3:'. Currently only ID3 comment (TXXX) frames are supported using '%_id3:TXXX:<description>%', for example $copy(_id3:TXXX:PERFORMERSORTORDER,artistsort). (Since Picard 0.9)

Footnotes

  1. You can merge this with composers with a script like
    $copymerge(composer, writer)