Hydrogenaudio Knowledgebase - User contributions [en]

Foobar2000:Components/Masstagger (foo masstag)

2006-02-03T10:45:33Z

Phi: /* Guess values from filename */

=picmixer's "The Unofficial Guide to FB's Masstagger"=

FB's masstagger tends to be quite a convenient tool when editing the information of tags in multiple files. I will first briefly list the options you have using it. Basically you can choose to either use it to edit tags or to rename files from the FB2K context menu. Here I will go into details of the first option. Although the second option should become quite self explanatory after reading this.

Basically there are several actions you can choose from to perform.

== Available actions ==

=== Add value ===
Adds desired tag field and sets it to whatever you enter in the masstagger input window.

=== Auto track number ===
This gives the track number according to the order of the files in the selection.

=== Copy value ===
Copies one tag field to another.

=== Format value from other fields ===
This is where it becomes interesting. This option lets you enter a specific formatting pattern for any tag field you wish to edit or create.

'''Note''' that when using complex formatting patterns I would recommend to first format a temporary %temp% tag with the desired pattern and then copy that one into the value that you wish. Afterwards you can remove the temp value. When processing a large batch of files you could probably just do a test run on one of the files and then do the rest in one go. Think about what you are doing beforehand though. After all I don't want to be held responsible for messing up anyones music collection.

''I will explain how to create formatting strings for different situations further down .''

=== Guess values from filename ===
Guesses values from filename and lets you enter a certain formatting pattern for it. For example if your files are named artist - album_title.

Enter
%artist% - %album%_%title%
as formatting pattern.

=== Guess values from other fields ===
Guesses values from other tags and lets you enter a certain fromatting pattern for it. For example if your files are tagged artist / title in the title field.

=== Input data (one line per track) ===
Enter the data for each song with the pattern indicated, line by line, (one line per song as it is said). Don't worry about the length, the lines could be very long (only adds a vertical scroll bar if it is too long).

=== Remove all fields ===
Removes all tag fields (who would have guessed)

=== Remove all except for... ===
Does just as it says, removes all values and lets you specify wich ones not to remove in a second field in the following pattern ie.:

%artist%;%title%;etc

=== Remove field ===
Removes desired tag field.

=== Set value ===
Sets desired tag field (artist, album,custom,etc) to whatever you enter in the masstagger input window.

=== Split multiple artist field ===
Haven't really tried out this one in depth, guess it does kind of what it says. Never really used it yet.

'''Note''' that it is possible to perform several of these actions at once and in that case the order of those actions can be very important. So removing field A before copying it to field B is probably a bad Idea and should be performed the other way around, etc.

== Writing format strings for the masstager ==

Well I guess the most powerful feature of FB"s masstager is the fact that it can use [[Foobar2000:Tagz|Tagz]] format strings. For reference to all TAGZ commands please check the titleformatting help in your Foobar preferences.

