From d3b086bfb13b47121e749e3403e9f481115314e4 Mon Sep 17 00:00:00 2001 From: Josh Coalson Date: Mon, 25 Sep 2006 05:14:50 +0000 Subject: [PATCH] add documentation for flac's --picture option --- doc/html/documentation.html | 41 +++++++++++++++++++++++++++++++++++++++++ src/flac/main.c | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 85 insertions(+) diff --git a/doc/html/documentation.html b/doc/html/documentation.html index 835ce61..fc20b80 100644 --- a/doc/html/documentation.html +++ b/doc/html/documentation.html @@ -531,6 +531,47 @@ + + --picture=SPECIFICATION + + + Import a picture and store it in a PICTURE metadata block. More than one --picture 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

+   [TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE

+ TYPE is optional; it is a number from one of:
+ + The default is 3 (front cover). There may only be one picture each of type 1 and 2 in a file.

+ 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.

+ DESCRIPTION is optional; the default is an empty string.

+ 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.

+ FILE is the path to the picture file to be imported, or the URL if MIME type is -->

+ For example, the specification |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.

+ 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. + + + + --sector-align diff --git a/src/flac/main.c b/src/flac/main.c index f080f76..a785db5 100644 --- a/src/flac/main.c +++ b/src/flac/main.c @@ -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"); -- 2.7.4