Skip to content

Commit 89e8408

Browse files
authored
More list formatting in flac.md
Trying to get both itemized list and the PICTURE TYPE "numbered list" (starting at zero) to look decent in man and markdown.
1 parent 7b1592e commit 89e8408

File tree

1 file changed

+55
-61
lines changed

1 file changed

+55
-61
lines changed

man/flac.md

Lines changed: 55 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -745,65 +745,59 @@ flac uses the ReplayGain tags for the calculation. If a stream does
745745
not have the required tags or they can't be parsed, decoding will
746746
continue with a warning, and no ReplayGain is applied to that stream.
747747

748-
## Picture specification
749-
This described the specification used for the **\--picture** option.
750-
\[*TYPE*\]\|\[*MIME-TYPE*\]\|\[*DESCRIPTION*\]\|\[*WIDTHxHEIGHTxDEPTH*\[/*COLORS*\]\]\|*FILE*
751-
752-
*TYPE* is optional; it is a number from one of:
753-
754-
0. Other
755-
1. PNG file icon of 32x32 pixels (see RFC 2083)
756-
2. General file icon
757-
3. Front cover
758-
4. Back cover
759-
5. Liner notes page
760-
6. Media label (e.g., CD, Vinyl or Cassette label)
761-
7. Lead artist, lead performer, or soloist
762-
8. Artist or performer
763-
9. Conductor
764-
10. Band or orchestra
765-
11. Composer
766-
12. Lyricist or text writer
767-
13. Recording location
768-
14. During recording
769-
15. During performance
770-
16. Movie or video screen capture
771-
17. A bright colored fish (from ID3v2, use discouraged)
772-
18. Illustration
773-
19. Band or artist logotype
774-
20. Publisher or studio logotype
775-
776-
The default is 3 (front cover). There may only be one picture each of
777-
type 1 and 2 in a file.
778-
779-
*MIME-TYPE* is optional; if left blank, it will be detected from the file.
780-
For best compatibility with players, use pictures with MIME type
781-
image/jpeg or image/png. The MIME type can also be \--\> to mean that
782-
FILE is actually a URL to an image, though this use is discouraged.
783-
784-
*DESCRIPTION* is optional; the default is an empty string.
785-
786-
The next part specifies the resolution and color information. If the
787-
*MIME-TYPE* is image/jpeg, image/png, or image/gif, you can usually leave
788-
this empty and they can be detected from the file. Otherwise, you must
789-
specify the width in pixels, height in pixels, and color depth in
790-
bits-per-pixel. If the image has indexed colors you should also specify
791-
the number of colors used. When manually specified, it is not checked
792-
against the file for accuracy.
793-
794-
*FILE* is the path to the picture file to be imported, or the URL if MIME
795-
type is \--\>
796-
797-
**Specification examples:**
798-
"\|image/jpeg\|\|\|../cover.jpg" will embed the
799-
JPEG file at ../cover.jpg, defaulting to type 3 (front cover) and an
800-
empty description. The resolution and color info will be retrieved
801-
from the file itself.
802-
"4\|\--\>\|CD\|320x300x24/173\|http://blah.blah/backcover.tiff" will
803-
embed the given URL, with type 4 (back cover), description "CD", and a
804-
manually specified resolution of 320x300, 24 bits-per-pixel, and 173
805-
colors. The file at the URL will not be fetched; the URL itself is
806-
stored in the PICTURE metadata block.
748+
## Picture specification
749+
750+
The *SPECIFICATION* for **\--picture** takes the following form:
751+
\[*TYPE*\]\|\[*MIME-TYPE*\]\|\[*DESCRIPTION*\]\|\[*WIDTH*x*HEIGHT*x*DEPTH*\[/*COLORS*\]\]\|*FILE*
752+
All arguments but *FILE* can be left empty. The fields are:
753+
754+
- *TYPE* (defaults to 3, front cover) is a number from the following list
755+
(and there may only be one picture each of type 1 and 2 in a file):
756+
0\. Other
757+
1\. PNG file icon of 32x32 pixels (see RFC 2083)
758+
2\. General file icon
759+
3\. Front cover
760+
4\. Back cover
761+
5\. Liner notes page
762+
6\. Media label (e.g., CD, Vinyl or Cassette label)
763+
7\. Lead artist, lead performer, or soloist
764+
8\. Artist or performer
765+
9\. Conductor
766+
10\. Band or orchestra
767+
11\. Composer
768+
12\. Lyricist or text writer
769+
13\. Recording location
770+
14\. During recording
771+
15\. During performance
772+
16\. Movie or video screen capture
773+
17\. A bright colored fish (from ID3v2, use discouraged)
774+
18\. Illustration
775+
19\. Band or artist logotype
776+
20\. Publisher or studio logotype
777+
778+
- *MIME-TYPE* (default: detect from file). Pictures with MIME-type
779+
image/jpeg or image/png are most compatible. *MIME-TYPE* \--\> means
780+
that *FILE* is actually URI to an image, though this use is discouraged.
781+
- *DESCRIPTION* (defaults to empty string): free text.
782+
- *WIDTH*x*HEIGHT*x*DEPTH*\[/*COLORS*\] (default: attempt to detect from
783+
image, as typically possible for jpeg/png/gif MIME-types): *WIDTH*
784+
and *HEIGHT* are given in pixels, and color *DEPTH* in bits-per-pixel.
785+
Also, optionally (for images with indexed colors) the number of
786+
colors used.
787+
*CAUTION:* **flac** will *not* try to verify that the information is correct.
788+
- *FILE* is the only mandatory argument. It is either the path to the
789+
picture file to be imported, or the URI if MIME-type is "\--\>"
790+
791+
**examples:**
792+
`--picture="||||../cover.jpg"`. The same as `--picture="../cover.jpg"`
793+
(with *FILENAME* rather than as full specification). The file at
794+
../cover.jpg wil be embedded, and by default: type 3 (front cover), empty
795+
description. The MIME-type (presumably image/jpeg), the resolution and
796+
color info will be retrieved from the file itself.
797+
`--picture="4|-->|CD|320x300x24/173|http://example.com/backcover.tiff"`
798+
will store the given URI literally (not retrieving the referenced
799+
file!), as type 4 (back cover), description "CD", and the following
800+
information: 320x300 resolution, 24 bits-per-pixel and 173 colors.
807801

808802
## Apodization functions
809803
To improve LPC analysis, the audio data is windowed. An **-A** option
@@ -854,8 +848,8 @@ parameter (defaulting to 5e-1) is applied for the smallest used window:
854848
For example, subdivide_tukey(2/5e-1) results in the same taper as that of
855849
tukey(25e-2) and subdivide_tukey(5) in the same taper as of tukey(1e-1).
856850

857-
#### Example (for illustration - impractically long!):
858-
`-A "flattop;gauss(1e-1);tukey(3e-2);punchout_tukey(3/-9e-4/54e-2);subdivide_tukey(5/7e-1);hanning`
851+
**example (for illustration - impractically long!):**
852+
`-A "flattop;gauss(1e-1);tukey(3e-2);punchout_tukey(3/-9e-4/54e-2);subdivide_tukey(5/7e-1);hanning"`
859853

860854
The encoder will for each subframe try all the following in order,
861855
estimate the size, and pick the best which is then used to encode:

0 commit comments

Comments
 (0)