annotate src/flac-1.2.1/doc/html/documentation_tools_metaflac.html @ 86:98c1576536ae

Bring in flac, ogg, vorbis
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
cannam@86 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
cannam@86 2 <!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson -->
cannam@86 3 <!-- Permission is granted to copy, distribute and/or modify this document -->
cannam@86 4 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
cannam@86 5 <!-- or any later version published by the Free Software Foundation; -->
cannam@86 6 <!-- with no invariant sections. -->
cannam@86 7 <!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
cannam@86 8 <html>
cannam@86 9 <head>
cannam@86 10 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
cannam@86 11 <meta name="author" content="Josh Coalson" />
cannam@86 12 <meta name="description" content="A free, open source codec for lossless audio compression and decompression" />
cannam@86 13 <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" />
cannam@86 14 <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" />
cannam@86 15 <link rel="stylesheet" type="text/css" href="flac.css" />
cannam@86 16 <title>FLAC - documentation</title>
cannam@86 17 </head>
cannam@86 18
cannam@86 19 <body>
cannam@86 20
cannam@86 21 <div class="logo">
cannam@86 22 <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a>
cannam@86 23 </div>
cannam@86 24
cannam@86 25 <div class="above_nav"></div>
cannam@86 26
cannam@86 27 <div class="navbar">
cannam@86 28 &nbsp;<a href="index.html">home</a>&nbsp;&nbsp;|
cannam@86 29 &nbsp;<a href="faq.html">faq</a>&nbsp;&nbsp;|
cannam@86 30 &nbsp;<a href="news.html">news</a>&nbsp;&nbsp;|
cannam@86 31 &nbsp;<a href="download.html">download</a>&nbsp;&nbsp;|
cannam@86 32 &nbsp;<a href="documentation.html">documentation</a>&nbsp;&nbsp;|
cannam@86 33 &nbsp;<a href="comparison.html">comparison</a>&nbsp;&nbsp;|
cannam@86 34 &nbsp;<a href="changelog.html">changelog</a>&nbsp;&nbsp;|
cannam@86 35 &nbsp;<a href="links.html">links</a>&nbsp;&nbsp;|
cannam@86 36 &nbsp;<a href="developers.html">developers</a>&nbsp;
cannam@86 37 </div>
cannam@86 38
cannam@86 39 <div class="langbar">
cannam@86 40 &nbsp;english&nbsp;&nbsp;|
cannam@86 41 &nbsp;<a href="ru/documentation.html">russian</a>&nbsp;
cannam@86 42 </div>
cannam@86 43
cannam@86 44 <div class="below_nav"></div>
cannam@86 45
cannam@86 46 <div class="box">
cannam@86 47 <div class="box_title">
cannam@86 48 <a name="metaflac">metaflac</a>
cannam@86 49 </div>
cannam@86 50 <div class="box_header"></div>
cannam@86 51 <div class="box_body">
cannam@86 52 <a name="toc"><font size="+1"><b><u>Table of Contents</u></b></font></a>
cannam@86 53 <ul>
cannam@86 54 <li><a href="#usage">General Usage</a></li>
cannam@86 55 <li><a href="#global_options">Global Options</a></li>
cannam@86 56 <li><a href="#shorthand_operations">Shorthand Operations</a></li>
cannam@86 57 <li><a href="#major_operations">Major Operations</a></li>
cannam@86 58 <li><a href="#option_index">Option Index</a></li>
cannam@86 59 </ul>
cannam@86 60 <a name="usage"><font size="+1"><b><u>General Usage</u></b></font></a><br />
cannam@86 61 <br />
cannam@86 62 <span class="commandname">metaflac</span> is the command-line <span class="code">.flac</span> file metadata editor. You can use it to list the contents of metadata blocks, edit, delete or insert blocks, and manage padding.<br />
cannam@86 63 <br />
cannam@86 64 <span class="commandname">metaflac</span> 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 65 <ul>
cannam@86 66 <li>
cannam@86 67 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.
cannam@86 68 </li>
cannam@86 69 <li>
cannam@86 70 Shorthand operations, which are convenient synonyms for major operations. For example, there is a shorthand operation <span class="argument">--show-sample-rate</span> that shows just the sample rate field from the <span class="code">STREAMINFO</span> metadata block.
cannam@86 71 </li>
cannam@86 72 <li>
cannam@86 73 Global options, which affect all the operations.
cannam@86 74 </li>
cannam@86 75 </ul>
cannam@86 76 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:<br />
cannam@86 77 <br />
cannam@86 78 <span class="code">metaflac --show-md5sum file1.flac file2.flac file3.flac</span><br />
cannam@86 79 <br />
cannam@86 80 Another example; this removes all DESCRIPTION and COMMENT tags in a set of FLAC files, and uses the <span class="argument">--preserve-modtime</span> 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):<br />
cannam@86 81 <br />
cannam@86 82 <span class="code">metaflac --preserve-modtime --remove-tag=DESCRIPTION --remove-tag=COMMENT file1.flac file2.flac file3.flac</span><br />
cannam@86 83 <br />
cannam@86 84
cannam@86 85 <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td>
cannam@86 86 <table width="100%" border="1" bgcolor="#EEEED4">
cannam@86 87 <tr>
cannam@86 88 <td colspan="2" bgcolor="#D3D4C5">
cannam@86 89 <a name="global_options"><font size="+1"><b>Global Options</b></font></a>
cannam@86 90 </td>
cannam@86 91 </tr>
cannam@86 92 <tr>
cannam@86 93 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 94 <a name="metaflac_options_preserve_modtime" />
cannam@86 95 <span class="argument">--preserve-modtime</span>
cannam@86 96 </td>
cannam@86 97 <td>
cannam@86 98 Preserve the original modification time in spite of edits.
cannam@86 99 </td>
cannam@86 100 </tr>
cannam@86 101 <tr>
cannam@86 102 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 103 <a name="metaflac_options_with_filename" />
cannam@86 104 <span class="argument">--with-filename</span>
cannam@86 105 </td>
cannam@86 106 <td>
cannam@86 107 Prefix each output line with the FLAC file name (the default if more than one FLAC file is specified).
cannam@86 108 </td>
cannam@86 109 </tr>
cannam@86 110 <tr>
cannam@86 111 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 112 <a name="metaflac_options_no_filename" />
cannam@86 113 <span class="argument">--no-filename</span>
cannam@86 114 </td>
cannam@86 115 <td>
cannam@86 116 Do not prefix each output line with the FLAC file name (the default if only one FLAC file is specified)
cannam@86 117 </td>
cannam@86 118 </tr>
cannam@86 119 <tr>
cannam@86 120 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 121 <a name="metaflac_options_no_utf8_convert" />
cannam@86 122 <span class="argument">--no-utf8-convert</span>
cannam@86 123 </td>
cannam@86 124 <td>
cannam@86 125 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 126 </td>
cannam@86 127 </tr>
cannam@86 128 <tr>
cannam@86 129 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 130 <a name="metaflac_options_dont_use_padding" />
cannam@86 131 <span class="argument">--dont-use-padding</span>
cannam@86 132 </td>
cannam@86 133 <td>
cannam@86 134 By default <span class="commandname">metaflac</span> 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 135 </td>
cannam@86 136 </tr>
cannam@86 137 </table>
cannam@86 138 </td></tr></table>
cannam@86 139
cannam@86 140 <br />
cannam@86 141
cannam@86 142 <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td>
cannam@86 143 <table width="100%" border="1" bgcolor="#EEEED4">
cannam@86 144 <tr>
cannam@86 145 <td colspan="2" bgcolor="#D3D4C5">
cannam@86 146 <a name="shorthand_operations"><font size="+1"><b>Shorthand Operations</b></font></a>
cannam@86 147 </td>
cannam@86 148 </tr>
cannam@86 149 <tr>
cannam@86 150 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 151 <a name="metaflac_shorthand_show_md5sum" />
cannam@86 152 <span class="argument">--show-md5sum</span>
cannam@86 153 </td>
cannam@86 154 <td>
cannam@86 155 Show the MD5 signature from the <span class="code">STREAMINFO</span> block.
cannam@86 156 </td>
cannam@86 157 </tr>
cannam@86 158 <tr>
cannam@86 159 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 160 <a name="metaflac_shorthand_show_min_blocksize" />
cannam@86 161 <span class="argument">--show-min-blocksize</span>
cannam@86 162 </td>
cannam@86 163 <td>
cannam@86 164 Show the minimum block size from the <span class="code">STREAMINFO</span> block.
cannam@86 165 </td>
cannam@86 166 </tr>
cannam@86 167 <tr>
cannam@86 168 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 169 <a name="metaflac_shorthand_show_max_blocksize" />
cannam@86 170 <span class="argument">--show-max-blocksize</span>
cannam@86 171 </td>
cannam@86 172 <td>
cannam@86 173 Show the maximum block size from the <span class="code">STREAMINFO</span> block.
cannam@86 174 </td>
cannam@86 175 </tr>
cannam@86 176 <tr>
cannam@86 177 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 178 <a name="metaflac_shorthand_show_min_framesize" />
cannam@86 179 <span class="argument">--show-min-framesize</span>
cannam@86 180 </td>
cannam@86 181 <td>
cannam@86 182 Show the minimum frame size from the <span class="code">STREAMINFO</span> block.
cannam@86 183 </td>
cannam@86 184 </tr>
cannam@86 185 <tr>
cannam@86 186 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 187 <a name="metaflac_shorthand_show_max_framesize" />
cannam@86 188 <span class="argument">--show-max-framesize</span>
cannam@86 189 </td>
cannam@86 190 <td>
cannam@86 191 Show the maximum frame size from the <span class="code">STREAMINFO</span> block.
cannam@86 192 </td>
cannam@86 193 </tr>
cannam@86 194 <tr>
cannam@86 195 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 196 <a name="metaflac_shorthand_show_sample_rate" />
cannam@86 197 <span class="argument">--show-sample-rate</span>
cannam@86 198 </td>
cannam@86 199 <td>
cannam@86 200 Show the sample rate from the <span class="code">STREAMINFO</span> block.
cannam@86 201 </td>
cannam@86 202 </tr>
cannam@86 203 <tr>
cannam@86 204 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 205 <a name="metaflac_shorthand_show_channels" />
cannam@86 206 <span class="argument">--show-channels</span>
cannam@86 207 </td>
cannam@86 208 <td>
cannam@86 209 Show the number of channels from the <span class="code">STREAMINFO</span> block.
cannam@86 210 </td>
cannam@86 211 </tr>
cannam@86 212 <tr>
cannam@86 213 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 214 <a name="metaflac_shorthand_show_bps" />
cannam@86 215 <span class="argument">--show-bps</span>
cannam@86 216 </td>
cannam@86 217 <td>
cannam@86 218 Show the # of bits per sample from the <span class="code">STREAMINFO</span> block.
cannam@86 219 </td>
cannam@86 220 </tr>
cannam@86 221 <tr>
cannam@86 222 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 223 <a name="metaflac_shorthand_show_total_samples" />
cannam@86 224 <span class="argument">--show-total-samples</span>
cannam@86 225 </td>
cannam@86 226 <td>
cannam@86 227 Show the total # of samples from the <span class="code">STREAMINFO</span> block.
cannam@86 228 </td>
cannam@86 229 </tr>
cannam@86 230 <tr>
cannam@86 231 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 232 <a name="metaflac_shorthand_show_vendor_tag" />
cannam@86 233 <span class="argument">--show-vendor-tag</span>
cannam@86 234 </td>
cannam@86 235 <td>
cannam@86 236 Show the vendor string from the <span class="code">VORBIS_COMMENT</span> block.
cannam@86 237 </td>
cannam@86 238 </tr>
cannam@86 239 <tr>
cannam@86 240 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 241 <a name="metaflac_shorthand_show_tag" />
cannam@86 242 <span class="argument">--show-tag=NAME</span>
cannam@86 243 </td>
cannam@86 244 <td>
cannam@86 245 Show all tags where the the field name matches <span class="argument">NAME</span>.
cannam@86 246 </td>
cannam@86 247 </tr>
cannam@86 248 <tr>
cannam@86 249 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 250 <a name="metaflac_shorthand_remove_tag" />
cannam@86 251 <span class="argument">--remove-tag=NAME</span>
cannam@86 252 </td>
cannam@86 253 <td>
cannam@86 254 Remove all tags whose field name is <span class="argument">NAME</span>.
cannam@86 255 </td>
cannam@86 256 </tr>
cannam@86 257 <tr>
cannam@86 258 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 259 <a name="metaflac_shorthand_remove_first_tag" />
cannam@86 260 <span class="argument">--remove-first-tag=NAME</span>
cannam@86 261 </td>
cannam@86 262 <td>
cannam@86 263 Remove first tag whose field name is <span class="argument">NAME</span>.
cannam@86 264 </td>
cannam@86 265 </tr>
cannam@86 266 <tr>
cannam@86 267 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 268 <a name="metaflac_shorthand_remove_all_tags" />
cannam@86 269 <span class="argument">--remove-all-tags</span>
cannam@86 270 </td>
cannam@86 271 <td>
cannam@86 272 Remove all tags, leaving only the vendor string.
cannam@86 273 </td>
cannam@86 274 </tr>
cannam@86 275 <tr>
cannam@86 276 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 277 <a name="metaflac_shorthand_set_tag" />
cannam@86 278 <span class="argument">--set-tag=FIELD</span>
cannam@86 279 </td>
cannam@86 280 <td>
cannam@86 281 Add a tag. The <span class="argument">FIELD</span> must comply with the Vorbis comment spec, of the form <span class="argument">NAME=VALUE</span>. If there is currently no tag block, one will be created.
cannam@86 282 </td>
cannam@86 283 </tr>
cannam@86 284 <tr>
cannam@86 285 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 286 <a name="metaflac_shorthand_set_tag_from_file" />
cannam@86 287 <span class="argument">--set-tag-from-file=FIELD</span>
cannam@86 288 </td>
cannam@86 289 <td>
cannam@86 290 Like <a href="#metaflac_shorthand_set_tag"><span class="argument">--set-tag</span></a>, except the VALUE is a filename whose contents will be read verbatim to set the tag value. Unless <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> 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. <span class="argument">--set-tag-from-file="CUESHEET=image.cue"</span>). Do not try to store binary data in tag fields! Use APPLICATION blocks for that.
cannam@86 291 </td>
cannam@86 292 </tr>
cannam@86 293 <tr>
cannam@86 294 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 295 <a name="metaflac_shorthand_import_tags_from" />
cannam@86 296 <span class="argument">--import-tags-from=FILE</span>
cannam@86 297 </td>
cannam@86 298 <td>
cannam@86 299 Import tags from a file. Use <span class="argument">-</span> for stdin. Each line should be of the form <span class="argument">NAME=VALUE</span>. Multi-line comments are currently not supported. Specify <span class="argument">--remove-all-tags</span> and/or <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> before <span class="argument">--import-tags-from</span> if necessary. If <span class="argument">FILE</span> is <span class="argument">-</span> (stdin), only one FLAC file may be specified.
cannam@86 300 </td>
cannam@86 301 </tr>
cannam@86 302 <tr>
cannam@86 303 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 304 <a name="metaflac_shorthand_export_tags_to" />
cannam@86 305 <span class="argument">--export-tags-to=FILE</span>
cannam@86 306 </td>
cannam@86 307 <td>
cannam@86 308 Export tags to a file. Use <span class="argument">-</span> for stdin. Each line will be of the form <span class="argument">NAME=VALUE</span>. Specify <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> if necessary.
cannam@86 309 </td>
cannam@86 310 </tr>
cannam@86 311 <tr>
cannam@86 312 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 313 <a name="metaflac_shorthand_import_cuesheet_from" />
cannam@86 314 <span class="argument">--import-cuesheet-from=FILE</span>
cannam@86 315 </td>
cannam@86 316 <td>
cannam@86 317 Import a cuesheet from a file. Use <span class="argument">-</span> for stdin. Only one FLAC file may be specified. A seekpoint will be added for each index point in the cuesheet to the <span class="code">SEEKTABLE</span> unless <span class="argument">--no-cued-seekpoints</span> is specified.
cannam@86 318 </td>
cannam@86 319 </tr>
cannam@86 320 <tr>
cannam@86 321 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 322 <a name="metaflac_shorthand_export_cuesheet_to" />
cannam@86 323 <span class="argument">--export-cuesheet-to=FILE</span>
cannam@86 324 </td>
cannam@86 325 <td>
cannam@86 326 Export <span class="code">CUESHEET</span> block to a cuesheet file, suitable for use by CD authoring software. Use <span class="argument">-</span> for stdout. Only one FLAC file may be specified on the command line.
cannam@86 327 </td>
cannam@86 328 </tr>
cannam@86 329 <tr>
cannam@86 330 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 331 <a name="metaflac_shorthand_import_picture_from" />
cannam@86 332 <span class="argument">--import-picture-from={FILENAME|SPECIFICATION}</span>
cannam@86 333 </td>
cannam@86 334 <td>
cannam@86 335 Import a picture and store it in a <a href="format.html#def_PICTURE"><span class="code">PICTURE</span></a> metadata block. See the <span class="commandname">flac</span> option <span class="argument"><a href="documentation_tools_flac.html#flac_options_picture">--picture</a></span> for an explanation of the <span class="argument">SPECIFICATION</span> syntax.
cannam@86 336 </td>
cannam@86 337 </tr>
cannam@86 338 <tr>
cannam@86 339 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 340 <a name="metaflac_shorthand_export_picture_to" />
cannam@86 341 <span class="argument">--export-picture-to=FILE</span>
cannam@86 342 </td>
cannam@86 343 <td>
cannam@86 344 Export <span class="code">PICTURE</span> block to a file. Use <span class="argument">-</span> for stdout. Only one FLAC file may be specified on the command line. The first <span class="code">PICTURE</span> block will be exported unless <span class="argument">--export-picture-to</span> is preceded by a <span class="argument">--block-number=#</span> option to specify the exact metadata block to extract. Note that the block number is the one shown by --list.
cannam@86 345 </td>
cannam@86 346 </tr>
cannam@86 347 <tr>
cannam@86 348 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 349 <a name="metaflac_shorthand_add_replay_gain" />
cannam@86 350 <span class="argument">--add-replay-gain</span>
cannam@86 351 </td>
cannam@86 352 <td>
cannam@86 353 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 <span class="commandname">vorbisgain</span>. 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 354 </td>
cannam@86 355 </tr>
cannam@86 356 <tr>
cannam@86 357 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 358 <a name="metaflac_shorthand_remove_replay_gain" />
cannam@86 359 <span class="argument">--remove-replay-gain</span>
cannam@86 360 </td>
cannam@86 361 <td>
cannam@86 362 Removes the ReplayGain tags.
cannam@86 363 </td>
cannam@86 364 </tr>
cannam@86 365 <tr>
cannam@86 366 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 367 <a name="metaflac_shorthand_add_seekpoint" />
cannam@86 368 <span class="argument">--add-seekpoint={#|X|#x|#s}</span>
cannam@86 369 </td>
cannam@86 370 <td>
cannam@86 371 Add seek points to a <span class="code">SEEKTABLE</span> block:<br />
cannam@86 372 <ul>
cannam@86 373 <li>
cannam@86 374 <span class="argument">#&nbsp;</span> : a specific sample number for a seek point
cannam@86 375 </li>
cannam@86 376 <li>
cannam@86 377 <span class="argument">X&nbsp;</span> : a placeholder point (always goes at the end of the <span class="code">SEEKTABLE</span>)
cannam@86 378 </li>
cannam@86 379 <li>
cannam@86 380 <span class="argument">#x</span> : # evenly spaced seekpoints, the first being at sample 0
cannam@86 381 </li>
cannam@86 382 <li>
cannam@86 383 <span class="argument">#s</span> : a seekpoint every # seconds; # does not have to be a whole number, it can be, for example, <span class="argument">9.5</span>, meaning a seekpoint every 9.5 seconds
cannam@86 384 </li>
cannam@86 385 </ul>
cannam@86 386 If no <span class="code">SEEKTABLE</span> 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.<br />
cannam@86 387 You may use many <span class="argument">--add-seekpoint</span> options; the resulting <span class="code">SEEKTABLE</span> will be the unique-ified union of all such values. Example: <span class="argument">--add-seekpoint=100x --add-seekpoint=3.5s</span> will add 100 evenly spaced seekpoints and a seekpoint every 3.5 seconds.<br />
cannam@86 388 </td>
cannam@86 389 </tr>
cannam@86 390 <tr>
cannam@86 391 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 392 <a name="metaflac_shorthand_add_padding" />
cannam@86 393 <span class="argument">--add-padding=#</span>
cannam@86 394 </td>
cannam@86 395 <td>
cannam@86 396 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 397 </td>
cannam@86 398 </tr>
cannam@86 399 </table>
cannam@86 400 </td></tr></table>
cannam@86 401
cannam@86 402 <br />
cannam@86 403
cannam@86 404 <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td>
cannam@86 405 <table width="100%" border="1" bgcolor="#EEEED4">
cannam@86 406 <tr>
cannam@86 407 <td colspan="2" bgcolor="#D3D4C5">
cannam@86 408 <a name="major_operations"><font size="+1"><b>Major Operations</b></font></a>
cannam@86 409 </td>
cannam@86 410 </tr>
cannam@86 411 <tr>
cannam@86 412 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 413 <a name="metaflac_operations_version" />
cannam@86 414 <span class="argument">--version</span>
cannam@86 415 </td>
cannam@86 416 <td>
cannam@86 417 Show the metaflac version number.
cannam@86 418 </td>
cannam@86 419 </tr>
cannam@86 420 <tr>
cannam@86 421 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 422 <a name="metaflac_operations_list" />
cannam@86 423 <span class="argument">--list</span>
cannam@86 424 </td>
cannam@86 425 <td>
cannam@86 426 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:<br />
cannam@86 427 <br />
cannam@86 428
cannam@86 429 <span class="argument">--block-number=#[,#[...]]</span><br />
cannam@86 430 An optional comma-separated list of block numbers to display. The first block, the <span class="code">STREAMINFO</span> block, is block 0.<br />
cannam@86 431 <br />
cannam@86 432
cannam@86 433 <span class="argument">--block-type=type[,type[...]]</span><br />
cannam@86 434 <span class="argument">--except-block-type=type[,type[...]]</span><br />
cannam@86 435 An optional comma-separated list of block types to be included or ignored with this option. Use only one of <span class="argument">--block-type</span> or <span class="argument">--except-block-type</span>. The valid block types are: <span class="code">STREAMINFO</span>, <span class="code">PADDING</span>, <span class="code">APPLICATION</span>, <span class="code">SEEKTABLE</span>, <span class="code">VORBIS_COMMENT</span>. You may narrow down the types of <span class="code">APPLICATION</span> blocks displayed as follows:<br />
cannam@86 436 <table border="1">
cannam@86 437 <tr>
cannam@86 438 <td><span class="argument">APPLICATION:abcd</span></td>
cannam@86 439 <td>The <span class="code">APPLICATION</span> block(s) whose textual representation of the 4-byte ID is "abcd"</td>
cannam@86 440 </tr>
cannam@86 441 <tr>
cannam@86 442 <td><span class="argument">APPLICATION:0xXXXXXXXX</span></td>
cannam@86 443 <td>The <span class="code">APPLICATION</span> block(s) whose hexadecimal big- endian representation of the 4-byte ID is "0xXXXXXXXX". For the example "abcd" above the hexadecimal equivalalent is 0x61626364</td>
cannam@86 444 </tr>
cannam@86 445 </table>
cannam@86 446 <br />
cannam@86 447
cannam@86 448 NOTE: if both <span class="argument">--block-number</span> and <span class="argument">--[except-]block-type</span> are specified, the result is the logical AND of both arguments.<br />
cannam@86 449 <br />
cannam@86 450
cannam@86 451 <span class="argument">--application-data-format=hexdump|text</span><br />
cannam@86 452 If the application block you are displaying contains binary data but your <span class="argument">--data-format=text</span>, you can display a hex dump of the application data contents instead using <span class="argument">--application-data-format=hexdump</span>.
cannam@86 453 </td>
cannam@86 454 </tr>
cannam@86 455 <tr>
cannam@86 456 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 457 <a name="metaflac_operations_remove" />
cannam@86 458 <span class="argument">--remove</span>
cannam@86 459 </td>
cannam@86 460 <td>
cannam@86 461 Remove one or more metadata blocks from the metadata. Unless <span class="argument">--dont-use-padding</span> is specified, the blocks will be replaced with padding. You may not remove the <span class="code">STREAMINFO</span> block.<br />
cannam@86 462 <br />
cannam@86 463
cannam@86 464 <span class="argument">--block-number=#[,#[...]]</span><br />
cannam@86 465 <span class="argument">--block-type=type[,type[...]]</span><br />
cannam@86 466 <span class="argument">--except-block-type=type[,type[...]]</span><br />
cannam@86 467 See <a href="#metaflac_operations_list"><span class="argument">--list</span></a> above for usage.<br />
cannam@86 468 <br />
cannam@86 469
cannam@86 470 NOTE: if both <span class="argument">--block-number</span> and <span class="argument">--[except-]block-type</span> are specified, the result is the logical AND of both arguments.
cannam@86 471 </td>
cannam@86 472 </tr>
cannam@86 473 <tr>
cannam@86 474 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 475 <a name="metaflac_operations_remove_all" />
cannam@86 476 <span class="argument">--remove-all</span>
cannam@86 477 </td>
cannam@86 478 <td>
cannam@86 479 Remove all metadata blocks (except the <span class="code">STREAMINFO</span> block) from the metadata. Unless <span class="argument">--dont-use-padding</span> is specified, the blocks will be replaced with padding.
cannam@86 480 </td>
cannam@86 481 </tr>
cannam@86 482 <tr>
cannam@86 483 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 484 <a name="metaflac_operations_merge_padding" />
cannam@86 485 <span class="argument">--merge-padding</span>
cannam@86 486 </td>
cannam@86 487 <td>
cannam@86 488 Merge adjacent <span class="code">PADDING</span> blocks into single blocks.
cannam@86 489 </td>
cannam@86 490 </tr>
cannam@86 491 <tr>
cannam@86 492 <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
cannam@86 493 <a name="metaflac_operations_sort_padding" />
cannam@86 494 <span class="argument">--sort-padding</span>
cannam@86 495 </td>
cannam@86 496 <td>
cannam@86 497 Move all <span class="code">PADDING</span> blocks to the end of the metadata and merge them into a single block.
cannam@86 498 </td>
cannam@86 499 </tr>
cannam@86 500 </table>
cannam@86 501 </td></tr></table>
cannam@86 502
cannam@86 503 <br />
cannam@86 504 <a name="option_index"><font size="+1"><b><u>Option Index</u></b></font></a><br />
cannam@86 505 <br />
cannam@86 506 <a href="#metaflac_shorthand_add_padding" /><span class="argument">--add-padding</span></a><br />
cannam@86 507 <a href="#metaflac_shorthand_add_replay_gain" /><span class="argument">--add-replay-gain</span></a><br />
cannam@86 508 <a href="#metaflac_shorthand_add_seekpoint" /><span class="argument">--add-seekpoint</span></a><br />
cannam@86 509 <a href="#metaflac_options_dont_use_padding" /><span class="argument">--dont-use-padding</span></a><br />
cannam@86 510 <a href="#metaflac_shorthand_export_cuesheet_to" /><span class="argument">--export-cuesheet-to</span></a><br />
cannam@86 511 <a href="#metaflac_shorthand_export_picture_to" /><span class="argument">--export-picture-to</span></a><br />
cannam@86 512 <a href="#metaflac_shorthand_export_tags_to" /><span class="argument">--export-tags-to</span></a><br />
cannam@86 513 <a href="#metaflac_shorthand_import_cuesheet_from" /><span class="argument">--import-cuesheet-from</span></a><br />
cannam@86 514 <a href="#metaflac_shorthand_import_picture_from" /><span class="argument">--import-picture-from</span></a><br />
cannam@86 515 <a href="#metaflac_shorthand_import_tags_from" /><span class="argument">--import-tags-from</span></a><br />
cannam@86 516 <a href="#metaflac_operations_list" /><span class="argument">--list</span></a><br />
cannam@86 517 <a href="#metaflac_operations_merge_padding" /><span class="argument">--merge-padding</span></a><br />
cannam@86 518 <a href="#metaflac_options_no_filename" /><span class="argument">--no-filename</span></a><br />
cannam@86 519 <a href="#metaflac_options_no_utf8_convert" /><span class="argument">--no-utf8-convert</span></a><br />
cannam@86 520 <a href="#metaflac_options_preserve_modtime" /><span class="argument">--preserve-modtime</span></a><br />
cannam@86 521 <a href="#metaflac_shorthand_remove_all_tags" /><span class="argument">--remove-all-tags</span></a><br />
cannam@86 522 <a href="#metaflac_operations_remove_all" /><span class="argument">--remove-all</span></a><br />
cannam@86 523 <a href="#metaflac_shorthand_remove_first_tag" /><span class="argument">--remove-first-tag</span></a><br />
cannam@86 524 <a href="#metaflac_shorthand_remove_replay_gain" /><span class="argument">--remove-replay-gain</span></a><br />
cannam@86 525 <a href="#metaflac_shorthand_remove_tag" /><span class="argument">--remove-tag</span></a><br />
cannam@86 526 <a href="#metaflac_operations_remove" /><span class="argument">--remove</span></a><br />
cannam@86 527 <a href="#metaflac_shorthand_set_tag_from_file" /><span class="argument">--set-tag-from-file</span></a><br />
cannam@86 528 <a href="#metaflac_shorthand_set_tag" /><span class="argument">--set-tag</span></a><br />
cannam@86 529 <a href="#metaflac_shorthand_show_bps" /><span class="argument">--show-bps</span></a><br />
cannam@86 530 <a href="#metaflac_shorthand_show_channels" /><span class="argument">--show-channels</span></a><br />
cannam@86 531 <a href="#metaflac_shorthand_show_max_blocksize" /><span class="argument">--show-max-blocksize</span></a><br />
cannam@86 532 <a href="#metaflac_shorthand_show_max_framesize" /><span class="argument">--show-max-framesize</span></a><br />
cannam@86 533 <a href="#metaflac_shorthand_show_md5sum" /><span class="argument">--show-md5sum</span></a><br />
cannam@86 534 <a href="#metaflac_shorthand_show_min_blocksize" /><span class="argument">--show-min-blocksize</span></a><br />
cannam@86 535 <a href="#metaflac_shorthand_show_min_framesize" /><span class="argument">--show-min-framesize</span></a><br />
cannam@86 536 <a href="#metaflac_shorthand_show_sample_rate" /><span class="argument">--show-sample-rate</span></a><br />
cannam@86 537 <a href="#metaflac_shorthand_show_tag" /><span class="argument">--show-tag</span></a><br />
cannam@86 538 <a href="#metaflac_shorthand_show_total_samples" /><span class="argument">--show-total-samples</span></a><br />
cannam@86 539 <a href="#metaflac_shorthand_show_vendor_tag" /><span class="argument">--show-vendor-tag</span></a><br />
cannam@86 540 <a href="#metaflac_operations_sort_padding" /><span class="argument">--sort-padding</span></a><br />
cannam@86 541 <a href="#metaflac_operations_version" /><span class="argument">--version</span></a><br />
cannam@86 542 <a href="#metaflac_options_with_filename" /><span class="argument">--with-filename</span></a><br />
cannam@86 543
cannam@86 544 </div>
cannam@86 545 <div class="box_footer"></div>
cannam@86 546 </div>
cannam@86 547
cannam@86 548
cannam@86 549 <div class="copyright">
cannam@86 550 <!-- @@@ oh so hacky -->
cannam@86 551 <table>
cannam@86 552 <tr>
cannam@86 553 <td align="left">
cannam@86 554 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson
cannam@86 555 </td>
cannam@86 556 <td width="1%" align="right">
cannam@86 557 <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
cannam@86 558 </td>
cannam@86 559 <td width="1%" align="right">
cannam@86 560 <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br />
cannam@86 561 </td>
cannam@86 562 <td width="1%" align="right">
cannam@86 563 <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a>
cannam@86 564 </td>
cannam@86 565 </tr>
cannam@86 566 </table>
cannam@86 567 </div>
cannam@86 568
cannam@86 569 </body>
cannam@86 570 </html>