Difference between revisions of "Foobar2000:Foobar2000"

From Hydrogenaudio Knowledgebase
Jump to: navigation, search
(Columns UI)
(Saving for safety: added masstagger, epg, reorganized, various edits)
Line 1: Line 1:
'''foobar2000''' is a free music player for Windows. It features multiple playlists, a music database, streaming, [[ReplayGain]] support, extensive plug-ins support and more.
+
[http://www.foobar2000.org/ '''foobar2000'''] is a free music player for Windows. It features multiple playlists, a music database, streaming, [[ReplayGain]] support, extensive plug-ins support and more.
  
  
Line 38: Line 38:
  
 
=== TAGZ ===
 
=== TAGZ ===
TAGZ is the language used to format the way information is displayed.  Thorough documentation on various TAGZ fields and functions is laid out in titleformat_help.html, which can be found in your foobar2000 directory.
+
TAGZ is the language used to format the way track information is displayed, search for tracks, edit tags using masstagger, etc.  Thorough documentation on various TAGZ fields and functions is laid out in titleformat_help.html, which can be found in your foobar2000 directory.
  
 
----
 
----
Line 47: Line 47:
 
Always remember that the best way to become comfortable with foobar is to read [http://www.hydrogenaudio.org/forums/index.php?showforum=28 the forums] regularly and to play around with foobar itself.  Download some configs (found under "Appearance" in the "External Links" section below), study how they do what they do, change them around to see how you affect things, explore the preferences window, see what happens when you check/uncheck things if you can't figure out what they mean, etc., etc.  '''90% of what you learn will come from the forums and experimentation.'''
 
Always remember that the best way to become comfortable with foobar is to read [http://www.hydrogenaudio.org/forums/index.php?showforum=28 the forums] regularly and to play around with foobar itself.  Download some configs (found under "Appearance" in the "External Links" section below), study how they do what they do, change them around to see how you affect things, explore the preferences window, see what happens when you check/uncheck things if you can't figure out what they mean, etc., etc.  '''90% of what you learn will come from the forums and experimentation.'''
  
Bookmark and try to familiarize yourself thoroughly with titleformat_help.html in your foobar directory. This contains all the TAGZ code you need to know to write your own formatting strings. It might look very strange at first, but once you see some TAGZ strings "in action" it will begin to make sense, and you will refer to it constantly.
+
Bookmark and familiarize yourself as much as possible with titleformat_help.html in your foobar directory. This contains all the TAGZ code you need to know to write your own formatting strings. It might look very strange at first, but once you see some TAGZ strings "in action" it will begin to make sense, and you will refer to it constantly.
  
 
Any question you have as a beginner has probably already been asked and answered in the forums a half dozen times. Please search the forums thoroughly for an answer before posting your question.
 
Any question you have as a beginner has probably already been asked and answered in the forums a half dozen times. Please search the forums thoroughly for an answer before posting your question.
Line 57: Line 57:
 
Bookmark these sites before using Columns UI:
 
Bookmark these sites before using Columns UI:
  
*[http://www.hydrogenaudio.org/forums/index.php?showtopic=28647 the Columns UI thread]: '''very''' large, but the first post contains links to important related sites
+
*[http://www.hydrogenaudio.org/forums/index.php?showtopic=28647 Columns UI thread]: '''very''' large, but the first post contains links to important related sites
  
 
*[http://music.everywebhost.com/wiki/doku.php?id=columns_ui:faqs Columns UI FAQ]: a short FAQ, including installation instructions
 
*[http://music.everywebhost.com/wiki/doku.php?id=columns_ui:faqs Columns UI FAQ]: a short FAQ, including installation instructions
Line 65: Line 65:
 
===== Panel Extensions =====
 
===== Panel Extensions =====
  
Installing panel extensions to Columns UI (such as [http://www.hydrogenaudio.org/forums/index.php?showtopic=29383 albumart] and [http://www.hydrogenaudio.org/forums/index.php?showtopic=29363 track info]) is simple; just copy the .dll into your foobar2000\components folder and restart foobar.  To enable these panels, first you must enable Columns UI's sidebar.  Check both "Enable sidebar" and "Show sidebar" in the "Columns UI" subgroup of the "Components" menu.  To add a panel or toolbar to the sidebar, right-click on any gray area of the sidebar for a list of items you can add.  A list of supported panels is given in [http://www.hydrogenaudio.org/forums/index.php?showtopic=28647 the Columns UI thread] of [http://www.hydrogenaudio.org/forums/index.php?showforum=28 the foobar2000 forums].
+
Installing panel extensions to Columns UI (such as [http://www.hydrogenaudio.org/forums/index.php?showtopic=29383 albumart] and [http://www.hydrogenaudio.org/forums/index.php?showtopic=29363 track info]) is simple; just copy the .dll into your foobar2000\components folder and restart foobar.  To enable these panels, first you must enable Columns UI's sidebar.  Check both "Enable sidebar" and "Show sidebar" in the "Columns UI" subgroup of the "Components" menu.  To add a panel or toolbar to the sidebar, right-click on any gray area of the sidebar for a list of items you can add.  A list of supported panels is given in the [http://www.hydrogenaudio.org/forums/index.php?showtopic=28647 Columns UI thread] of the [http://www.hydrogenaudio.org/forums/index.php?showforum=28 foobar2000 forums].
  
 
The [http://www.hydrogenaudio.org/forums/index.php?showtopic=29363 trackinfo] panel can be VERY helpful in teaching you how TAGZ strings behave. This panel updates in real-time as you edit its TAGZ-based configuration. It is recommended that you install and display this panel, using it as a "scratch pad" to help you become familiar with TAGZ.
 
The [http://www.hydrogenaudio.org/forums/index.php?showtopic=29363 trackinfo] panel can be VERY helpful in teaching you how TAGZ strings behave. This panel updates in real-time as you edit its TAGZ-based configuration. It is recommended that you install and display this panel, using it as a "scratch pad" to help you become familiar with TAGZ.
 +
 +
To see what some people have done with Columns UI and panel extensions, check out the [http://www.hydrogenaudio.org/forums/index.php?showtopic=30988 Foobar Gallery].  If you see something you like, try to do it yourself.  If you get stumped, the answer might be in the [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000&action=submit#Tips_.26_Tricks Tips & Tricks] section below.  For some ready-made Columns UI configurations go to [http://foobar.nub4life.net/columns/ this site].  Download an .fcs file, and import it from the "Other" tab in the Columns UI preferences.  Be sure to export your current config first to back it up in case you're not happy with the one you import.
 +
 +
==== Masstagger ====
 +
 +
The Masstager component is very handy when you need to edit many files' tags in the same way.
 +
 +
To edit the tags of a group of files, highlight those files in the playlist and click "Components > Masstagger."  The "Actions to perform" pane lists the actions that will be performed on the list of "Files to process" when the "Run" button is clicked.  To add an action to perform, click the "Add" button.
 +
 +
A common action to perform is to set some field to a given value.  For example, to set the GENRE tag for all selected files to "Rock," choose "Set value..." from the "Select action type" window.  In the "Field name" drop down list, choose "GENRE," and in the "Field value" box, type "Rock" (without quotes).  When you click "OK," the action will be listed in the "Actions to perform" pane.  Click "Run" to perform these actions on the selected files.
 +
 +
Before clicking "OK," you may choose to save this group of actions (this "script") for easy retrieval later.  Just type in a name for the script in the "Scripts" section below (in this case, something like "Set GENRE to 'Rock'"), and click "Save."  Later, to retrieve the saved script, select it from the drop-down menu and click "Load."
 +
 +
Realistically, this would be more easily achieved by selecting the files to be processed in the playlist, right-clicking them and choosing "Properties," then editing the GENRE field in the "File Info" window.  There are many more tag actions you can perform with Masstager, including guessing tags from filenames, and formatting tag fields based on other tag fields using TAGZ code.  Experiment with these features to learn how to use them.
 +
 +
==== The Database ====
 +
 +
The Database keeps track of all the info for all the files you play in foobar.  The Database is crucial for such things as the albumlist panel (included with Columns UI), the Extended Playlist Generator, and other components.  To enable the Database, check the "Database enabled" box in the "Database" section of Preferences.  If you would like to add an entire directory of music, enter the directory in the "Restrict directories to:" box and click the "scan" button.  Keeping this directory in the box will also prevent files in other directories from being added, so uncheck it if you will be adding files from other locations as well.  Files are also added to the Database whenever they are added to a playlist.
 +
 +
==== Extended Playlist Generator ====
 +
 +
The Extended Playlist Generator can automatically create playlists based on criteria that you specify.  The EPG requires that [http://wiki.hydrogenaudio.org/index.php?title=Foobar2000&action=submit#The_Database the Database] is enabled.  To access the EPG, click "Components > Extended Playlist Generator > Configure Playlist Query..."
 +
 +
For starters, try entering the name of an artist you know is in your database in the "Query:" box.  Click "Run."  The results will appear below.  To create a playlist with these results, enter a name for the playlist in the "Playlist Name:" box and click the "Create Playlist" button.  To save a query, click the "Save" button.  It will be saved in the presets under the "Playlist Name" you specified.  Once saved, a query can be recalled and its playlist regenerated by clicking "Components > Extended Playlist Generator > Generate Playlist..." in the menu toolbar.
 +
 +
Click the "Help" button in the EPG for help formatting queries.  Try this simple query:
 +
 +
%date% GREATER 1979
 +
 +
This query will return all songs whose DATE tag is greater than 1980.  Save this query as "The '80s, '90s, and today!"  Queries that use tag fields like this require that the tag fields exist in the first place.  Make sure your files are tagged properly if you intend to use the EPG heavily.
  
 
==== Basic TAGZ Commands ====
 
==== Basic TAGZ Commands ====
  
The text displayed in each column is given by TAGZ code. To view this code look in "Preferences > Display > Columns UI > (Columns tab)"
+
The text displayed in each column is defined by a string of TAGZ code, located in "Foobar 2000 > Preferences > Display > Columns UI > (Columns tab)"
  
 
The TAGZ code used for the "Artist" column is:
 
The TAGZ code used for the "Artist" column is:
Line 99: Line 129:
 
$if2(%title%,%_filename%)
 
$if2(%title%,%_filename%)
  
Knowing what you learned from analyzing [%artist%], and referring to titleformat_help.html, try to figure out what this TAGZ code will produce, and why it was written this way. You might also want to try creating columns that contain your own TAGZ strings.
+
Knowing what you learned from analyzing [%artist%], and referring to titleformat_help.html, try to figure out what this TAGZ code will produce, and why it was written this way. You might also want to try creating columns that contain your own TAGZ strings.  As always, titleformat_help.html is your best friend.
  
More info on the "Columns" tab of Columns UI's settings can be found on [http://music.everywebhost.com/wiki/doku.php?id=columns_ui:config:columns this page] of the Columns UI documentation.
+
More info on the "Columns" tab of Columns UI's settings can be found on [http://music.everywebhost.com/wiki/doku.php?id=columns_ui:config:columns this page] of [http://music.everywebhost.com/wiki/doku.php?id=columns_ui:documentation the Columns UI documentation].
  
==== Color Codes ====
+
==== Basic Color Codes ====
  
Click on the "Colour" tab within the "Columns" tab of the Columns UI preferences. It is empty. If you want to customize the colors used in a column, you would put the color codes here and check the "Use custom colour spec" box above. Beneath the text box you will see a six-digit number with a block character on either side of it:
+
Click on the "Colour" tab within the "Columns" tab of the Columns UI preferences. It is empty. If you want to customize the colors used in a column, you would put the color codes here and check the "Use custom colour spec" box above.
  
[]41800[]
+
Beneath the text box you will see a six-character alpha-number with a block character on either side of it:
 +
 
 +
[]0080FF[]
  
 
This is what a color code looks like. To get a color code for a specific color, click on the "..." button, which will pop-up a pallette and return the color you choose in the same gray box.
 
This is what a color code looks like. To get a color code for a specific color, click on the "..." button, which will pop-up a pallette and return the color you choose in the same gray box.
Line 121: Line 153:
 
The proper color code would then be:
 
The proper color code would then be:
  
[]0000FF[]|[]00FFFF[]|[]FFFFFF[]|[]FF0000[]
+
[]0000FF[]|[]00FFFF[]|[]FFFFFF[]|[]FF0000[]
  
 
----
 
----
Line 133: Line 165:
 
==== Placing Panels Above the Playlist ====
 
==== Placing Panels Above the Playlist ====
  
To place panels above the playlist, check "List all toolbars" in the "Other" tab of the Columns UI preferences.  When checked, clicking on the toolbar will give you the option of placing panels on the toolbar.  If a panel appears "squashed," it is because it needs to have a minimum height set in its preferences.  If the panel extension has no minimum height setting, you may place it in a [http://www.hydrogenaudio.org/forums/index.php?showtopic=28869 panel stack], and set give a minimum height via the panel stack options.
+
To place panels above the playlist, check "List all toolbars" in the "Other" tab of the Columns UI preferences.  When checked, right-clicking on the toolbar will give you the option of placing panels on the toolbar.  If a panel appears "squashed," it is because it needs to have a minimum height set in its preferences.  If the panel extension has no minimum height setting, you may place it in a [http://www.hydrogenaudio.org/forums/index.php?showtopic=28869 panel stack], and set a minimum height via the panel stack options.
  
 
==== Handy Strings ====
 
==== Handy Strings ====
  
===== Convert "The Beatles" to "Beatles, The" =====
+
===== Convert "The Band" to "Band, The" =====
  
 
$if($strcmp($left(%artist%,4),The ),$right(%artist%,$sub($len(%artist%),4))', 'The,%artist%)
 
$if($strcmp($left(%artist%,4),The ),$right(%artist%,$sub($len(%artist%),4))', 'The,%artist%)
 +
 +
===== Format %tracknumber% as 01 =====
 +
 +
$num(%tracknumber%,2)
  
 
----
 
----
Line 186: Line 222:
 
==== Components / Plugins ====
 
==== Components / Plugins ====
  
* [http://www.hydrogenaudio.org/forums/index.php?showtopic=21105 Most Sought-After Plugins]
+
* [http://www.hydrogenaudio.org/forums/index.php?showtopic=21105 Most Sought-After Plugins] (forum thread)
  
 
* [http://pelit.koillismaa.fi/plugins/ Official third-party components site]
 
* [http://pelit.koillismaa.fi/plugins/ Official third-party components site]
 +
 +
* [http://www.hydrogenaudio.org/forums/index.php?showtopic=28647 Columns UI thread]: first post contains links to many Columns UI extensions
  
 
* [http://www.saunalahti.fi/cse/html/foobar.html case's Page]: special installer, diskwriter components, etc.
 
* [http://www.saunalahti.fi/cse/html/foobar.html case's Page]: special installer, diskwriter components, etc.

Revision as of 04:00, 13 February 2005

foobar2000 is a free music player for Windows. It features multiple playlists, a music database, streaming, ReplayGain support, extensive plug-ins support and more.


Supported formats

Playback

Supported through plug-ins:

In addition, foobar2000 can also play music directly from compressed RAR, ZIP and 7-ZIP archives without requiring the user to extract the files prior to playing.


User Interface

Standard

By default foobar2000 uses the standard interface, foo_ui_standard. This interface is based around a tabbed list of playlists. Playlists are then formatted according to the title formatting strings entered by the user. These allow access to tag data, as well as information about the state of the program in the playlist display.

Columns UI

foo_ui_columns is an extension of the ideas used in the standard interface. It takes the open area of the playlist and divides it into one or more columns that have individual formatting strings. Recent versions of Columns UI have also added support for UI Extension panels which appear in Columns UI's sidebar or in the toolbar.
Some popular extension panels include (in no particular order):

  • foo_uie_tabs Tabbed Panel Stack
    Allows multiple extension panels to be added to a stack.
  • foo_uie_albumart Album Art Panel
    Displays album art from images in a specified folder.
  • foo_uie_trackinfoTrack Info Panel
    Displays information about the currently playing or selected track. Can be customised using TAGZ strings.

Because of the useful extensions to the Standard UI, Columns UI is rapidly becoming popular and continues to be under rapid development.


TAGZ

TAGZ is the language used to format the way track information is displayed, search for tracks, edit tags using masstagger, etc. Thorough documentation on various TAGZ fields and functions is laid out in titleformat_help.html, which can be found in your foobar2000 directory.


Beginner's Guide

Getting Started

Always remember that the best way to become comfortable with foobar is to read the forums regularly and to play around with foobar itself. Download some configs (found under "Appearance" in the "External Links" section below), study how they do what they do, change them around to see how you affect things, explore the preferences window, see what happens when you check/uncheck things if you can't figure out what they mean, etc., etc. 90% of what you learn will come from the forums and experimentation.

Bookmark and familiarize yourself as much as possible with titleformat_help.html in your foobar directory. This contains all the TAGZ code you need to know to write your own formatting strings. It might look very strange at first, but once you see some TAGZ strings "in action" it will begin to make sense, and you will refer to it constantly.

Any question you have as a beginner has probably already been asked and answered in the forums a half dozen times. Please search the forums thoroughly for an answer before posting your question.

Using Columns UI

It is best to start with Columns UI as your user interface; the TAGZ formatting needed is very basic and the panel plug-ins will make foobar much more user-friendly, resembling mp3 players you're more accustomed to.

Bookmark these sites before using Columns UI:

  • Columns UI thread: very large, but the first post contains links to important related sites
Panel Extensions

Installing panel extensions to Columns UI (such as albumart and track info) is simple; just copy the .dll into your foobar2000\components folder and restart foobar. To enable these panels, first you must enable Columns UI's sidebar. Check both "Enable sidebar" and "Show sidebar" in the "Columns UI" subgroup of the "Components" menu. To add a panel or toolbar to the sidebar, right-click on any gray area of the sidebar for a list of items you can add. A list of supported panels is given in the Columns UI thread of the foobar2000 forums.

The trackinfo panel can be VERY helpful in teaching you how TAGZ strings behave. This panel updates in real-time as you edit its TAGZ-based configuration. It is recommended that you install and display this panel, using it as a "scratch pad" to help you become familiar with TAGZ.

To see what some people have done with Columns UI and panel extensions, check out the Foobar Gallery. If you see something you like, try to do it yourself. If you get stumped, the answer might be in the Tips & Tricks section below. For some ready-made Columns UI configurations go to this site. Download an .fcs file, and import it from the "Other" tab in the Columns UI preferences. Be sure to export your current config first to back it up in case you're not happy with the one you import.

Masstagger

The Masstager component is very handy when you need to edit many files' tags in the same way.

To edit the tags of a group of files, highlight those files in the playlist and click "Components > Masstagger." The "Actions to perform" pane lists the actions that will be performed on the list of "Files to process" when the "Run" button is clicked. To add an action to perform, click the "Add" button.

A common action to perform is to set some field to a given value. For example, to set the GENRE tag for all selected files to "Rock," choose "Set value..." from the "Select action type" window. In the "Field name" drop down list, choose "GENRE," and in the "Field value" box, type "Rock" (without quotes). When you click "OK," the action will be listed in the "Actions to perform" pane. Click "Run" to perform these actions on the selected files.

Before clicking "OK," you may choose to save this group of actions (this "script") for easy retrieval later. Just type in a name for the script in the "Scripts" section below (in this case, something like "Set GENRE to 'Rock'"), and click "Save." Later, to retrieve the saved script, select it from the drop-down menu and click "Load."

Realistically, this would be more easily achieved by selecting the files to be processed in the playlist, right-clicking them and choosing "Properties," then editing the GENRE field in the "File Info" window. There are many more tag actions you can perform with Masstager, including guessing tags from filenames, and formatting tag fields based on other tag fields using TAGZ code. Experiment with these features to learn how to use them.

The Database

The Database keeps track of all the info for all the files you play in foobar. The Database is crucial for such things as the albumlist panel (included with Columns UI), the Extended Playlist Generator, and other components. To enable the Database, check the "Database enabled" box in the "Database" section of Preferences. If you would like to add an entire directory of music, enter the directory in the "Restrict directories to:" box and click the "scan" button. Keeping this directory in the box will also prevent files in other directories from being added, so uncheck it if you will be adding files from other locations as well. Files are also added to the Database whenever they are added to a playlist.

Extended Playlist Generator

The Extended Playlist Generator can automatically create playlists based on criteria that you specify. The EPG requires that the Database is enabled. To access the EPG, click "Components > Extended Playlist Generator > Configure Playlist Query..."

For starters, try entering the name of an artist you know is in your database in the "Query:" box. Click "Run." The results will appear below. To create a playlist with these results, enter a name for the playlist in the "Playlist Name:" box and click the "Create Playlist" button. To save a query, click the "Save" button. It will be saved in the presets under the "Playlist Name" you specified. Once saved, a query can be recalled and its playlist regenerated by clicking "Components > Extended Playlist Generator > Generate Playlist..." in the menu toolbar.

Click the "Help" button in the EPG for help formatting queries. Try this simple query:

%date% GREATER 1979

This query will return all songs whose DATE tag is greater than 1980. Save this query as "The '80s, '90s, and today!" Queries that use tag fields like this require that the tag fields exist in the first place. Make sure your files are tagged properly if you intend to use the EPG heavily.

Basic TAGZ Commands

The text displayed in each column is defined by a string of TAGZ code, located in "Foobar 2000 > Preferences > Display > Columns UI > (Columns tab)"

The TAGZ code used for the "Artist" column is:

[%artist%]

This code retrieves the ARTIST field stored in the file's tag, if it exists. Not to be confused with TAGZ, a file's "tag" contains information about its artist, album, year, etc. The name of the field is ARTIST, so to retrieve the contents of this field, %artist% is used. The brackets [ ] around %artist% mean that the ARTIST field should only be shown if it exists in the file's tag. If there is no ARTIST field, nothing will be displayed; without the brackets, a question mark would be displayed.

Some common tag fields are:

  • ARTIST
  • ALBUM
  • ALBUM ARTIST (for "Various Artists," etc.)
  • ALBUM
  • TRACKNUMBER
  • TITLE (track title)
  • DATE
  • GENRE
  • COMMENT

To see which tags are contained within a particular file, right-click on that file in the playlist and click "Properties."

Other fields, such as %__bitrate% and %_path%, are given in titleformat_help.html.

The TAGZ code used for the "Title" column is:

$if2(%title%,%_filename%)

Knowing what you learned from analyzing [%artist%], and referring to titleformat_help.html, try to figure out what this TAGZ code will produce, and why it was written this way. You might also want to try creating columns that contain your own TAGZ strings. As always, titleformat_help.html is your best friend.

More info on the "Columns" tab of Columns UI's settings can be found on this page of the Columns UI documentation.

Basic Color Codes

Click on the "Colour" tab within the "Columns" tab of the Columns UI preferences. It is empty. If you want to customize the colors used in a column, you would put the color codes here and check the "Use custom colour spec" box above.

Beneath the text box you will see a six-character alpha-number with a block character on either side of it:

[]0080FF[]

This is what a color code looks like. To get a color code for a specific color, click on the "..." button, which will pop-up a pallette and return the color you choose in the same gray box.

The way you format colors is given by clicking the "Tools" button, then by clicking "String help." Concentrate on the first four items, which are required in every color code string:

text|selected text|background|selected background

For example, if I wanted my "Artist" column to display red text on white background when not selected, and yellow text on blue background when selected, I would use this format:

(red color code)|(yellow color code)|(white color code)|(blue color code)

The proper color code would then be:

[]0000FF[]|[]00FFFF[]|[]FFFFFF[]|[]FF0000[]


Advanced Use


Tips & Tricks

Placing Panels Above the Playlist

To place panels above the playlist, check "List all toolbars" in the "Other" tab of the Columns UI preferences. When checked, right-clicking on the toolbar will give you the option of placing panels on the toolbar. If a panel appears "squashed," it is because it needs to have a minimum height set in its preferences. If the panel extension has no minimum height setting, you may place it in a panel stack, and set a minimum height via the panel stack options.

Handy Strings

Convert "The Band" to "Band, The"

$if($strcmp($left(%artist%,4),The ),$right(%artist%,$sub($len(%artist%),4))', 'The,%artist%)

Format %tracknumber% as 01

$num(%tracknumber%,2)


Supported languages

  • English

Supported platforms

  • Windows

No known plans exists to port it to other platforms, but attempts have been made, with varying degrees of success, to run foobar2000 on x86 Linux systems by using Wine.


Guides


External links

Official Site

Community

Appearance

Components / Plugins

  • case's Page: special installer, diskwriter components, etc.
  • kode's Page: components: file-formats, archive-support, OSD, shuffle (temporary mirror since the above host is down)
  • Messer's page: components: freedb-masstagger, streaming with save-function, etc.
  • Musicmusic's Page: components: textwriter, quicktag, custom sort, ui_columns, panels