Browse code

doc: reword the mp3 muxer documentation

Make it more structured.

Anton Khirnov authored on 2014/04/12 22:20:01
Showing 1 changed files
... ...
@@ -347,29 +347,37 @@ avconv -re @var{<normal input/transcoding options>} -movflags isml+frag_keyframe
347 347
 
348 348
 @section mp3
349 349
 
350
-The MP3 muxer writes a raw MP3 stream with an ID3v2 header at the beginning and
351
-optionally an ID3v1 tag at the end. ID3v2.3 and ID3v2.4 are supported, the
352
-@code{id3v2_version} option controls which one is used. Setting
353
-@code{id3v2_version} to 0 will disable the ID3v2 header completely. The legacy
354
-ID3v1 tag is not written by default, but may be enabled with the
355
-@code{write_id3v1} option.
356
-
357
-The muxer may also write a Xing frame at the beginning, which contains the
358
-number of frames in the file. It is useful for computing duration of VBR files.
359
-The Xing frame is written if the output stream is seekable and if the
360
-@code{write_xing} option is set to 1 (the default).
361
-
362
-The muxer supports writing ID3v2 attached pictures (APIC frames). The pictures
363
-are supplied to the muxer in form of a video stream with a single packet. There
364
-can be any number of those streams, each will correspond to a single APIC frame.
365
-The stream metadata tags @var{title} and @var{comment} map to APIC
366
-@var{description} and @var{picture type} respectively. See
350
+The MP3 muxer writes a raw MP3 stream with the following optional features:
351
+@itemize @bullet
352
+@item
353
+An ID3v2 metadata header at the beginning (enabled by default). Versions 2.3 and
354
+2.4 are supported, the @code{id3v2_version} private option controls which one is
355
+used (3 or 4). Setting @code{id3v2_version} to 0 disables the ID3v2 header
356
+completely.
357
+
358
+The muxer supports writing attached pictures (APIC frames) to the ID3v2 header.
359
+The pictures are supplied to the muxer in form of a video stream with a single
360
+packet. There can be any number of those streams, each will correspond to a
361
+single APIC frame.  The stream metadata tags @var{title} and @var{comment} map
362
+to APIC @var{description} and @var{picture type} respectively. See
367 363
 @url{http://id3.org/id3v2.4.0-frames} for allowed picture types.
368 364
 
369 365
 Note that the APIC frames must be written at the beginning, so the muxer will
370 366
 buffer the audio frames until it gets all the pictures. It is therefore advised
371 367
 to provide the pictures as soon as possible to avoid excessive buffering.
372 368
 
369
+@item
370
+A Xing/LAME frame right after the ID3v2 header (if present). It is enabled by
371
+default, but will be written only if the output is seekable. The
372
+@code{write_xing} private option can be used to disable it.  The frame contains
373
+various information that may be useful to the decoder, like the audio duration.
374
+
375
+@item
376
+A legacy ID3v1 tag at the end of the file (disabled by default). It may be
377
+enabled with the @code{write_id3v1} private option, but as its capabilities are
378
+very limited, its usage is not recommended.
379
+@end itemize
380
+
373 381
 Examples:
374 382
 
375 383
 Write an mp3 with an ID3v2.3 header and an ID3v1 footer: