cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: FLAC - documentation cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86:  english  | cannam@86:  russian  cannam@86:
cannam@86: cannam@86:
cannam@86: cannam@86:
cannam@86:
cannam@86: metaflac cannam@86:
cannam@86:
cannam@86:
cannam@86: Table of Contents cannam@86: cannam@86: General Usage
cannam@86:
cannam@86: 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.
cannam@86:
cannam@86: 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": cannam@86: cannam@86: 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:
cannam@86:
cannam@86: metaflac --show-md5sum file1.flac file2.flac file3.flac
cannam@86:
cannam@86: 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):
cannam@86:
cannam@86: metaflac --preserve-modtime --remove-tag=DESCRIPTION --remove-tag=COMMENT file1.flac file2.flac file3.flac
cannam@86:
cannam@86: cannam@86:
cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86: Global Options cannam@86:
cannam@86: cannam@86: --preserve-modtime cannam@86: cannam@86: Preserve the original modification time in spite of edits. cannam@86:
cannam@86: cannam@86: --with-filename cannam@86: cannam@86: Prefix each output line with the FLAC file name (the default if more than one FLAC file is specified). cannam@86:
cannam@86: cannam@86: --no-filename cannam@86: cannam@86: Do not prefix each output line with the FLAC file name (the default if only one FLAC file is specified) cannam@86:
cannam@86: cannam@86: --no-utf8-convert cannam@86: cannam@86: 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. cannam@86:
cannam@86: cannam@86: --dont-use-padding cannam@86: cannam@86: 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. cannam@86:
cannam@86:
cannam@86: cannam@86:
cannam@86: cannam@86:
cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86: Shorthand Operations cannam@86:
cannam@86: cannam@86: --show-md5sum cannam@86: cannam@86: Show the MD5 signature from the STREAMINFO block. cannam@86:
cannam@86: cannam@86: --show-min-blocksize cannam@86: cannam@86: Show the minimum block size from the STREAMINFO block. cannam@86:
cannam@86: cannam@86: --show-max-blocksize cannam@86: cannam@86: Show the maximum block size from the STREAMINFO block. cannam@86:
cannam@86: cannam@86: --show-min-framesize cannam@86: cannam@86: Show the minimum frame size from the STREAMINFO block. cannam@86:
cannam@86: cannam@86: --show-max-framesize cannam@86: cannam@86: Show the maximum frame size from the STREAMINFO block. cannam@86:
cannam@86: cannam@86: --show-sample-rate cannam@86: cannam@86: Show the sample rate from the STREAMINFO block. cannam@86:
cannam@86: cannam@86: --show-channels cannam@86: cannam@86: Show the number of channels from the STREAMINFO block. cannam@86:
cannam@86: cannam@86: --show-bps cannam@86: cannam@86: Show the # of bits per sample from the STREAMINFO block. cannam@86:
cannam@86: cannam@86: --show-total-samples cannam@86: cannam@86: Show the total # of samples from the STREAMINFO block. cannam@86:
cannam@86: cannam@86: --show-vendor-tag cannam@86: cannam@86: Show the vendor string from the VORBIS_COMMENT block. cannam@86:
cannam@86: cannam@86: --show-tag=NAME cannam@86: cannam@86: Show all tags where the the field name matches NAME. cannam@86:
cannam@86: cannam@86: --remove-tag=NAME cannam@86: cannam@86: Remove all tags whose field name is NAME. cannam@86:
cannam@86: cannam@86: --remove-first-tag=NAME cannam@86: cannam@86: Remove first tag whose field name is NAME. cannam@86:
cannam@86: cannam@86: --remove-all-tags cannam@86: cannam@86: Remove all tags, leaving only the vendor string. cannam@86:
cannam@86: cannam@86: --set-tag=FIELD cannam@86: cannam@86: 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. cannam@86:
cannam@86: cannam@86: --set-tag-from-file=FIELD cannam@86: cannam@86: 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. cannam@86:
cannam@86: cannam@86: --import-tags-from=FILE cannam@86: cannam@86: 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. cannam@86:
cannam@86: cannam@86: --export-tags-to=FILE cannam@86: cannam@86: Export tags to a file. Use - for stdin. Each line will be of the form NAME=VALUE. Specify --no-utf8-convert if necessary. cannam@86:
cannam@86: cannam@86: --import-cuesheet-from=FILE cannam@86: cannam@86: 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. cannam@86:
cannam@86: cannam@86: --export-cuesheet-to=FILE cannam@86: cannam@86: 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. cannam@86:
cannam@86: cannam@86: --import-picture-from={FILENAME|SPECIFICATION} cannam@86: cannam@86: Import a picture and store it in a PICTURE metadata block. See the flac option --picture for an explanation of the SPECIFICATION syntax. cannam@86:
cannam@86: cannam@86: --export-picture-to=FILE cannam@86: cannam@86: 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. cannam@86:
cannam@86: cannam@86: --add-replay-gain cannam@86: cannam@86: 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. The sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz. cannam@86:
cannam@86: cannam@86: --remove-replay-gain cannam@86: cannam@86: Removes the ReplayGain tags. cannam@86:
cannam@86: cannam@86: --add-seekpoint={#|X|#x|#s} cannam@86: cannam@86: Add seek points to a SEEKTABLE block:
cannam@86:
    cannam@86:
  • cannam@86: : a specific sample number for a seek point cannam@86:
  • cannam@86:
  • cannam@86: : a placeholder point (always goes at the end of the SEEKTABLE) cannam@86:
  • cannam@86:
  • cannam@86: #x : # evenly spaced seekpoints, the first being at sample 0 cannam@86:
  • cannam@86:
  • cannam@86: #s : a seekpoint every # seconds; # does not have to be a whole number, it can be, for example, 9.5, meaning a seekpoint every 9.5 seconds cannam@86:
  • cannam@86:
cannam@86: 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.
cannam@86: 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.
cannam@86:
cannam@86: cannam@86: --add-padding=# cannam@86: cannam@86: 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. cannam@86:
cannam@86:
cannam@86: cannam@86:
cannam@86: cannam@86:
cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
cannam@86: Major Operations cannam@86:
cannam@86: cannam@86: --version cannam@86: cannam@86: Show the metaflac version number. cannam@86:
cannam@86: cannam@86: --list cannam@86: cannam@86: List the contents of one or more metadata blocks to stdout. By default, all metadata blocks are listed in text format. Use the following options to change this behavior:
cannam@86:
cannam@86: cannam@86: --block-number=#[,#[...]]
cannam@86: An optional comma-separated list of block numbers to display. The first block, the STREAMINFO block, is block 0.
cannam@86:
cannam@86: cannam@86: --block-type=type[,type[...]]
cannam@86: --except-block-type=type[,type[...]]
cannam@86: 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. You may narrow down the types of APPLICATION blocks displayed as follows:
cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86:
APPLICATION:abcdThe APPLICATION block(s) whose textual representation of the 4-byte ID is "abcd"
APPLICATION:0xXXXXXXXXThe 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
cannam@86:
cannam@86: cannam@86: NOTE: if both --block-number and --[except-]block-type are specified, the result is the logical AND of both arguments.
cannam@86:
cannam@86: cannam@86: --application-data-format=hexdump|text
cannam@86: 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. cannam@86:
cannam@86: cannam@86: --remove cannam@86: cannam@86: Remove one or more metadata blocks from the metadata. Unless --dont-use-padding is specified, the blocks will be replaced with padding. You may not remove the STREAMINFO block.
cannam@86:
cannam@86: cannam@86: --block-number=#[,#[...]]
cannam@86: --block-type=type[,type[...]]
cannam@86: --except-block-type=type[,type[...]]
cannam@86: See --list above for usage.
cannam@86:
cannam@86: cannam@86: NOTE: if both --block-number and --[except-]block-type are specified, the result is the logical AND of both arguments. cannam@86:
cannam@86: cannam@86: --remove-all cannam@86: cannam@86: Remove all metadata blocks (except the STREAMINFO block) from the metadata. Unless --dont-use-padding is specified, the blocks will be replaced with padding. cannam@86:
cannam@86: cannam@86: --merge-padding cannam@86: cannam@86: Merge adjacent PADDING blocks into single blocks. cannam@86:
cannam@86: cannam@86: --sort-padding cannam@86: cannam@86: Move all PADDING blocks to the end of the metadata and merge them into a single block. cannam@86:
cannam@86:
cannam@86: cannam@86:
cannam@86: Option Index
cannam@86:
cannam@86: --add-padding
cannam@86: --add-replay-gain
cannam@86: --add-seekpoint
cannam@86: --dont-use-padding
cannam@86: --export-cuesheet-to
cannam@86: --export-picture-to
cannam@86: --export-tags-to
cannam@86: --import-cuesheet-from
cannam@86: --import-picture-from
cannam@86: --import-tags-from
cannam@86: --list
cannam@86: --merge-padding
cannam@86: --no-filename
cannam@86: --no-utf8-convert
cannam@86: --preserve-modtime
cannam@86: --remove-all-tags
cannam@86: --remove-all
cannam@86: --remove-first-tag
cannam@86: --remove-replay-gain
cannam@86: --remove-tag
cannam@86: --remove
cannam@86: --set-tag-from-file
cannam@86: --set-tag
cannam@86: --show-bps
cannam@86: --show-channels
cannam@86: --show-max-blocksize
cannam@86: --show-max-framesize
cannam@86: --show-md5sum
cannam@86: --show-min-blocksize
cannam@86: --show-min-framesize
cannam@86: --show-sample-rate
cannam@86: --show-tag
cannam@86: --show-total-samples
cannam@86: --show-vendor-tag
cannam@86: --sort-padding
cannam@86: --version
cannam@86: --with-filename
cannam@86: cannam@86:
cannam@86: cannam@86:
cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: cannam@86: