Skip to content

GitLab

Commit d3b086bf authored by Josh Coalson's avatar Josh Coalson
Browse files

add documentation for flac's --picture option

parent 3957c470
Hide whitespace changes
Inline Side-by-side
Showing with 85 additions and 0 deletions
doc/html/documentation.html
View file @ d3b086bf
......@@ -529,6 +529,47 @@
The cuesheet file must be of the sort written by <a href="http://www.goldenhawk.com/cdrwin.htm">CDRwin</a>, <a href="http://www.dcsoft.com/prod03.htm">CDRcue</a>, <a href="http://www.exactaudiocopy.de/">EAC</a>, et al.
</td>
</tr>
<tr>
<td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
<a name="flac_options_picture" />
<span class="argument">--picture=SPECIFICATION</span>
</td>
<td>
Import a picture and store it in a <a href="format.html#def_PICTURE"><span class="code">PICTURE</span></a> metadata block. More than one <span class="argument">--picture</span> command can be specified. The <span class="argument">SPECIFICATION</span> is a string whose parts are separated by <span class="argument">|</span> (pipe) characters. Some parts may be left empty to invoke default values. The format of <span class="argument">SPECIFICATION</span> is<br /><br />
<tt>&nbsp;&nbsp;[TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE</tt><br /><br />
<span class="argument">TYPE</span> is optional; it is a number from one of:<br />
<tt><ul>
<li>0: Other</li>
<li>1: 32x32 pixels 'file icon' (PNG only)</li>
<li>2: Other file icon</li>
<li>3: Cover (front)</li>
<li>4: Cover (back)</li>
<li>5: Leaflet page</li>
<li>6: Media (e.g. label side of CD)</li>
<li>7: Lead artist/lead performer/soloist</li>
<li>8: Artist/performer</li>
<li>9: Conductor</li>
<li>10: Band/Orchestra</li>
<li>11: Composer</li>
<li>12: Lyricist/text writer</li>
<li>13: Recording Location</li>
<li>14: During recording</li>
<li>15: During performance</li>
<li>16: Movie/video screen capture</li>
<li>17: A bright coloured fish</li>
<li>18: Illustration</li>
<li>19: Band/artist logotype</li>
<li>20: Publisher/Studio logotype</li>
</ul></tt>
The default is 3 (front cover). There may only be one picture each of type 1 and 2 in a file.<br/><br />
<span class="argument">MIME-TYPE</span> is mandatory; for best compatibility with players, use pictures with MIME type <tt>image/jpeg</tt> or <tt>image/png</tt>. The MIME type can also be --&gt; to mean that <span class="argument">FILE</span> is actually a URL to an image, though this use is discouraged.<br /><br />
<span class="argument">DESCRIPTION</span> is optional; the default is an empty string.<br /><br />
The next part specfies the resolution and color information. If the <span class="argument">MIME-TYPE</span> is <tt>image/jpeg</tt>, <tt>image/png</tt>, or <tt>image/gif</tt>, 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.<br /><br />
<span class="argument">FILE</span> is the path to the picture file to be imported, or the URL if MIME type is --&gt;<br /><br />
For example, the specification <span class="argument">|image/jpeg|||../cover.jpg</span> will embed the JPEG file at <tt>../cover.jpg</tt>, defaulting to type 3 (front cover) and an empty description. The resolution and color info will be retrieved from the file itself.<br /><br />
The specification <span class="argument">4|--&gt;|CD|320x300x24/173|http://blah.blah/backcover.tiff</span> 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.
</td>
</tr>
<tr>
<td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
<a name="flac_options_sector_align" />
......
src/flac/main.c
View file @ d3b086bf
......@@ -1252,6 +1252,7 @@ void show_help()
printf(" --sector-align Align multiple files on sector boundaries\n");
printf(" --replay-gain Calculate ReplayGain & store in FLAC tags\n");
printf(" --cuesheet=FILENAME Import cuesheet and store in CUESHEET block\n");
printf(" --picture=SPECIFICATION Import picture and store in PICTURE block\n");
printf(" -T, --tag=FIELD=VALUE Add a FLAC tag; may appear multiple times\n");
printf(" --tag-from-file=FIELD=FILENAME Like --tag but gets value from file\n");
printf(" -S, --seekpoint={#|X|#x|#s} Add seek point(s)\n");
......@@ -1434,6 +1435,49 @@ void show_explain()
printf(" seekpoint will be added for each index point in\n");
printf(" the cuesheet to the SEEKTABLE unless\n");
printf(" --no-cued-seekpoints is specified.\n");
printf(" --picture=SPECIFICATION Import a picture and store it in a PICTURE block.\n");
printf(" More than one --picture command can be specified.\n");
printf(" The SPECIFICATION is a string whose parts are\n");
printf(" separated by | characters. Some parts may be\n");
printf(" left empty to invoke default values. The format:\n");
printf(" [TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE\n");
printf(" TYPE is optional; it is a number from one of:\n");
printf(" 0: Other\n");
printf(" 1: 32x32 pixels 'file icon' (PNG only)\n");
printf(" 2: Other file icon\n");
printf(" 3: Cover (front)\n");
printf(" 4: Cover (back)\n");
printf(" 5: Leaflet page\n");
printf(" 6: Media (e.g. label side of CD)\n");
printf(" 7: Lead artist/lead performer/soloist\n");
printf(" 8: Artist/performer\n");
printf(" 9: Conductor\n");
printf(" 10: Band/Orchestra\n");
printf(" 11: Composer\n");
printf(" 12: Lyricist/text writer\n");
printf(" 13: Recording Location\n");
printf(" 14: During recording\n");
printf(" 15: During performance\n");
printf(" 16: Movie/video screen capture\n");
printf(" 17: A bright coloured fish\n");
printf(" 18: Illustration\n");
printf(" 19: Band/artist logotype\n");
printf(" 20: Publisher/Studio logotype\n");
printf(" The default is 3 (front cover). There may only be one picture each\n");
printf(" of type 1 and 2 in a file.\n");
printf(" MIME-TYPE is mandatory; for best compatibility with players, use\n");
printf(" pictures with MIME type image/jpeg or image/png. The MIME type can\n");
printf(" also be --> to mean that FILE is actually a URL to an image, though\n");
printf(" this use is discouraged.\n");
printf(" DESCRIPTION is optional; the default is an empty string\n");
printf(" The next part specfies the resolution and color information. If\n");
printf(" the MIME-TYPE is image/jpeg, image/png, or image/gif, you can\n");
printf(" usually leave this empty and they can be detected from the file.\n");
printf(" Otherwise, you must specify the width in pixels, height in pixels,\n");
printf(" and color depth in bits-per-pixel. If the image has indexed colors\n");
printf(" you should also specify the number of colors used.\n");
printf(" FILE is the path to the picture file to be imported, or the URL if\n");
printf(" MIME type is -->\n");
printf(" -T, --tag=FIELD=VALUE Add a FLAC tag. Make sure to quote the\n");
printf(" comment if necessary. This option may appear\n");
printf(" more than once to add several comments. NOTE:\n");
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment