more external use of "FLAC tags" instead of "Vorbis comments" to avoid confusion
authorJosh Coalson <jcoalson@users.sourceforce.net>
Wed, 31 Aug 2005 01:00:53 +0000 (01:00 +0000)
committerJosh Coalson <jcoalson@users.sourceforce.net>
Wed, 31 Aug 2005 01:00:53 +0000 (01:00 +0000)
doc/html/documentation.html
doc/html/format.html
include/FLAC/format.h
man/flac.sgml
src/flac/main.c
src/plugin_winamp2/resource.rc

index df12b16..384e6a7 100644 (file)
                                        <span class="argument">--replay-gain</span>
                                </td>
                                <td>
-                                       Calculate <a href="http://www.replaygain.org/">ReplayGain</a> values and store in FLAC tags, similar to <a href="http://packages.qa.debian.org/v/vorbisgain.html">VorbisGain</a>.  Title gains/peaks will be computed for each input file, and an album gain/peak will be computed for all files.  All input files must have the same resolution, sample rate, and number of channels.  Only mono and stereo files are allowed, and the sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.  Also note that this option may leave a few extra bytes in a <span class="code">PADDING</span> block as the exact size of the tags is not known until all files are processed.<br /><br />
+                                       Calculate <a href="http://www.replaygain.org/">ReplayGain</a> values and store them as FLAC tags, similar to <a href="http://packages.qa.debian.org/v/vorbisgain.html">VorbisGain</a>.  Title gains/peaks will be computed for each input file, and an album gain/peak will be computed for all files.  All input files must have the same resolution, sample rate, and number of channels.  Only mono and stereo files are allowed, and the sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.  Also note that this option may leave a few extra bytes in a <span class="code">PADDING</span> block as the exact size of the tags is not known until all files are processed.<br /><br />
                                        Note that this option cannot be used when encoding to standard output (stdout).
                                </td>
                        </tr>
index 6fd2690..f34c15b 100644 (file)
                                        <li><a name="def_APPLICATION" /><b>APPLICATION</b>: This block is for use by third-party applications.  The only mandatory field is a 32-bit identifier.  This ID is granted upon request to an application by the FLAC maintainers.  The remainder is of the block is defined by the registered application.  Visit the <a href="id.html">registration page</a> if you would like to register an ID for your application with FLAC.</li>
                                        <li><a name="def_PADDING" /><b>PADDING</b>: This block allows for an arbitrary amount of padding.  The contents of a PADDING block have no meaning.  This block is useful when it is known that metadata will be edited after encoding; the user can instruct the encoder to reserve a PADDING block of sufficient size so that when metadata is added, it will simply overwrite the padding (which is relatively quick) instead of having to insert it into the right place in the existing file (which would normally require rewriting the entire file).</li>
                                        <li><a name="def_SEEKTABLE" /><b>SEEKTABLE</b>: This is an optional block for storing seek points.  It is possible to seek to any given sample in a FLAC stream without a seek table, but the delay can be unpredictable since the bitrate may vary widely within a stream.  By adding seek points to a stream, this delay can be significantly reduced.  Each seek point takes 18 bytes, so 1% resolution within a stream adds less than 2k.  There can be only one SEEKTABLE in a stream, but the table can have any number of seek points.  There is also a special 'placeholder' seekpoint which will be ignored by decoders but which can be used to reserve space for future seek point insertion.</li>
-                                       <li><a name="def_VORBIS_COMMENT" /><b>VORBIS_COMMENT</b>: This block is for storing a list of human-readable name/value pairs.  Values are encoded using UTF-8.  It is an implementation of the <a href="http://xiph.org/ogg/vorbis/doc/v-comment.html">Vorbis comment specification</a>.  This is the only officially supported tagging mechanism in FLAC.  There may be only one VORBIS_COMMENT block in a stream.</li>
+                                       <li><a name="def_VORBIS_COMMENT" /><b>VORBIS_COMMENT</b>: This block is for storing a list of human-readable name/value pairs.  Values are encoded using UTF-8.  It is an implementation of the <a href="http://xiph.org/ogg/vorbis/doc/v-comment.html">Vorbis comment specification</a>.  This is the only officially supported tagging mechanism in FLAC.  There may be only one VORBIS_COMMENT block in a stream.  In some external documentation, Vorbis comments are called FLAC tags to lessen confusion.</li>
                                        <li><a name="def_CUESHEET" /><b>CUESHEET</b>: This block is for storing various information that can be used in a cue sheet.  It supports track and index points, compatible with Red Book CD digital audio discs, as well as other CD-DA metadata such as media catalog number and track ISRCs.  The CUESHEET block is especially useful for backing up CD-DA discs, but it can be used as a general purpose cueing mechanism for playback.</li>
                                </ul>
                        </li>
                                &lt;n&gt;
                        </td>
                        <td>
-                               The contents of a vorbis comment packet as specified <a href="http://www.xiph.org/ogg/vorbis/doc/v-comment.html">here</a>, including the vendor string.  Note that the vorbis comment spec allows for on the order of 2 ^ 64 bytes of data where as the FLAC metadata block is limited to 2 ^ 24 bytes.  Given the stated purpose of vorbis comments, i.e. human-readable textual information, this limit is unlikely to be restrictive.  Also note that the 32-bit field lengths are little-endian coded according to the vorbis spec, as opposed to the usual big-endian coding of fixed-length integers in the rest of FLAC.
+                               Also known as FLAC tags, the contents of a vorbis comment packet as specified <a href="http://www.xiph.org/ogg/vorbis/doc/v-comment.html">here</a>, including the vendor string.  Note that the vorbis comment spec allows for on the order of 2 ^ 64 bytes of data where as the FLAC metadata block is limited to 2 ^ 24 bytes.  Given the stated purpose of vorbis comments, i.e. human-readable textual information, this limit is unlikely to be restrictive.  Also note that the 32-bit field lengths are little-endian coded according to the vorbis spec, as opposed to the usual big-endian coding of fixed-length integers in the rest of FLAC.
                        </td>
                </tr>
        </table>