You can see that all the following samples contain %tag% and capital variables in the form of X, Y, Z. The idea is that you replace %tag% by what ever field value you would like to read from (ie,%artist%, %title%, etc. . What X,Y, Z stands for should be explained above the strings. (Well and it obviously should also be replaced by whatever fits your needs)

I can only say once more please check the titleformatting help for reference since it explains all available tag fields and commands. Instead of %tag% you could for example also use %_filename%, etc as input fields.

Allright before everyone gets bored with me blabbing on for to long I'll simply throw in those scripts. Everything starts extremely simple to give a basic idea on how everything works. After all this is basically meant for new users.

The idea is that by the end of this you can write your own little scripts easily. Or of course simply copy and paste these into the Masstager window for further editing. Just don't hold me responsible to what happens to your files.

== Masstagger Strings ==

Please make sure you rejoin scripts that have been split into multiple lines, before pasting them into the masstagger window. The reason they are split is to keep this page's formatting readable in your browser.

'''Returns corresponding tag field:'''

%tag%

'''Example:''' if artist field is blah %artist% will return blah. Note that you can insert any character (or space) in between two tags, in front or after, so if artist is blah and title is bleh
%artist%X%title%
returns blahXbleh.

'''Trunctuates %tag% to a length of X characters:'''

$cut(%tag%,X)

'''Example:''' if artist field is blah $cut(%artist%,3) returns bla

'''Truncuates %tag% by X characters and adds ... at the end of the cut.'''

$cut(%tag%,X)...
'''
Example:''' if artist field is blah $cut(%artist%,3)... returns bla...

'''Returns numerical value of %tag% and pads with 0s up to x characters'''

$num(%tag%,X)

'''Example:''' if tracknumber field is 3 $num(%tracknumber%,2) will return 03. If 13 it will return 13.

'''Returns first two characters of a filename and displays as number (if present) padded with 0s up to X characters:'''

$num($left(%_filename%),2)

'''Example:''' if filename is 03_artist_title.mpc will return 03.

'''Finds first occurence of character X in %tag% and returns everything in front of X:'''

$puts(spacer,$strchr(%tag%,X))
$trim($left(%tag%,$sub($get(spacer),1)))

'''Example:''' blah X bleh or blah X bleh X bluh returns blah (ie.: artist_album_title -----> title, in case X is _ )

'''NOTE:'''In the next few strings I have decided to make it possible to define the %tag% that should be edited and the character or string that is used to determine where to trunctuate as variables in the beginning of the string as $puts(tag,%tag%), $puts(char,X), etc. Basically the reason I have done this is to make it simpler to edit these strings, to what you exactly want them to do at the very moment, in the rather narrow masstager input field. That way it is possible to enter the needed tags and characters only once in the beginning of the line. Again simply replace %tag% and X by the desired values. Also all of these strings will trim off the trailing and leading spaces of the output (in case there are any).

'''Finds first occurence of character X in %tag% and returns everything in front of X:'''

$puts(char,X)$puts(tag,%tag%)$puts(spacer,$strchr($get(tag),$get(char)))
$trim($left($get(tag),$sub($get(spacer),1)))

'''Example:''' blah X bleh or blah X bleh X bluh returns blah (ie.: artist_album_title -----> title, in case X is _ )

'''Note:''' this does exactly the same as the last string mentioned above, except for the introdution of the two variables in the front, meant for easy editing

'''Finds last occurence of character X in %tag% and returns everything in front of X:'''

$puts(char,X)$puts(tag,%tag%)$puts(spacer,$strrchr($get(tag),$get(char)))
$trim($left($get(tag),$sub($get(spacer),1)))
'''
Example:''' blah X bleh returns blah and blah X bleh X bluh returns blah X bleh

'''Finds first occurence of character X in %tag% field and returns everything after X:'''

$puts(char,X)$puts(tag,%tag%)$puts(spacer,$strchr($get(tag),$get(char)))
$trim($right($get(tag),
$sub($len($get(tag)),$get(spacer))))

'''Example:''' blah X bleh returns bleh and blah X bleh X bluh returns bleh X bluh

'''Finds last occurence of character X in %tag% field and returns everything after X:'''

$puts(char,X)$puts(tag,%tag%)$puts(spacer,$strrchr($get(tag),$get(char)))
$trim($right($get(tag),
$sub($len($get(tag)),$get(spacer))))

'''Example:''' blah X bleh returns bleh and blah X bleh X bluh returns bluh

'''Finds first occurence of character X and last occurence of character Y and returns everything in between:'''

$puts(char1,X)$puts(char2,Y)$puts(tag,%tag%)
$puts(spacer1,$strchr($get(tag),$get(char1)))
$puts(spacer2,$strrchr($get(tag),$get(char2)))
$trim($substr($get(tag),$add($get(spacer1),1),$sub($get(spacer2),1)))

'''Example:''' blah X bleh Y bluh returns bleh

'''Note:''' that in most cases X will probably be equal to y here.

'''Finds first occurence of string XYZ and returns everything in front of string XYZ:'''

$puts(string,XYZ)$puts(tag,%tag%)$puts(spacer,$strstr($get(tag),
$get(string)))
$trim($left($get(tag),$sub($get(spacer),1)))
'''
Example:''' blah XYZ bleh returns blah

'''Note:''' that string XYZ can basically be any combination of characters or words.

'''Finds first occurence of string XYZ in %tag% field and returns everything after XYZ:'''

$puts(string,XYZ)$puts(tag,%tag%)
$puts(spacer,$strstr($get(tag),$get(string)))
$trim($right($get(tag),$sub($len($get(tag)),
$add($get(spacer),$len($get(string))))))

'''Example:''' blah XYZ bleh returns bleh

'''Extracting Information from Relative File Paths:'''

As suggested I have included a small section on how to extract different values from their relative file paths. To do so I will use the following example path to extract information from

''...\Genre\Artist\Album[Date]\01_Title.mpc''

'''sets title:'''

%_filename% returns title as 01_Title.mpc and

$puts(char,_)$puts(tag,%_filename%)
$puts(spacer,$strchr($get(tag),$get(char)))
$trim($right($get(tag),$sub($len($get(tag)),$get(spacer))))
returns title as Title.mpc

'''sets album:'''

$directory(%_path%,1) returns title as Album[Date]

$puts(char,'[')$puts(tag,$directory(%_path%,1))
$puts(spacer,$strchr($get(tag),$get(char)))
$trim($left($get(tag),$sub($get(spacer),1)))
returns album as Album

'''NOTE:''' that the [ is quotes as '[' , the reason for this is for it to be recognized as a character and not as a command syntax, you will probably have to ommit the quotation marks for most other characters.

'''sets artist:'''

$directory(%_path%,2) returns artist as Artist

'''sets genre:'''

$directory(%_path%,3) returns genre as Genre

'''
sets tracknumber:'''

$num($left(%_filename%,2),2) returns tracknumber as 01

Obviously a lot more is possible, but then this was just supposed to be a short introduction. I would say simply copy a few of your files, and play around with it.

== The Rename Files Dialog ==

The rename files dialog enables you to automatically rename your files according to your metadata tags in an automated way. You will first need to select all the tracks you want to rename and then right click and select: Masstagger/rename files.

Select in the masstagger dialog wich output directory you mant to use and wether to generate subdirectories according to the / \ characters. I will give a few examples for renaming strings below.

'''Examples:'''

To rename your files to "tracknumber_title.ext (i.e. 08_The Glass Bead Game.mpc)" you will need to enter the following syntax in the Output file name format field

%tracknumber%_%title%
No need to create subdirectories in this case.

To rename your files to "/artist - album/title.ext (i.e. Thievery Corporation - Sounds of the Thievery Hi-Fi/08_The Glass Bead Game.mpc) and create the appropriate subdirectories you will need the following syntax

/%artist% - %album%/%tracknumber%_%title%
In this case make sure the "create subdirectories" checkbox is ticked.

To rename your files to "/artist/album/tracknumber_title.ext (i.e.: /Thievery Corporation/Sounds of the Thievery Hi-Fi/08_The Glass Bead Game.mpc) use the following syntax

/%artst%/%album%/%tracknumber%_%title%

In case you generally make use of "album artist" tags (or anything similar) for various albums files you can replace %artist% with

$if2(%album artist%,%artist%)
in any of the above strings.

'''Note:'''
One reason why it is convenient to use the masstaggers rename files function is that this way Foobar2000's database will automatically get updated to the current changes.

Of course this only gives a general idea of what is possible and all kind of different filenaming schemes can be used for this.
And as usual, please don't hold me responsible in case this makes a mess out of any of your files wink.gif
In case the renamer ever does anything unexpected, don't dispair, it is usually very easy to fix with just another renaming operation.

Well, if your still with me now I guess thats quite a good sign and at least you didn't get all to bored along the way. Hope this is all somewhat comprehensible and can give people who are new to this a general idea on how things work. Concerning Foobars Masstagger at least. Any suggestions and especially critisism, corrections and add ons extremely welcome.

Oh yeah and in case you ever get bored of any of those old bad quality Kazaa files that might still be lying around on your harddisk you can

always replace %tag% by $rot13(%tag%) , mess them all up a bit and make your filenames gow all blowfish. (allright, for all humorless people, it's a joke, '''PLEASE DON'T DO THIS''', except of course if you are really bored with them)

Hmh lots of blehs and blahs, guess I should have used something a bit more creative . Otherwise I might as well have called this thread BlahBlah.

In case you find any ingenious strings or even better simple ones, I suggest everyone can simply post them in this thread.

== Original forum thread ==

This page is based on picmixer's [http://www.hydrogenaudio.org/forums/index.php?showtopic=12302|Unofficial masstagger guide] on the foobar2000 forum.

Foobar2000:Title Formatting Reference

2005-10-20T01:28:49Z

Phi: /* $stricmp(s1,s2) */

= Field remappings =

Some of the fields accessible through ''%name%'' are remapped to other values to make writing titleformat scripts more convenient.

== Metadata ==

=== %album artist% ===
Defined as ''$if3($meta(album artist),$meta(artist),$meta(composer),$meta(performer))''.

=== %album% ===
Defined as ''$if3($meta(album),$meta(venue))''.

=== %artist% ===
Defined as ''$if3($meta(artist),$meta(album artist),$meta(composer),$meta(performer))''.

=== %disc% ===
Returns the discnumber. The discnumber is taken from the discnumber tag; if that does not exist, it is taken from the disc tag. If neither exist, the field is undefined.

This is equivalent to the %discnumber% remapping.

=== %discnumber% ===
Returns the discnumber. The discnumber is taken from the discnumber tag; if that does not exist, it is taken from the disc tag. If neither exist, the field is undefined.

This is equivalent to the %disc% remapping.

=== %track artist% ===
Defined as ''$meta(artist)'', if ''$meta(album artist)'' is different than ''$meta(artist)'', otherwise this field is empty.

=== %title% ===
Defined as ''$if2($meta(title),%_filename_ext%)''. Returns the ''title'' tag if available, otherwise it returns the filename including the extension.

=== %track% ===
Returns the tracknumber padded to two digits from the left with zeroes. The tracknumber is taken from the tracknumber tag; if that does not exist, it is taken from the track tag. If neither exist, this field is undefined.

This is equivalent to the %tracknumber% remapping.

=== %tracknumber% ===
Returns the tracknumber padded to two digits from the left with zeroes. The tracknumber is taken from the tracknumber tag; if that does not exist, it is taken from the track tag. If neither exist, this field is undefined.

This is equivalent to the %track% remapping.

== Technical information ==

=== %bitrate% ===
Defined as ''$if2($info(bitrate_dynamic),$info(bitrate))''. Returns the current bitrate, if available, otherwise it returns the average bitrate. If neither is available, nothing is returned.

=== %channels% ===
Defined as ''$channels()''. Returns the number of channels in text form; returns "mono" and "stereo" instead of "1" and "2".

=== %filesize% ===
Defined as ''%_filesize%''. Returns the filesize in bytes.

=== %samplerate% ===
Defined as ''$info(samplerate)''. Returns the samplerate in Hz.

=== %codec% ===
Defined as ''$codec()''.

== Special fields ==

=== %playlist_number% ===
Defined as ''$num(%_playlist_number%,$len(%_playlist_total%))''. Returns the position of the track as index into the playlist. The first track has index 1. The index is padded from the left with zeroes to the same number of digits as the last track.

= Control flow =

The functions in this section can be used to conditionally execute statements.

=== [...] (conditional section) ===

Evaluates the expression between ''['' and '']''. If it has the truth value ''true'', its string value and the truth value ''true'' are returned. Otherwise an empty string and ''false'' are returned.

Example: ''[%artist%]'' returns the value of the artist tag, if it exists. Otherwise it returns nothing, when ''artist'' would return "?".

=== $if(cond,then) ===

If ''cond'' evaluates to ''true'', the ''then'' part is evaluated and its value returned. Otherwise, ''false'' is returned.

=== $if(cond,then,else) ===

If ''cond'' evaluates to ''true'', the ''then'' part is evaluated and its value returned. Otherwise, the ''else'' part is evaluated and its value returned.

=== $if2(a,else) ===

Like ''$if(a,a,else)'' except that ''a'' is only evaluated once.

=== $if3(a1,a2,...,aN,else) ===

Evaluates arguments ''a1'' ... ''aN'', until one is found that evaluates to ''true''. If that happens, its value is returned. Otherwise the ''else'' part is evaluated and its value returned.

=== $ifgreater(n1,n2,then,else) ===

Compares the integer numbers ''n1'' and ''n2'', if ''n1'' is greater than ''n2'', the ''then'' part is evaluated and its value returned. Otherwise the ''else'' part is evaluated and its value returned.

=== $iflonger(s1,s2,then,else) ===

Compares the length of the strings ''s1'' and ''s2'', if ''s1'' is longer than ''s2'', the ''then'' part is evaluated and its value returned. Otherwise the ''else'' part is evaluated and its value returned.

=== $select(n,a1,...,aN) ===

If the value of ''n'' is between 1 and N, ''an'' is evaluated and its value returned. Otherwise ''false'' is returned.

= Arithmetic functions =

The functions in this section can be used to perform arithmetic on integer numbers. A string will be automatically converted to a number and vice versa. The conversion to a number uses the longest prefix of the string, that can be interpreted as number. Leading whitespace is ignored.

Example: "c3po" -> 0, " -12" -> -12, but "- 12" -> 0

=== $add(a,b) ===

Adds ''a'' and ''b''.

Can be used with an arbitrary number of arguments. ''$add(a,b,...)'' is the same as ''$add($add(a,b),...)''.

=== $div(a,b) ===

Divides ''a'' through ''b''. If ''b'' evaluates to zero, it returns ''a''.

Can be used with an arbitrary number of arguments. ''$div(a,b,...)'' is the same as ''$div($div(a,b),...)''.

=== $greater(a,b) ===

Returns true, if ''a'' is greater than ''b'', otherwise false.

=== $max(a,b) ===

Returns the maximum of ''a'' and ''b''.

Can be used with an arbitrary number of arguments. ''$max(a,b,...)'' is the same as ''$max($max(a,b),...)''.

=== $min(a,b) ===

Returns the minimum of ''a'' and ''b''.

Can be used with an arbitrary number of arguments. ''$min(a,b,...)'' is the same as ''$min($min(a,b),...)''.

=== $mod(a,b) ===

Computes the remainder of dividing ''a'' through ''b''. The result has the same sign as ''a''. If ''b'' evaluates to zero, the result is ''a''.

Can be used with an arbitrary number of arguments. ''$mod(a,b,...)'' is the same as ''$mod($mod(a,b),...)''.

=== $mul(a,b) ===

Multiplies ''a'' and ''b''.

Can be used with an arbitrary number of arguments. ''$mul(a,b,...)'' is the same as ''$mul($mul(a,b),...)''.

=== $muldiv(a,b,c) ===

Multiplies ''a'' and ''b'', then divides by ''c''. The result is rounded to the nearest integer.

=== $rand() ===

Generates a random number in the range from 0 to 2<sup>32</sup>-1.

=== $sub(a,b) ===

Subtracts ''b'' from ''a''.

Can be used with an arbitrary number of arguments. ''$sub(a,b,...)'' is the same as ''$sub($sub(a,b),...)''.

= Boolean functions =

The functions in this section can be used to work with truth values (''true'' and ''false''), which have no explicit representation in titleformat scripts. They do not return a string or number value. You can use them for more complex conditions with ''$if'' and related functions.

=== $and(...) ===

Logical And of an arbitrary number of arguments. Returns ''true'', if and only if all arguments evaluate to ''true''.

Special case: ''$and(x,y)'' is ''true'', if both ''x'' and ''y'' are ''true''. Otherwise it is ''false''.

=== $or(...) ===

Logical Or of an arbitrary number of arguments. Returns ''true'', if at least one argument evaluates to ''true''.

Special case: ''$or(x,y)'' is ''true'', if ''x'' or ''y'' is ''true'', or if both are ''true''. Otherwise it is ''false''.

=== $not(x) ===

Logical Not. Returns ''false'', if ''x'' is ''true'', otherwise it returns ''true''.

=== $xor(...) ===

Logical Exclusive-or of an arbitrary number of arguments. Returns ''true'', if an odd number of arguments evaluate to ''true''.

Special case: ''$xor(x,y)'' is ''true'', if one of ''x'' and ''y'' is ''true'', but not both. Otherwise it is ''false''.

= Color functions =

=== $blend(color1,color2,part,total) ===

Returns a color that is a blend between ''color1'' and ''color2''. If ''part'' is smaller than or equal to zero, ''color1'' is returned. If ''part'' is greater than or equal to ''total'', ''color2'' is returned. Otherwise a blended color is returned that is ''part'' parts ''color1'' and ''total''-''part'' parts ''color2''. The blending is performed in the RGB color space.

=== $rgb() ===

Resets the text color to the default color.

=== $rgb(r,g,b) ===

Sets the color for text. ''r'', ''g'' and ''b'' are the red, green and blue component of the color for unselected text. The color for selected text is set to the inverse color.

=== $rgb(r1,g1,b1,r2,g2,b2) ===

Sets the color for text. ''r1'', ''g1'' and ''b1'' are the red, green and blue component of the color for unselected text. ''r2'', ''g2'' and ''b2'' are the red, green and blue component for the color of selected text.

=== $transition(string,color1,color2) ===

Inserts color codes into ''string'', so that the first character has ''color1'', the last character has ''color2'', and intermediate characters have blended colors. The blending is performed in the RGB color space. Note that color codes are additional characters that will also be counted by string manipulation functions. For example, if you need to truncate a string, you should do this before applying ''$transition''.

= Now playing info =
The following functions and fields are usable for scripts used with the currently playing item, for example the status bar, the main window title and the copy command script.

== Special fields ==

=== %_time_elapsed% ===
Returns elapsed time.

=== %_time_remaining% ===
Returns remaining time until track ends.

=== %_time_total% ===
Returns total length of track.

=== %_time_elapsed_seconds% ===
Returns elapsed time in seconds.

=== %_time_remaining_seconds% ===
Returns remaining time in seconds.

=== %_time_total_seconds% ===
Returns total track length in seconds.

=== %_ispaused% ===
Returns "1" if playback is paused and empty string otherwise.

= Playlist info =
The following functions and fields are usable for playlist scripts.

== Special fields ==

=== %isplaying% ===

Returns "1" if file is currently playing and empty string otherwise.

The old version <code>%_isplaying%</code> still works.

=== %_ispaused% ===

Returns "1" if playback is paused, empty string otherwise.

=== %_playlist_number% ===

Returns playlist index of specified item. The first item is at index 1.

Also see [[Foobar2000:Titleformat Reference#%playlist_number%|%playlist_number%]].

=== %_playlist_total% ===

Returns number of items in the playlist.

=== %playlist_name% ===

Returns the name of the playlist containing the specified item.

The old version <code>%_playlist_name%</code> still works.

= String functions =

The functions in this section can be used to manipulate character strings.

=== $abbr(x) ===

Returns abbreviation of ''x''.

=== $abbr(x,len) ===

Returns abbreviation of ''x'', if ''x'' is longer than ''len'' characters, otherwise returns ''x''.

=== $ansi(x) ===

Converts ''x'' to system codepage and back. Any characters that are not present in the system codepage will be removed / replaced. Useful for mass-renaming files to ensure compatibility with non-unicode-capable software.

=== $caps(x) ===

Converts first letter in every word of x to uppercase, and all other letters to lowercase.

=== $caps2(x) ===

Converts first letter in every word of x to uppercase, and leaves all other letters as they are.

=== $char(x) ===

Inserts Unicode character with code ''x''.

=== $crlf() ===

Inserts end-of-line marker (carriage return, line feed). Can be used to generate multiple lines in the output, for example for the tooltip of the system notification area ("systray") icon.

=== $cut(a,len) ===

Returns first ''len'' characters on the left of ''a''.

=== $directory(x) ===

Extracts directory name from the file path ''x''.

=== $directory(x,n) ===

Extracts directory name from the file path ''x''; goes up by ''n'' levels.

=== $ext(x) ===

Extracts file extension from ''x'' which must be a file name or path.

=== $filename(x) ===

Extracts file name from full path.

=== $fix_eol(x) ===

If ''x'' contains an end-of-line marker (CR-LF), the end-of-line marker and all text to the right of it is replaced by " (...)". Otherwise ''x'' is returned unaltered.

=== $fix_eol(x,indicator) ===

If ''x'' contains an end-of-line marker (CR-LF), the end-of-line marker and all text to the right of it is replaced by ''indicator''. Otherwise ''x'' is returned unaltered.

=== $hex(n) ===

Formats the integer number ''n'' in hexadecimal notation.

=== $hex(n,len) ===

Formats the integer number ''n'' in hexadecimal notation with ''len'' digits. Pads with zeros from the left if necessary.

=== $insert(a,b,n) ===

Inserts ''b'' into ''a'' after ''n'' characters.

=== $left(a,len) ===

Returns the first ''len'' characters from the left of ''a''.

=== $len(a) ===

Returns length of string ''a'' in characters.

=== $len2(a) ===

Returns length of string x in characters, respecting double-width character rules (double-width characters will be counted as two).

=== $longer(a,b) ===

Returns ''true'', if string ''a'' is longer than string ''b'', false otherwise.

=== $lower(a) ===

Converts ''a'' to lowercase.

=== $longest(a,...) ===

Returns the longest of its arguments. Can be used with an arbitrary number of strings.

=== $num(n,len) ===

Formats the integer number ''n'' in decimal notation with ''len'' digits. Pads with zeros from the left if necessary.

=== $pad(x,len) ===

Pads ''x'' from the left with spaces to ''len'' characters.

=== $pad_right(x,y) ===

Pads ''x'' from the right with spaces to ''len'' characters.

=== $pad(x,len,char) ===

Pads ''x'' from the left with ''char'' to ''len'' characters.

=== $pad_right(x,len,char) ===

Pads ''x'' from the right with ''char'' to ''len'' characters.

=== $padcut(x,len) ===

Returns first ''len'' characters from the left of ''x'', if ''x'' is longer than ''len'' characters. Otherwise pads ''x'' from the left with spaces to ''len'' characters.

=== $padcut_right(x,len) ===

Returns first ''len'' characters from the left of ''x'', if ''x'' is longer than ''len'' characters. Otherwise pads ''x'' from the right with spaces to ''len'' characters.

=== $progress(pos,range,len,a,b) ===

Creates a progress bar: ''pos'' contains position, ''range'' contains range, ''len'' progress bar length in characters, ''a'' and ''b'' are characters to build progress bar with.

Example:''$progress(%_time_elapsed_seconds%, %_time_total_seconds%, 20,'#','=')'' produces "====#===============", the # character is moving with playback position.

=== $progress2(pos,range,len,a,b) ===

Creates a progress bar: ''pos'' contains position, ''range'' contains range, ''len'' progress bar length in characters, ''a'' and ''b'' are characters to build progress bar with. Produces different appearance than ''$progress''.

=== $repeat(a,n) ===

Returns ''n'' copies of ''a''. Note that ''a'' is evaluated once before its value is used, so ''$repeat'' cannot be used for loops.

=== $replace(a,b,c) ===

Replaces all occurrences of string ''b'' in string ''a'' with string ''c''.

Can also be used with an arbitrary number of arguments. Note that ''$replace(a,b1,c1,b2,c2)'' is generally not the same as ''$replace($replace(a,b1,c1),b2,c2)''.

Example: ''$replace(ab,a,b,b,c)'' -> "bc", ''$replace($replace(ab,a,b),b,c)'' -> "cc"

=== $right(a,len) ===

Returns the first ''len'' characters from the right of ''a''.

=== $roman(n) ===

Formats the integer number ''n'' in roman notation.

=== $shortest ===

Returns the shortest of its arguments. Can be used with an arbitrary number of strings.

=== $strchr(s,c) ===

Finds first occurence of character ''c'' in string ''s''.

Example: ''$strchr(abca,a)'' -> 1

=== $strrchr(s,c) ===

Finds last occurence of character ''c'' in string ''s''.

Example: ''$strrchr(abca,a)'' -> 4

=== $strstr(s1,s2) ===

Finds first occurence of string ''s2'' in string ''s1''.

=== $strcmp(s1,s2) ===

Performs a case-sensitive comparison of the strings ''s1'' and ''s2''.

=== $stricmp(s1,s2) ===

Performs a case-insensitive comparison of the strings ''s1'' and ''s2''.

=== $substr(s,m,n) ===

Returns substring of string ''s'', starting from ''m''-th character and ending at ''n''-th character.

=== $trim(s) ===

Removes leading and trailing spaces from string ''s''.

=== $tab() ===

Inserts one tabulator character.

=== $tab(n) ===

Inserts ''n'' tabulator characters.

=== $upper(s) ===

Converts string ''s'' to uppercase.

= Track info =

The functions and fields in this section can be used to access information about tracks.

== Metadata ==

=== $meta(name) ===
Returns value of tag called ''name''. If multiple values of that tag exist, they are concatenated with ", " as separator.

Example: ''$meta(artist)'' -> "He, She, It"

=== $meta(name,n) ===
Returns value of ''n''-th tag called ''name''.

Example: ''$meta(artist,2)'' -> "She"

=== $meta_sep(name,sep) ===
Returns value of tag called ''name''. If multiple values of that tag exist, they are concatenated with ''sep'' as separator.

Example: ''$meta_sep(artist,' + ')'' -> "He + She + It"

=== $meta_sep(name,sep,lastsep) ===
Returns value of tag called ''name''. If multiple values of that tag exist, they are concatenated with ''sep'' as separator between all but the last two values which are concatenated with ''lastsep''.

Example: ''$metasep(artist,', ',', and ')'' -> "He, She, and It"

=== $meta_test(...) ===
Returns ''true'', if all given tags exist.

Example: ''$meta_test(artist,title)'' -> true

=== $meta_num(name) ===
Returns the number of values for the tag called ''name''.

Example: ''$meta_num(artist)'' -> 3

=== $tracknumber() ===
Returns the tracknumber padded to 2 digits with zeroes.

=== $tracknumber(n) ===
Returns the tracknumber padded to ''n'' digits with zeros.

== Technical information ==

=== $info(name) ===
Returns value of technical information field called ''name''.

Example: ''$info(channels)'' -> 2

=== $codec() ===
Returns codec of track. If no codec field is present, it the uses file extension.

Example: ''$codec()'' -> "WavPack"

=== $channels() ===
Returns number of channels in text format.

Example: ''$channels()'' -> "stereo"

=== %__replaygain_album_gain% ===
Returns ReplayGain album gain value. //Not available through// ''$info(replaygain_album_gain)''.

=== %__replaygain_album_peak% ===
Returns ReplayGain album peak value. //Not available through// ''$info(replaygain_album_peak)''.

=== %__replaygain_track_gain% ===
Returns ReplayGain track gain value. //Not available through// ''$info(replaygain_track_gain)''.

=== %__replaygain_track_peak% ===
Returns ReplayGain track peak value. //Not available through// ''$info(replaygain_track_peak)''.

== Special fields ==

=== $extra(name) ===
Returns the value of the special field called ''name''. These fields can also be accessed as ''%_name%''; note the additional underscore. The following field names can be used:
==== filename ====
Returns the filename without directory and extension.
==== filename_ext ====
Returns the filename with extension, but without the directory.
==== directoryname ====
Returns the name of the parent directory only, not the complete path.
==== path ====
Returns the path.
==== path_raw ====
Returns the path as URL including the protocol scheme.
==== subsong ====
Returns the subsong index. The subsong index is used to distuingish multiple tracks in a single file, for example for cue sheets, tracker modules and various container formats.
==== foobar2000_version ====
Returns a string representing the version of foobar2000.
==== length ====
Returns the length of the track formatted as hours, minutes, and seconds.
==== length_ex ====
Returns the length of the track formatted as hours, minutes, seconds, and milliseconds.
==== length_seconds ====
Returns the length of the track in seconds.
==== length_seconds_fp ====
Returns the length of the track in seconds as floating point number.
==== length_samples ====
Returns the length of the track in samples.

= Variable operations =

Variables can be used to store strings and number. They cannot store truth values. They are best used to store intermediate results that you need multiple times. Variable names are not case-sensitive.

=== $get(name) ===

Returns the value that was last stored in the variable ''name'', if the variable was not defined (yet), it returns nothing. The truth value returned by ''$get'' indicates if the variable ''name'' was defined.

=== $put(name,value) ===

Stores ''value'' in the variable ''name'' and returns ''value'' unaltered.

=== $puts(name,value) ===

Stores ''value'' in the variable ''name'' and returns only the truth value of ''value''.