man/metaflac.1

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "METAFLAC" "1" "17 November 2006" "" ""
   7
   8 .SH NAME
   9 metaflac \- program to list, add, remove, or edit metadata in one or more FLAC files.
  10 .SH SYNOPSIS
  11
  12 \fBmetaflac\fR [ \fB\fIoptions\fB\fR ] [ \fB\fIoperations\fB\fR ] \fB\fIFLACfile\fB\fR\fI ...\fR
  13
  14 .SH "DESCRIPTION"
  15 .PP
  16 Use \fBmetaflac\fR to list, add, remove, or edit
  17 metadata in one or more FLAC files.  You may perform one major operation,
  18 or many shorthand operations at a time.
  19 .SH "OPTIONS"
  20 .TP
  21 \fB--preserve-modtime\fR
  22 Preserve the original modification time in spite of edits.
  23 .TP
  24 \fB--with-filename\fR
  25 Prefix each output line with the FLAC file name (the default if
  26 more than one FLAC file is specified).
  27 .TP
  28 \fB--no-filename\fR
  29 Do not prefix each output line with the FLAC file name (the default
  30 if only one FLAC file is specified).
  31 .TP
  32 \fB--no-utf8-convert\fR
  33 Do not convert tags from UTF-8 to local charset, or vice versa. This is
  34 useful for scripts.
  35 .TP
  36 \fB--dont-use-padding\fR
  37 By default metaflac tries to use padding where possible to avoid
  38 rewriting the entire file if the metadata size changes.  Use this
  39 option to tell metaflac to not take advantage of padding this way.
  40 .SH "SHORTHAND OPERATIONS"
  41 .TP
  42 \fB--show-md5sum\fR
  43 Show the MD5 signature from the STREAMINFO block.
  44 .TP
  45 \fB--show-min-blocksize\fR
  46 Show the minimum block size from the STREAMINFO block.
  47 .TP
  48 \fB--show-max-blocksize\fR
  49 Show the maximum block size from the STREAMINFO block.
  50 .TP
  51 \fB--show-min-framesize\fR
  52 Show the minimum frame size from the STREAMINFO block.
  53 .TP
  54 \fB--show-max-framesize\fR
  55 Show the maximum frame size from the STREAMINFO block.
  56 .TP
  57 \fB--show-sample-rate\fR
  58 Show the sample rate from the STREAMINFO block.
  59 .TP
  60 \fB--show-channels\fR
  61 Show the number of channels from the STREAMINFO block.
  62 .TP
  63 \fB--show-bps\fR
  64 Show the # of bits per sample from the STREAMINFO block.
  65 .TP
  66 \fB--show-total-samples\fR
  67 Show the total # of samples from the STREAMINFO block.
  68 .TP
  69 \fB--show-vendor-tag\fR
  70 Show the vendor string from the VORBIS_COMMENT block.
  71 .TP
  72 \fB--show-tag=name\fR
  73 Show all tags where the the field name matches 'name'.
  74 .TP
  75 \fB--remove-tag=name\fR
  76 Remove all tags whose field name is 'name'.
  77 .TP
  78 \fB--remove-first-tag=name\fR
  79 Remove first tag whose field name is 'name'.
  80 .TP
  81 \fB--remove-all-tags\fR
  82 Remove all tags, leaving only the vendor string.
  83 .TP
  84 \fB--set-tag=field\fR
  85 Add a tag.  The field must comply with the
  86 Vorbis comment spec, of the form "NAME=VALUE".  If there is
  87 currently no tag block, one will be created.
  88 .TP
  89 \fB--set-tag-from-file=field\fR
  90 Like --set-tag, except the VALUE is a filename whose
  91 contents will be read verbatim to set the tag value.
  92 Unless --no-utf8-convert is specified, the contents will be
  93 converted to UTF-8 from the local charset.  This can be used
  94 to store a cuesheet in a tag (e.g.
  95 --set-tag-from-file="CUESHEET=image.cue").  Do not try to
  96 store binary data in tag fields!  Use APPLICATION blocks for
  97 that.
  98 .TP
  99 \fB--import-tags-from=file\fR
 100 Import tags from a file.  Use '-' for stdin.  Each
 101 line should be of the form NAME=VALUE.  Multi-line comments
 102 are currently not supported.  Specify --remove-all-tags and/or
 103 --no-utf8-convert before --import-tags-from if necessary.  If
 104 FILE is '-' (stdin), only one FLAC file may be specified.
 105 .TP
 106 \fB--export-tags-to=file\fR
 107 Export tags to a file.  Use '-' for stdout.  Each
 108 line will be of the form NAME=VALUE.  Specify
 109 --no-utf8-convert if necessary.
 110 .TP
 111 \fB--import-cuesheet-from=file\fR
 112 Import a cuesheet from a file.  Use '-' for stdin.  Only one
 113 FLAC file may be specified.  A seekpoint will be added for each
 114 index point in the cuesheet to the SEEKTABLE unless
 115 --no-cued-seekpoints is specified.
 116 .TP
 117 \fB--export-cuesheet-to=file\fR
 118 Export CUESHEET block to a cuesheet file, suitable for use by
 119 CD authoring software.  Use '-' for stdout.  Only one FLAC file
 120 may be specified on the command line.
 121 .TP
 122 \fB--import-picture-from=\fISPECIFICATION\fB\fR
 123 Import a picture and store it in a PICTURE metadata block.  More than one --import-picture-from command can be specified.  The SPECIFICATION is a string whose parts are separated by | (pipe) characters.  Some parts may be left empty to invoke default values.  The format of SPECIFICATION is
 124
 125 [TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE
 126
 127 TYPE is optional; it is a number from one of:
 128
 129 0: Other
 130
 131 1: 32x32 pixels 'file icon' (PNG only)
 132
 133 2: Other file icon
 134
 135 3: Cover (front)
 136
 137 4: Cover (back)
 138
 139 5: Leaflet page
 140
 141 6: Media (e.g. label side of CD)
 142
 143 7: Lead artist/lead performer/soloist
 144
 145 8: Artist/performer
 146
 147 9: Conductor
 148
 149 10: Band/Orchestra
 150
 151 11: Composer
 152
 153 12: Lyricist/text writer
 154
 155 13: Recording Location
 156
 157 14: During recording
 158
 159 15: During performance
 160
 161 16: Movie/video screen capture
 162
 163 17: A bright coloured fish
 164
 165 18: Illustration
 166
 167 19: Band/artist logotype
 168
 169 20: Publisher/Studio logotype
 170
 171 The default is 3 (front cover).  There may only be one picture each of type 1 and 2 in a file.
 172
 173 MIME-TYPE is mandatory; for best compatibility with players, use pictures with MIME type image/jpeg or image/png.  The MIME type can also be --> to mean that FILE is actually a URL to an image, though this use is discouraged.
 174
 175 DESCRIPTION is optional; the default is an empty string.
 176
 177 The next part specfies the resolution and color information.  If the MIME-TYPE is image/jpeg, image/png, or image/gif, you can usually leave this empty and they can be detected from the file.  Otherwise, you must specify the width in pixels, height in pixels, and color depth in bits-per-pixel.  If the image has indexed colors you should also specify the number of colors used.  When manually specified, it is not checked against the file for accuracy.
 178
 179 FILE is the path to the picture file to be imported, or the URL if MIME type is -->
 180
 181 For example, "|image/jpeg|||../cover.jpg" will embed the JPEG file at ../cover.jpg, defaulting to type 3 (front cover) and an empty description.  The resolution and color info will be retrieved from the file itself.
 182
 183 The specification "4|-->|CD|320x300x24/173|http://blah.blah/backcover.tiff" will embed the given URL, with type 4 (back cover), description "CD", and a manually specified resolution of 320x300, 24 bits-per-pixel, and 173 colors.  The file at the URL will not be fetched; the URL itself is stored in the PICTURE metadata block.
 184 .TP
 185 \fB--export-picture-to=file\fR
 186 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.
 187 .TP
 188 \fB--add-replay-gain\fR
 189 Calculates the title and album gains/peaks of the given FLAC
 190 files as if all the files were part of one album, then stores
 191 them in the VORBIS_COMMENT block.  The tags are the same as
 192 those used by vorbisgain.  Existing ReplayGain tags will be
 193 replaced.  If only one FLAC file is given, the album and title
 194 gains will be the same.  Since this operation requires two
 195 passes, it is always executed last, after all other operations
 196 have been completed and written to disk.  All FLAC files
 197 specified must have the same resolution, sample rate, and
 198 number of channels.  The sample rate must be one of 8, 11.025,
 199 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.
 200 .TP
 201 \fB--remove-replay-gain\fR
 202 Removes the ReplayGain tags.
 203 .TP
 204 \fB--add-seekpoint={\fI#\fB|\fIX\fB|\fI#x\fB|\fI#s\fB}\fR
 205 Add seek points to a SEEKTABLE block.  Using #, a seek point at
 206 that sample number is added.  Using X, a placeholder point is
 207 added at the end of a the table.  Using #x, # evenly spaced seek
 208 points will be added, the first being at sample 0.  Using #s, a
 209 seekpoint will be added every # seconds (# does not have to be a
 210 whole number; it can be, for example, 9.5, meaning a seekpoint
 211 every 9.5 seconds).  If no SEEKTABLE block exists, one will be
 212 created.  If one already exists, points will be added to the
 213 existing table, and any duplicates will be turned into placeholder
 214 points.  You may use many --add-seekpoint options; the resulting
 215 SEEKTABLE will be the unique-ified union of all such values.
 216 Example: --add-seekpoint=100x --add-seekpoint=3.5s will add 100
 217 evenly spaced seekpoints and a seekpoint every 3.5 seconds.
 218 .TP
 219 \fB--add-padding=length\fR
 220 Add a padding block of the given length (in bytes).  The overall
 221 length of the new block will be 4 + length; the extra 4 bytes is
 222 for the metadata block header.
 223 .SH "MAJOR OPERATIONS"
 224 .TP
 225 \fB--list\fR
 226 List the contents of one or more metadata blocks to stdout.  By
 227 default, all metadata blocks are listed in text format.  Use the
 228 following options to change this behavior:
 229 .RS
 230 .TP
 231 \fB--block-number=#[,#[...]]\fR
 232 An optional comma-separated list of block numbers to display.
 233 The first block, the STREAMINFO block, is block 0.
 234 .TP
 235 \fB--block-type=type[,type[...]]\fR
 236 .TP
 237 \fB--except-block-type=type[,type[...]]\fR
 238 An optional comma-separated list of block types to be included
 239 or ignored with this option.  Use only one of --block-type or
 240 --except-block-type.  The valid block types are: STREAMINFO,
 241 PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT.  You may
 242 narrow down the types of APPLICATION blocks displayed as
 243 follows:
 244
 245 APPLICATION:abcd        The APPLICATION block(s) whose textual repre-
 246 sentation of the 4-byte ID is "abcd"
 247 APPLICATION:0xXXXXXXXX  The APPLICATION block(s) whose hexadecimal big-
 248 endian representation of the 4-byte ID is
 249 "0xXXXXXXXX".  For the example "abcd" above the
 250 hexadecimal equivalalent is 0x61626364
 251 .sp
 252 .RS
 253 .B "Note:"
 254 if both --block-number and --[except-]block-type are
 255 specified, the result is the logical AND of both
 256 arguments.
 257 .RE
 258 .TP
 259 \fB--application-data-format=hexdump|text\fR
 260 If the application block you are displaying contains binary
 261 data but your --data-format=text, you can display a hex dump
 262 of the application data contents instead using
 263 --application-data-format=hexdump.
 264 .RE
 265 .TP
 266 \fB--remove\fR
 267 Remove one or more metadata blocks from the metadata.  Unless
 268 --dont-use-padding is specified, the blocks will be replaced with
 269 padding.  You may not remove the STREAMINFO block.
 270 .RS
 271 .TP
 272 \fB--block-number=#[,#[...]]\fR
 273 .TP
 274 \fB--block-type=type[,type[...]]\fR
 275 .TP
 276 \fB--except-block-type=type[,type[...]]\fR
 277 See --list above for usage.
 278 .sp
 279 .RS
 280 .B "Note:"
 281 if both --block-number and --[except-]block-type are
 282 specified, the result is the logical AND of both arguments.
 283 .RE
 284 .RE
 285 .TP
 286 \fB--remove-all\fR
 287 Remove all metadata blocks (except the STREAMINFO block) from the
 288 metadata.  Unless --dont-use-padding is specified, the blocks will
 289 be replaced with padding.
 290 .TP
 291 \fB--merge-padding\fR
 292 Merge adjacent PADDING blocks into single blocks.
 293 .TP
 294 \fB--sort-padding\fR
 295 Move all PADDING blocks to the end of the metadata and merge them
 296 into a single block.
 297 .SH "SEE ALSO"
 298 .PP
 299 flac(1).