furnace/extern/flac/man/metaflac.html
2025-10-22 16:16:07 -05:00

401 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang xml:lang>
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>metaflac(1) Version 1.5.0 | Free Lossless Audio Codec metadata tool</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list[class]{list-style: none;}
ul.task-list li input[type="checkbox"] {
font-size: inherit;
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
<style type="text/css">html{background-color: #B3D9B3;}body{position: relative;display: block;background-color: #F2F2DE;color: black;margin: 0 auto;padding: 0 0 10px 0;max-width: 1200px;font-family: lucida, verdana, helvetica, arial, sans-serif;font-weight: normal;font-size: 100%;}div.logo{position: relative;background-color: black;padding: 1px;text-align: center;}div.navbar {font-weight: bold;}@media (min-width: 800px){div.navbar{display: flex;gap: 5px;flex-direction: row;padding: 8px;text-align: center;}div.navbar:before, div.navbar:after{content: "";flex: 1 1;border-bottom: 2px solid;margin: 10px;}div.navbar div:first-child a::after, div.navbar div:last-child a:not(:last-child)::after {content: " - ";}#navbarshow{display: none;}}@media (max-width: 799px){div.navbar div{display: flex;gap: 5px;flex-direction: row;padding: 8px;text-align: center;}div.navbar div:before, div.navbar div:after{content: "";flex: 1 1;flex-grow: 3;border-bottom: 2px solid;margin: 10px;}div.navbar div a:not(:last-child)::after {content: " - ";}#navbarshow{display: none;}}div.navbar a{color: #000;text-decoration: none;}div.content{padding: 0 25px;}div.box_footer{border-width: 0px 0px 1px 0px;border-style: solid;border-color: black;background-color: #EEEED4;padding: 3px;}div.box_body{background-color: #EEEED4;padding: 0px 3px 0px 3px;font-family: lucida, verdana, helvetica, arial, sans-serif;font-weight: normal;font-size: 100%;}#newsbox h3{margin: 5px 0 0 0; font-size: 0.9em; }#newsbox p{margin: 0;}div.smallbox{text-align: left;margin: 0 0 0 8px;background-color: #EEEED4;}div.smallbox_title{text-align: center;border-width: 1px 0px 0px 0px;border-style: solid;border-color: black;background-color: #D3D4C5;padding: 3px;font-family: lucida, verdana, helvetica, arial, sans-serif;font-weight: bold;font-size: 100%;}div.smallbox_header{border-width: 1px 0px 0px 0px;border-style: solid;border-color: black;background-color: #EEEED4;padding: 3px;}div.smallbox_footer{border-width: 0px 0px 1px 0px;border-style: solid;border-color: black;background-color: #EEEED4;padding: 3px;}div.smallbox_body{background-color: #EEEED4;padding: 0px 3px 0px 3px;font-family: lucida, verdana, helvetica, arial, sans-serif;font-weight: normal;font-size: 80%;}div.copyright{text-align: left;padding-bottom: 10px;}div.copyright hr {margin: 20px 0;}span.commandname{font-family: monospace;font-weight: bold;}span.command{font-family: monospace;font-weight: bold;}span.argument{font-family: monospace;}span.code{font-family: monospace;}a:link, a:visited, a:active, a:hover{color:#336699;background-color:transparent;}div.imageflex{display: flex;flex-wrap: wrap;justify-content: center;padding: 0 20px}div.imageflex div{width: 200px;height: 125px;padding: 10px;text-align: center;}div.imageflex div span {display: block;text-align: center;}</style>
</head>
<body>
<div class="logo">
<img src="data:image/png;base64,
iVBORw0KGgoAAAANSUhEUgAAAKEAAABQBAMAAACDsQg5AAAAMFBMVEUAAABTAgC1AAMkMh/7AABQ
UQBbYFklgx8nnieiogCZm5i9wLzIysfY29f5+gD7/vuN5xJAAAAEtklEQVRYw92YP4vbPBjA9SKq
wU5I+xX6CQyBDHcX0qEf4F26CwwenJjc1vWFd+n4rt0MhQzOhQsUPLgXEihkSHNcIJAhdyGF7qVQ
uOGS4Nd/ZFmyZV+Sc4dWoER6LP2sP8/z6JEBKD69ePG8WOBfr1+/ynoGNVwkEVlr150VSEQez3V/
BuWaPlg8mYhufKD7AIB85bPvn0y8DIDuBoBKUHgyUQ6B7q4wIhmi6yqHE4X6KEVAFx9BFKUGJY6O
IL58+Zz799OQEmfHryO7nnBNiffFEBEFegpZCDHSHdeyOsUQQ4i7YCrFEJXiiI3IAgsjtiMvISLW
tI6aouj+imcmWG2zEI6od8mWsa4YNkOho2QQeyviJVarO4Unxmq1jXtDag+bQPjs/fv/ohy2iNXb
3SWIsb2T3pxXIUv/7Pv3r17+5uewhZtNlJlnkVc33IQwRUQ5xBLbG6eae8kUEKUcYoXtPE/Ombzm
IGKD7bwRDPFBNOtSDrHNdVdSEs+dCoiVHCI/xb4nueEkfvu09rRziGuu/4zf/NjMsg4tIXHqaPqU
euPkpPtC4k02Ed6GFn1CibSxpfXIpKN19HM462pVI55C09SEXSucK7mnO73xdfNkHTZK20zcIdOb
SUQmc8peNo8nIiJr8AYJjiE2p1M7JrbZIR5FRJfhqkXEoUhnDiISzdqpRLZmDDxJ/LoPkerzJpQh
oRZCz1ai/BiRNzlK3CNYzyAmTI4SwdHEdpIoCYnMOgY5h5gAuvNc4jd2v8VE0n/3ZVAUsUxPEqJE
c/HO7E+MpYgn9o8lXkZDjIpz6OZo+B7EYbxoZUJaP2aF+cSg+5aJBOZRvI4zbSayGzGRCQFlcs7w
3gwqh2k4ZFSlRIjkJN6Fg2yEHtc7BRQuP0LEcYMZjRaCsEoipwJ89+4fNj8y6+DGTW4ns+gt/plU
1ddkrPsT1/R4PKPwy3RIcQAxuiB3unEEUBdEAPsTk67HJyYCqSAU2p9YFhBF096fKImIgsAnQTzP
8Y9DATEpxAfoI91iniinouYDToX4kryLifyGBc3evPnbzyDKOWdhK+rYYYiImfcW5+zM7m4cE6NK
L+y4RKynRTccUEzcdrQqvchuLVqBgbI8KMi9tTRV4aTei3CmXeckvet0RN/YvBTdPw8k7pF+E+I5
m8GvSRotqalC/DEAcbVcIBrTop0q0NSU2ZoRz/rt23M2B1cBW8U1FfhfcW2kAb+o2FBTUCirqUhB
QGuioBYKNcN/rpF1/De5M9L46sOnq9pk4hFbXdO5kK25Xe6OnO6p8xmAZU/GDcn5UkF+i089r6Hs
rGTns3FhZhBR30EjuYUbHtGGPxZINhW7CxZjWDJVAHH9FDcquFkp4xaAPyTDrBtg0AL2AmUTbWl7
bdxdK8Aeg/vWEg1N+3q6aD7AnmfMg4FHrAOPqNQBGoEKLjWBYUyXcwCyiWiEzrAUjPGneaZ7/12g
4pIOHCD1y6e4XVHCMaJ4jOoC9bOIpg0mF7WJE67jste0xnbdGjkXTWcM0LKnT4aSdVuWHMdfR23i
lJxVyfpodLNmDbEKTlSgezuJUQfUOlDHYSGQ6RrWNe8XBTUUCK0atBTUydKePz79Dy84W9TLWTUv
AAAAAElFTkSuQmCC" alt="FLAC Logo" id="logo" />
</div>
<div class="content">
<header id="title-block-header">
<h1 class="title">metaflac(1) Version 1.5.0 | Free Lossless Audio Codec
metadata tool</h1>
</header>
<h1 id="name">NAME</h1>
<p>metaflac - program to list, add, remove, or edit metadata in one or
more FLAC files.</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p><strong>metaflac</strong> [ <em>options</em> ] [ <em>operations</em>
] <em>FLACfile …</em></p>
<h1 id="description">DESCRIPTION</h1>
<p>Use <strong>metaflac</strong> to list, add, remove, or edit metadata
in one or more FLAC files. You may perform one major operation, or many
shorthand operations at a time.</p>
<h1 id="general-usage">GENERAL USAGE</h1>
<p>metaflac is the command-line .flac file metadata editor. You can use
it to list the contents of metadata blocks, edit, delete or insert
blocks, and manage padding.</p>
<p>metaflac takes a set of “options” (though some are not optional) and
a set of FLAC files to operate on. There are three kinds of
“options”:</p>
<ul>
<li><p>Major operations, which specify a mode of operation like listing
blocks, removing blocks, etc. These will have sub-operations describing
exactly what is to be done.</p></li>
<li><p>Shorthand operations, which are convenient synonyms for major
operations. For example, there is a shorthand operation
--show-sample-rate that shows just the sample rate field from the
STREAMINFO metadata block.</p></li>
<li><p>Global options, which affect all the operations.</p></li>
</ul>
<p>All of these are described in the tables below. At least one
shorthand or major operation must be supplied. You can use multiple
shorthand operations to do more than one thing to a file or set of
files. Most of the common things to do to metadata have shorthand
operations. As an example, here is how to show the MD5 signatures for a
set of three FLAC files:</p>
<p><code>metaflac --show-md5sum file1.flac file2.flac file3.flac</code></p>
<p>Another example; this removes all DESCRIPTION and COMMENT tags in a
set of FLAC files, and uses the --preserve-modtime global option to keep
the FLAC file modification times the same (usually when files are edited
the modification time is set to the current time):</p>
<p><code>metaflac --preserve-modtime --remove-tag=DESCRIPTION --remove-tag=COMMENT file1.flac file2.flac file3.flac</code></p>
<h1 id="options">OPTIONS</h1>
<dl>
<dt><strong>-o</strong> <em>filename</em><strong>,
--output-name=</strong><em>filename</em></dt>
<dd>
Output to a new file instead of changing or rewriting the input file.
</dd>
<dt><strong>--preserve-modtime</strong></dt>
<dd>
Preserve the original modification time in spite of edits. This does
nothing when -o or output-name are specified.
</dd>
<dt><strong>--with-filename</strong></dt>
<dd>
Prefix each output line with the FLAC file name (the default if more
than one FLAC file is specified). This option has no effect for options
exporting to a file, like --export-tags-to.
</dd>
<dt><strong>--no-filename</strong></dt>
<dd>
Do not prefix each output line with the FLAC file name (the default if
only one FLAC file is specified).
</dd>
<dt><strong>--no-utf8-convert</strong></dt>
<dd>
Do not convert tags from UTF-8 to local charset, or vice versa. This is
useful for scripts, and setting tags in situations where the locale is
wrong.
</dd>
<dt><strong>--dont-use-padding</strong></dt>
<dd>
By default metaflac tries to use padding where possible to avoid
rewriting the entire file if the metadata size changes. Use this option
to tell metaflac to not take advantage of padding this way.
</dd>
</dl>
<h1 id="shorthand-operations">SHORTHAND OPERATIONS</h1>
<dl>
<dt><strong>--show-md5sum</strong></dt>
<dd>
Show the MD5 signature from the STREAMINFO block.
</dd>
<dt><strong>--show-min-blocksize</strong></dt>
<dd>
Show the minimum block size from the STREAMINFO block.
</dd>
<dt><strong>--show-max-blocksize</strong></dt>
<dd>
Show the maximum block size from the STREAMINFO block.
</dd>
<dt><strong>--show-min-framesize</strong></dt>
<dd>
Show the minimum frame size from the STREAMINFO block.
</dd>
<dt><strong>--show-max-framesize</strong></dt>
<dd>
Show the maximum frame size from the STREAMINFO block.
</dd>
<dt><strong>--show-sample-rate</strong></dt>
<dd>
Show the sample rate from the STREAMINFO block.
</dd>
<dt><strong>--show-channels</strong></dt>
<dd>
Show the number of channels from the STREAMINFO block.
</dd>
<dt><strong>--show-bps</strong></dt>
<dd>
Show the # of bits per sample from the STREAMINFO block.
</dd>
<dt><strong>--show-total-samples</strong></dt>
<dd>
Show the total # of samples from the STREAMINFO block.
</dd>
<dt><strong>--show-vendor-tag</strong></dt>
<dd>
Show the vendor string from the VORBIS_COMMENT block.
</dd>
<dt><strong>--show-tag=name</strong></dt>
<dd>
Show all tags where the field name matches name.
</dd>
<dt><strong>--show-all-tags</strong></dt>
<dd>
Show all tags. This is an alias for --export-tags-to=-.
</dd>
<dt><strong>--remove-tag=name</strong></dt>
<dd>
Remove all tags whose field name is name.
</dd>
<dt><strong>--remove-first-tag=name</strong></dt>
<dd>
Remove first tag whose field name is name.
</dd>
<dt><strong>--remove-all-tags</strong></dt>
<dd>
Remove all tags, leaving only the vendor string.
</dd>
<dt><strong>--remove-all-tags-except=NAME1[=NAME2[=…]]</strong></dt>
<dd>
Remove all tags, except the vendor string and the tag names specified.
Tag names must be separated by an = character.
</dd>
<dt><strong>--set-tag=field</strong></dt>
<dd>
Add a tag. The field must comply with the Vorbis comment spec, of the
form “NAME=VALUE”. If there is currently no tag block, one will be
created.
</dd>
<dt><strong>--set-tag-from-file=field</strong></dt>
<dd>
Like --set-tag, except the VALUE is a filename whose contents will be
read verbatim to set the tag value. Unless --no-utf8-convert is
specified, the contents will be converted to UTF-8 from the local
charset. This can be used to store a cuesheet in a tag (e.g.
--set-tag-from-file=“CUESHEET=image.cue”). Do not try to store binary
data in tag fields! Use APPLICATION blocks for that.
</dd>
<dt><strong>--import-tags-from=file</strong></dt>
<dd>
Import tags from a file. Use - for stdin. Each line should be of the
form NAME=VALUE. Multi-line comments are currently not supported.
Specify --remove-all-tags and/or --no-utf8-convert before
--import-tags-from if necessary. If FILE is - (stdin), only one FLAC
file may be specified.
</dd>
<dt><strong>--export-tags-to=file</strong></dt>
<dd>
Export tags to a file. Use - for stdout. Each line will be of the form
NAME=VALUE. Specify --no-utf8-convert if necessary.
</dd>
<dt><strong>--import-cuesheet-from=file</strong></dt>
<dd>
Import a cuesheet from a file. Use - for stdin. Only one FLAC file may
be specified. A seekpoint will be added for each index point in the
cuesheet to the SEEKTABLE unless --no-cued-seekpoints is specified.
</dd>
<dt><strong>--export-cuesheet-to=file</strong></dt>
<dd>
Export CUESHEET block to a cuesheet file, suitable for use by CD
authoring software. Use - for stdout. Only one FLAC file may be
specified on the command line.
</dd>
<dt><strong>--import-picture-from={</strong><em>FILENAME</em><strong>|</strong><em>SPECIFICATION</em><strong>}</strong></dt>
<dd>
Import a picture and store it in a PICTURE metadata block. More than one
--import-picture-from command can be specified. Either a filename for
the picture file or a more complete specification form can be used. The
SPECIFICATION is a string whose parts are separated by | (pipe)
characters. Some parts may be left empty to invoke default values.
FILENAME is just shorthand for “||||FILENAME”. For details on the
specification, see the section <strong>Picture specification</strong> in
the <strong>flac(1)</strong> man page.
</dd>
<dt><strong>--export-picture-to=file</strong></dt>
<dd>
Export PICTURE block to a file. Use - for stdout. Only one FLAC file
may be specified on the command line. The first PICTURE block will be
exported unless --export-picture-to is preceded by a --block-number=#
option to specify the exact metadata block to extract. Note that the
block number is the one shown by --list.
</dd>
<dt><strong>--add-replay-gain</strong></dt>
<dd>
Calculates the title and album gains/peaks of the given FLAC files as if
all the files were part of one album, then stores them as FLAC tags. The
tags are the same as those used by vorbisgain. Existing ReplayGain tags
will be replaced. If only one FLAC file is given, the album and title
gains will be the same. Since this operation requires two passes, it is
always executed last, after all other operations have been completed and
written to disk. All FLAC files specified must have the same resolution,
sample rate, and number of channels. Only mono and stereo files are
allowed, and the sample rate must be 8, 11.025, 12, 16, 18.9, 22.05, 24,
28, 32, 36, 37.8, 44.1, 48, 56, 64, 72, 75.6, 88.2, 96, 112, 128, 144,
151.2, 176.4, 192, 224, 256, 288, 302.4, 352.8, 384, 448, 512, 576, or
604.8 kHz.
</dd>
<dt><strong>--scan-replay-gain</strong></dt>
<dd>
Like --add-replay-gain, but only analyzes the files rather than writing
them to the tags.
</dd>
<dt><strong>--remove-replay-gain</strong></dt>
<dd>
Removes the ReplayGain tags.
</dd>
<dt><strong>--add-seekpoint={</strong><em>#</em><strong>|</strong><em>X</em><strong>|</strong><em>#x</em><strong>|</strong><em>#s</em><strong>}</strong></dt>
<dd>
Add seek points to a SEEKTABLE block. Using #, a seek point at that
sample number is added. Using X, a placeholder point is added at the end
of a the table. Using #x, # evenly spaced seek points will be added, the
first being at sample 0. Using #s, a seekpoint will be added every #
seconds (# does not have to be a whole number; it can be, for example,
9.5, meaning a seekpoint every 9.5 seconds). If no SEEKTABLE block
exists, one will be created. If one already exists, points will be added
to the existing table, and any duplicates will be turned into
placeholder points. You may use many --add-seekpoint options; the
resulting SEEKTABLE will be the unique-ified union of all such values.
Example: --add-seekpoint=100x --add-seekpoint=3.5s will add 100 evenly
spaced seekpoints and a seekpoint every 3.5 seconds.
</dd>
<dt><strong>--add-padding=length</strong></dt>
<dd>
Add a padding block of the given length (in bytes). The overall length
of the new block will be 4 + length; the extra 4 bytes is for the
metadata block header.
</dd>
</dl>
<h1 id="major-operations">MAJOR OPERATIONS</h1>
<dl>
<dt><strong>--list</strong></dt>
<dd>
List the contents of one or more metadata blocks to stdout. By default,
all metadata blocks are listed in text format. Use the options
<strong>--block-number</strong>, <strong>--block-type</strong> or
<strong>--except-block-type</strong> to change this behavior.
</dd>
<dt><strong>--remove</strong></dt>
<dd>
Remove one or more metadata blocks from the metadata. Use the options
<strong>--block-number</strong>, <strong>--block-type</strong> or
<strong>--except-block-type</strong> to specify which blocks should be
removed. Note that if both --block-number and --[except-]block-type are
specified, the result is the logical AND of both arguments. Unless
--dont-use-padding is specified, the blocks will be replaced with
padding. You may not remove the STREAMINFO block.
</dd>
<dt><strong>--block-number=#[,#[…]]</strong></dt>
<dd>
An optional comma-separated list of block numbers to display. The first
block, the STREAMINFO block, is block 0.
</dd>
</dl>
<p><strong>--block-type=type[,type[…]]</strong></p>
<dl>
<dt><strong>--except-block-type=type[,type[…]]</strong></dt>
<dd>
An optional comma-separated list of block types to be included or
ignored with this option. Use only one of --block-type or
--except-block-type. The valid block types are: STREAMINFO, PADDING,
APPLICATION, SEEKTABLE, VORBIS_COMMENT, PICTURE. You may narrow down the
types of APPLICATION blocks selected by appending APPLICATION with a
colon and the ID of the APPLICATION block in either ASCII or hexadecimal
representation. E.g. APPLICATION:abcd for the APPLICATION block(s) whose
textual representation of the 4-byte ID is “abcd” or
APPLICATION:0xXXXXXXXX for the APPLICATION block(s) whose hexadecimal
big- endian representation of the 4-byte ID is “0xXXXXXXXX”. For the
example “abcd” above the hexadecimal equivalalent is 0x61626364
</dd>
<dt><strong>--application-data-format=hexdump|text</strong></dt>
<dd>
If the application block you are displaying contains binary data but
your --data-format=text, you can display a hex dump of the application
data contents instead using --application-data-format=hexdump.
</dd>
<dt><strong>--data-format=binary|binary-headerless|text</strong></dt>
<dd>
For use with --list. By default a human-readable text representation of
the data is isplayed. You may specify --data-format=binary to dump the
raw binary form of each metadata block. Specify
--data-format=binary-headerless to omit output of metadata block
headers, including the id of APPLICATION metadata blocks.
</dd>
<dt><strong>--append</strong></dt>
<dd>
Insert a metadata block from a file. This must be a binary block as
exported with --list --data-format=binary. The insertion point is
defined with --block-number=#. The new block will be added after the
given block number. This prevents the illegal insertion of a block
before the first STREAMINFO block. You may not --append another
STREAMINFO block. It is possible to copy a metadata block from one file
to another with this option. For example use
<code>metaflac --list --data-format=binary --block-number=6 file.flac &gt; block</code>
to export the block, and then import it with
<code>metaflac --append anotherfile.flac &lt; block</code>
</dd>
<dt><strong>--remove-all</strong></dt>
<dd>
Remove all metadata blocks (except the STREAMINFO block) from the
metadata. Unless --dont-use-padding is specified, the blocks will be
replaced with padding.
</dd>
<dt><strong>--merge-padding</strong></dt>
<dd>
Merge adjacent PADDING blocks into single blocks.
</dd>
<dt><strong>--sort-padding</strong></dt>
<dd>
Move all PADDING blocks to the end of the metadata and merge them into a
single block.
</dd>
</dl>
<h1 id="see-also">SEE ALSO</h1>
<p><strong>flac(1)</strong></p>
<div class="copyright">
<hr />
Copyright (c) 2000-2009 Josh Coalson, 2011-2025 Xiph.Org Foundation
</div>
</div>
</body>
</html>