Hydrogenaudio Knowledgebase - User contributions [en]

TAK

2008-01-07T09:30:40Z

RasqualTwilight: /* TAK with foobar2000 */ Mention pipe encoding syntax

{{Codec Infobox
| name = Tom's lossless Audio Kompressor
| logo =
| type = lossless
| purpose = lossless audio compression.
| maintainer = Thomas Becker
| recommended_encoder = TAK encoder
| recommended_text = TAK v1.0.3
| website = [http://thbeck.de/Tak/Tak.html ThBeck.de/Tak/Tak.html] ''(german)''
}}

== Description ==
'''Tom's lossless Audio Kompressor''' ('''TAK''') is a lossless audio compressor which promises compression performance similar to [[Monkey's Audio]] “High” and decompression speed similar to [[Free Lossless Audio Codec|FLAC]].

=== Features ===
* High compression
* Fast compression and decompression speed
* Streaming support (necessary headers for decompressing the audio are written to the stream every 2 seconds)
* Piping support for encoding
* Error tolerance (single bit error will never affect more than 250 ms)
* Error detection (each frame protected by a 24-bit checksum (CRC))

=== Pros ===
* Fast encoding speed (while providing better compression TAK encodes as fast as [[Free Lossless Audio Codec|FLAC]] -8 in TAK's “Insane” and several times faster in “Turbo” mode)
* Fast decompression speed (on par with FLAC / [[WavPack]])
* Good compression levels (on par with [[Monkey's Audio]] High)
* Error Robustness
* Fast Seeking

=== Cons ===
* Closed Source (at the moment)
* No hardware support
* Very limited software support (playback: [[Winamp]] & [[foobar2000]] plugins, tagging: Mp3Tag)

== Hardware and Software That Support TAK ==
=== Hardware ===
* None

=== Software ===
==== Windows ====
* TAK SDK 1.0.5 – Software Development Kit for TAK [http://www.hydrogenaudio.org/forums/index.php?showtopic=54159 here]
* Winamp Plugin 1.0.7 [http://www.hydrogenaudio.org/forums/index.php?showtopic=54159 here]
* foo_input_tak, TAK decoder for [[foobar2000]] [http://www.hydrogenaudio.org/forums/index.php?showtopic=54087 here] (supports tagging and [[Replay Gain]])
* [[Mp3tag]] – universal tag editor with support for TAK
* shntool (since version 3.0.6)

==== Linux ====
* The TAK reference applications (GUI as well as commandline) are known to run on Linux via Wine.

== Recommended Settings ==
* Default compression: “-p2” (formerly ''Normal'') is the most attractive setting, providing an excellent compromise between compression and encoding speed. (At compression levels close to [[Monkey's Audio]] High (<0.4% difference), it is able to encode more quickly.)
takc -e [input file]
* Highest compression: “-pMax” (same as -p5m) (This will create files which are comparable in size to file created using [[Monkey's Audio]] High. Decompression speed is comparable to [[WavPack]] Normal.)
takc -e -pMax [input file]
* Fastest compression: “-p0” (This will create files which are comparable in size to [[Monkey's Audio]] Fast or [[WavPack]] High. Decompression speed is comparable to [[Free Lossless Audio Codec|FLAC]] 0.)
takc -e -p0 [input file]

=== TAK Performance Graph ===
[[Image:TAK_performance_graph.png|frame|center|Graph showing encoding and decoding rate against compression, using data from Synthetic Soul's test on TAK 1.0.1 (see [[TAK#External Links|External Links]])]]

== Using TAK ==
=== TAK with [[foobar2000]] ===
* Copy the takc.exe to your [[foobar2000]] directory
* Go to File → Preferences → Tools → Converter
* Set it up as shown:
:'''Note''': as of TAK 1.0.3, the encoder supports pipe encoding, eliminating the need for a temporary file and greatly improving overall compression time. Use the following command line: <code>-e -p4 -ihs - %d</code> instead.
[[Image:tak.PNG|frame|center|TAK Encoder with foobar]]
'''Note:''' replace the -p4 with the desired compression level.

* Use [[APEv2 specification|APEv2]] tagging (will be used as internal tagging)

=== TAK with EAC ===
Please read the [[EAC and TAK|wiki guide]], which details how to create TAK files with [[Exact Audio Copy|EAC]].

== Future Features ==
* Unicode support
* MD5 audio checksums for verification and identification
* A German version
* Embedded cue sheets
* Embedded cover art
* Multichannel audio

== Frequently Asked Questions ==
; Is the codec safe for use?
: Yes. To check, convert a WAVE to TAK and back and compare the two (or use foobar's bitcompare tool).
; Why should I use TAK?
: TAK offers high compression ratios with great decoding rates.
; What can I compress with TAK?
: TAK 1.0 can compress any integer-format (up to 24 bits per channel) PCM RIFF WAVE file (.wav). Piping support as of v1.0.3 is implemented, so converting lossless files to WAV first is not necessary.
; What about hardware support?
: None at the moment. Although, ''-p0 (Turbo)'', ''-p1 (Fast)'' and ''-p2 (Normal)'' are the candidates for hardware playback.
; When will the source be opened?
: Yes, TAK will be open-source, as soon as the code is ported to C or C++ and documented. However, Thomas has mentioned that he would like to improve the codec before opening the source.

== External Links ==
* [http://thbeck.de/Tak/Tak.html thbeck.de/Tak/Tak.html] – Official Website ''(german)''
* [http://www.hydrogenaudio.org/forums/index.php?showtopic=54160 TAK Release Announcement / Discussion Thread on HA] ''(english)''
* [http://www.hydrogenaudio.org/forums/index.php?showtopic=54159 TAK Downloads]
* [http://synthetic-soul.co.uk/comparison/lossless/ synthetic-soul.co.uk/comparison/lossless] – Comparison with Other Codecs (by Synthetic Soul)
* [http://flac.sourceforge.net/comparison.html flac.sourceforge.net/comparison.html] – An Updated Comparison (from FLAC Homepage)

[[Category:Lossless]]
[[Category:Encoder/Decoder]]

Average Bitrate

2007-07-31T11:42:56Z

RasqualTwilight: /* References */ correct page urls

'''Average Bitrate''' ('''ABR''') encoding is the LAME developers' name for any method of producing a Variable Bitrate ([[VBR]]) MP3 in which the encoder selects the [[bitrate]] for each frame based solely on a fixed set of metrics, in an effort to produce a file with an average bitrate that is near a target bitrate chosen by the user. In many encoders, ABR is the normal method of producing VBR MP3s, but it is not the default method in LAME.

Essentially, when using an ABR method, the encoder makes an educated guess at the optimum bitrate for each frame based on an analysis of the original audio and the application of a fixed algorithm. In contrast, more aggressive VBR encoding methods, such as LAME's normal VBR method, will try out different bitrates in an effort to find the lowest one that will produce ''decoded'' audio with an acceptable quality as measured by comparing quantization noise and applying additional psychoacoustic models.

The majority of frames in a VBR MP3 produced with an ABR method is normally at or near the target bitrate chosen by the user, but each frame can still potentially vary within the normal range of 8 to 320 kbps. The ABR encoder will typically limit the range of bitrates it can choose from, or will greatly favor certain bitrates, in an effort to ensure that the average comes out near the target.

The aggressive, non-ABR method of producing VBR MP3s (as implemented in LAME, at least) requires the user to choose a minimum and maximum bitrate. Therefore, another method of producing VBR files close to an average bitrate would be to simply select a minimum and maximum within a narrow range; the bounds could even be the same bitrate, which would result in a constant-bitrate VBR file. However, this technique would not constitute "ABR" encoding, by LAME's definition.

== Who should use ABR ==
ABR encoding is desirable for users who want the general benefits of VBR (an optimum bitrate from frame to frame) but with a relatively predictable file size like they would get with constant bitrate ([[CBR]]), and a greater preference for bitrates that are near a desired target. Inevitably, some frames will be encoded with more bits than necessary, but the result will always be equal to or better than that of CBR for the target bitrate.

Depending on the complexity of the audio and the algorithms applied, ABR-encoded frames may sometimes exceed the quality that would be produced with a more aggressive VBR encoding method, since the ABR method is less conservative about bit allocation. However, having more bits ''available'' in a frame does not necessarily mean they're all ''used'' by that frame, so the quality of ABR is not necessarily better than that of regular VBR, and both methods still have a margin of error.

In general, though, it is safe to say that given the same input, a VBR MP3 encoded using ABR will be of equal or higher quality than a CBR MP3 of the same bitrate, and will be of equal or lower quality than a non-ABR VBR MP3 of the same file size.

Therefore, hydrogenaudio forum members recommend that '''for maximum audio quality at a given average bitrate, a VBR MP3 produced with the ABR method is always more desirable than a CBR MP3''' at the same bitrate. That is, unless the encoder has a horrible ABR algorithm, a VBR MP3 produced with the ABR method and an average bitrate near 128 kbps will always sound equal to or better than a 128 kbps CBR MP3.

If average bitrate is not a concern, or if greater efficiency is desired, then even better quality will usually be obtained if a VBR MP3 is produced via a more aggressive, non-ABR method such as that normally used when producing VBR MP3s with LAME—assuming the range of allowable bitrates is high enough and the psychoacoustic model is not error-prone for the audio being encoded. LAME's various VBR presets can be used to ensure such an outcome.

== References ==
* [http://lame.sourceforge.net/abr.php An explanation (sort of) of ABR from the LAME developers]
* LAME's [http://lame.cvs.sourceforge.net/*checkout*/lame/lame/USAGE usage instructions] contain a paragraph about ABR as well

[[Category:Technical]]

Bel

2006-10-10T11:48:00Z

RasqualTwilight: Expanded a bit

{{title|dB}}

The '''decibel''' (abbreviated to '''dB''') is a logarithmical unit used to express relative difference in intensity or power between two signals, usually acoustic.

It is equal to ten times the common logarithm of the ratio of the two levels.
diff = 10 × log10(P2 / P1)

The ''10'' factor comes from the fact the Bel unit is too large for everyday use; decibel is just more convenient.

There is a second definition of the decibel. In acoustics, it is used to express the ratio in sound pressure, because power is roughly proportional to the square of effective sound pressure.

Let 'p' be pressure, 'P' power.
diff = 10 × log10(P2 / P1)

diff = 10 × log10(p22 / p12)

diff = 20 × log10(p2 / p1) because log10(a2) = 2 × log10(a)
In this scale, it means an increase of 20 dB is equal to a ten-fold ratio, or 6 dB a two-fold ratio (<tt>20 × log10(2)</tt> ''is approximately equal to 6'').

[[Category:Technical]]

Foobar2000:Title Formatting Reference

2006-10-09T12:55:06Z

RasqualTwilight: /* $info(name) */ +informative list of info fields

{{fb2k}}
This article contains information about built-in titleformatting functions and field references with special meaning. References to documentation about fields and function which can only be used in specific components or which are provided by specific components can be found at the end of this article.

A field reference is a field name enclosed in percent signs, for example ''%artist%''. A function call starts with a dollar sign, followed by the function name and the parameter list. A parameter list can either be empty - denoted as ''()'' - or contain one or more parameters separated by commata, for example ''$abbr(%artist%)''. Note that there must be no whitespace between the dollar sign and the function name, or the function name and the opening parenthesis of the parameter list.

Please see [[Foobar2000:Titleformat_Introduction|Titleformat Introduction]] for a presentation of titleformat syntax in general.

= 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%)''. Returns the ''title'' tag if available, otherwise it returns the filename excluding 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.

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

Compares the integer numbers ''n1'' and ''n2'', if ''n1'' is equal to ''n2'', the ''then'' part is evaluated and its value 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 232-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.

=== $hsl() ===

Resets the text color to the default color.

=== $hsl(h,s,l) ===

Sets the color for text in the HSL color space. ''h'', ''s'' and ''l'' are the hue, saturation, and lightness of the color for unselected text. The color for selected text is set to the inverse color.
The ranges of ''h'', ''s'', and ''l'' are from 0 to 240; the function is designed to interpret those values in the same way as the standard Windows color dialog.

=== $hsl(h1,s1,l1,h2,s2,l2) ===

Sets the color for text in the HSL color space. ''h1'', ''s1'' and ''l1'' are the hue, saturation, and lightness of the color for unselected text. ''h2'', ''s2'' and ''l2'' are the hue, saturation, and lightness of the color for selected text.

=== $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 of the color for 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 ==

=== %playback_time% ===
Returns the elapsed time formatted as [HH:]MM:SS.

=== %playback_time_seconds% ===
Returns elapsed time in seconds.
Old version: <code>%_time_elapsed%</code>

=== %playback_time_remaining% ===
Returns remaining time until track ends, formatted as [HH:]MM:SS.
Old version: <code>%_time_remaining%</code>

=== %playback_time_remaining_seconds% ===
Returns remaining time in seconds.
Old version: <code>%_time_remaining_seconds%</code>

=== %length% ===
Returns the length of the track formatted as hours, minutes, and seconds.
Old version: <code>%_time_total%</code>

=== %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.
Old version: <code>%_time_total_seconds%</code>

=== %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.

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

== 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.

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

=== %list_index% ===

Returns a zero-padded playlist index of specified item. The first item is at index 1.

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

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

=== %list_total% ===

Returns number of items in the playlist.

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

=== %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.

=== $ascii(x) ===

Converts ''x'' to ASCII. Any characters that are not present in ASCII will be removed / replaced.

=== $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''.

=== $crc32(a) ===

Computes the CRC32 of the string ''a'' as a number. Intended for use in coloring scripts.

Example: $rgb($mod($crc32(%album%),256),128,128)

=== $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.

=== $rot13() ===

Performs [http://en.wikipedia.org/wiki/ROT13 ROT13] transformation to given string.

Example: ''$rot13('foobar2000')'' -> "sbbone2000".

=== $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 (0,1,2 and so on) tag called ''name''.

Example: ''$meta(artist,1)'' -> "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 ''1'', if all given tags exist, ''undefined'' otherwise.

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''.

For convenience, the '''%__name%''' alias is also available.

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

Here is an '''informative''' list of recognized fields. Some of these depend on the media file type being queried.

(→See also: [[Foobar2000_Talk:Titleformat_Reference#Other_information|Talk page]])

{| border="0" cellspacing="0" cellpadding="2"
! field name
! Description
|-
| colspan="2" style="background-color:#CCF"|'''General'''
|-
|codec
| style="background-color:#EEF"|'''Codec''' (''e.g.'' MP3)
|-
|codec_profile
| style="background-color:#EEF"|'''Codec Profile''' (''e.g.'' CBR)
|-
|samplerate
| style="background-color:#EEF"|'''Sample Rate''', in hertz (''e.g.'' 44100)
|-
|bitrate
| style="background-color:#EEF"|'''Bitrate''', in kilobits per second (''e.g.'' 320)
|-
|tool
| style="background-color:#EEF"|'''Tool''' used to produce the file, possibly guessed (''e.g.'' LAME3.97)
|-
|encoding
| style="background-color:#EEF"|'''Encoding''' lossiness (''e.g.'' lossy)
|-
|channels
| style="background-color:#EEF"|'''Channels''' count (''e.g.'' 2 <nowiki>[for stereo]</nowiki>)
|-
|bitspersample
| style="background-color:#EEF"|'''Bits Per Sample''' (''e.g.'' 16)
|-
|tagtype
| style="background-color:#EEF"|'''Tag Type''', comma-separated list of tag formats (''e.g.'' id3v2|apev2)
|-
|cue_embedded
| style="background-color:#EEF"|'''Embedded Cuesheet''' presence (''e.g.'' no <nowiki>[may be empty!]</nowiki>)
|-
|md5
| style="background-color:#EEF"|'''Audio MD5''' hash, if container defines it (''e.g.'' 1E24A910D91EF09A8CF403C9B6963961)
|-
| colspan="2" style="background-color:#CCF"|'''Other'''
|-
|ENC_DELAY
| style="background-color:#EEF"|LAME proprietary MP3 '''enc_delay''' value (''e.g.'' 576)
|-
|ENC_PADDING
| style="background-color:#EEF"|LAME proprietary MP3 '''enc_padding''' value (''e.g.'' 1536)
|-
|MP3_ACCURATE_LENGTH
| style="background-color:#EEF"|'''mp3_accurate_length''' supported (LAME proprietary header)? (''e.g.'' yes)
|-
|MP3_STEREO_MODE
| style="background-color:#EEF"|Stereo mode used in MP3 file (''e.g.'' mono, stereo, joint stereo, etc.)
|-
|VERSION
| style="background-color:#EEF"|'''Version''' of tool (''e.g.'' 3.99)
|-
|FLAGS
| style="background-color:#EEF"|'''Flags''' of tool (''e.g.'' 22)
|}

=== $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. This syntax is from an older version of Foobar2000 {{Foobar2000v08}}. The following fields can be used normally.
==== %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.
==== %lastmodified% ====
Returns the date and time the file was last modified. Eg: ''2005-12-22 00:04:10''
==== %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.
==== $extra(foobar2000_version) ====
Returns a string representing the version of foobar2000.

= 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.

For example:
{| border="0" cellspacing="0" cellpadding="2"
! code
! output
|-
|<pre>$put(foo,bar)$char(10)
$get(foo)$char(10)
$get(Foo)$char(10)
$puts(foo,2000)$char(10)
$get(foo)$char(10)</pre>
| style="background-color:#EEF" |<pre>bar
bar
bar

2000</pre>
|}
=== $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 nothing

= Component-provided fields and functions on tracks =

This section lists components that provide additional fields and functions that are useable in the context of any track.

== Playback statistics ==

* [http://www.foobar2000.org/beta/components.html Playback statistics homepage]
* [[Foobar2000:Titleformat Playback Statistics|Playback statistics titleformat reference]]

= Component-specific fields and functions =

This section lists components that provide additional fields and functions that are only useable in the context of the particular component.

== Album list ==

The official album list component supports creating multiple tree entries using special commands.

* [http://www.foobar2000.org/ Album list homepage]
* [[Foobar2000:Titleformat Album List|Album list titleformat reference]]

== Columns UI ==

* [http://music.morbo.org/wiki/columns_ui:manual Columns UI homepage]
* [http://music.morbo.org/wiki/columns_ui:config:global_variables Global variables reference]
* [http://music.morbo.org/wiki/columns_ui:config:colour_string Playlist colors reference]
* [http://music.morbo.org/wiki/columns_ui:config:playlist_switcher_titleformatting Playlist switcher reference]

== CwBowron's Title formating (foo cwb hooks) ==
foo_cwb_hooks adds various functions and variables to global title formatting:
* [[Foobar2000:0.9_CwBowron%27s_Title_formating_%28foo_cwb_hooks%29|cwb_hooks title formatting wiki page]]

= Additional Reading =

* [[Foobar2000:Titleformat_Introduction|Introduction to titleformat scripts]]
* '''titleformat_help.html''' in your Foobar2000 directory (ie C:\Program Files\foobar2000\titleformat_help.html) file:///C:/Program%20Files/foobar2000/titleformat_help.html

[[Category:foobar2000 Guides|Titleformat Reference]]