index 26080cb..934586d 100644 (file)
@@ -153,7 +153,7 @@ extern "C" {
 extern FLAC_API const char *FLAC__VERSION_STRING;
 
 /** The vendor string inserted by the encoder into the VORBIS_COMMENT block.
- *  This is a nulL-terminated ASCII string; when inserted into the
+ *  This is a NUL-terminated ASCII string; when inserted into the
  *  VORBIS_COMMENT the trailing null is stripped.
  */
 extern FLAC_API const char *FLAC__VENDOR_STRING;
@@ -473,7 +473,7 @@ typedef enum {
        /**< <A HREF="../format.html#metadata_block_seektable">SEEKTABLE</A> block */
 
        FLAC__METADATA_TYPE_VORBIS_COMMENT = 4,
-       /**< <A HREF="../format.html#metadata_block_vorbis_comment">VORBISCOMMENT</A> block */
+       /**< <A HREF="../format.html#metadata_block_vorbis_comment">VORBISCOMMENT</A> block (a.k.a. FLAC tags) */
 
        FLAC__METADATA_TYPE_CUESHEET = 5,
        /**< <A HREF="../format.html#metadata_block_cuesheet">CUESHEET</A> block */
index 42b0334..122cdb0 100644 (file)
                <term><option>--replay-gain</option></term>
 
                <listitem>
-                 <para>Calculate ReplayGain values and store in
-                   Vorbis comments, similar to vorbisgain.  Title
+                 <para>Calculate ReplayGain values and store them
+                   as FLAC tags, similar to vorbisgain.  Title
                    gains/peaks will be computed for each input
                    file, and an album gain/peak will be computed
                    for all files.  All input files must have the
                <term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>
 
                <listitem>
-                 <para>Add a Vorbis comment.  The comment must adhere
-                   to the Vorbis comment spec; i.e. the FIELD must
+                 <para>Add a FLAC tag.  The comment must adhere to
+                   the Vorbis comment spec; i.e. the FIELD must
                    contain only legal characters, terminated by an
                    'equals' sign.  Make sure to quote the comment if
                    necessary.  This option may appear more than once
index fafd67d..e027ae5 100644 (file)
@@ -1181,9 +1181,9 @@ void show_help()
        printf("  -V, --verify                 Verify a correct encoding\n");
        printf("      --lax                    Allow encoder to generate non-Subset files\n");
        printf("      --sector-align           Align multiple files on sector boundaries\n");
-       printf("      --replay-gain            Calculate ReplayGain & store in Vorbis comments\n");
+       printf("      --replay-gain            Calculate ReplayGain & store in FLAC tags\n");
        printf("      --cuesheet=FILENAME      Import cuesheet and store in CUESHEET block\n");
-       printf("  -T, --tag=FIELD=VALUE        Add a Vorbis comment; may appear multiple times\n");
+       printf("  -T, --tag=FIELD=VALUE        Add a FLAC tag; may appear multiple times\n");
        printf("  -S, --seekpoint={#|X|#x|#s}  Add seek point(s)\n");
        printf("  -P, --padding=#              Write a PADDING block of length #\n");
        printf("  -0, --compression-level-0, --fast  Synonymous with -l 0 -b 1152 -r 2,2\n");
@@ -1345,8 +1345,8 @@ void show_explain()
        printf("      --lax                    Allow encoder to generate non-Subset files\n");
        printf("      --sector-align           Align encoding of multiple CD format WAVE files\n");
        printf("                               on sector boundaries.\n");
-       printf("      --replay-gain            Calculate ReplayGain values and store in Vorbis\n");
-       printf("                               comments.  Title gains/peaks will be computed\n");
+       printf("      --replay-gain            Calculate ReplayGain values and store them as\n");
+       printf("                               FLAC tags.  Title gains/peaks will be computed\n");
        printf("                               for each file, and an album gain/peak will be\n");
        printf("                               computed for all files.  All input files must\n");
        printf("                               have the same resolution, sample rate, and\n");
@@ -1360,7 +1360,7 @@ 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("  -T, --tag=FIELD=VALUE        Add a Vorbis comment.  Make sure to quote the\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");
        printf("                               all tags will be added to all encoded files.\n");
index a2e7efe..a04e9eb 100644 (file)
@@ -143,7 +143,7 @@ BEGIN
     CONTROL         "Read ID3v&1 tags",IDC_ID3V1,"Button",BS_AUTOCHECKBOX | \r
                     WS_TABSTOP,147,43,70,10\r
     GROUPBOX        " Tag Editor  ",IDC_STATIC,2,63,220,30\r
-    CONTROL         "Reserve space for &VorbisComment",IDC_RESERVE,"Button",\r
+    CONTROL         "Reserve space for &FLAC tags",IDC_RESERVE,"Button",\r
                     BS_AUTOCHECKBOX | WS_DISABLED | WS_TABSTOP,8,76,125,10\r
     GROUPBOX        " Miscellaneous  ",IDC_STATIC,2,96,220,72\r
     CONTROL         "&Show average bitrate while playing",IDC_BPS,"Button",\r