[xiph-cvs] cvs commit: ogg/doc/ogg vorbis_comment.html vorbis_info.html
Ralph Giles
giles at xiph.org
Fri Jul 19 03:50:46 PDT 2002
giles 02/07/19 03:50:45
Modified: doc/ogg vorbis_comment.html vorbis_info.html
Log:
Propagate changes to vorbisfile documentation.
Revision Changes Path
1.2 +14 -11 ogg/doc/ogg/vorbis_comment.html
Index: vorbis_comment.html
===================================================================
RCS file: /usr/local/cvsroot/ogg/doc/ogg/vorbis_comment.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- vorbis_comment.html 2001/02/26 04:06:26 1.1
+++ vorbis_comment.html 2002/07/19 10:50:44 1.2
@@ -1,15 +1,15 @@
<html>
<head>
-<title>vorbisfile - datatype - vorbis_comment</title>
+<title>Vorbisfile - datatype - vorbis_comment</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>
<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
+<td><p class=tiny>Vorbisfile documentation</p></td>
+<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>
</tr>
</table>
@@ -31,8 +31,9 @@
<pre><b>typedef struct vorbis_comment{
/* unlimited user comment fields. */
char **user_comments;
- int comments;
- char *vendor;
+ int *comment_lengths;
+ int comments;
+ char *vendor;
} vorbis_comment;</b></pre>
</td>
@@ -42,9 +43,11 @@
<h3>Parameters</h3>
<dl>
<dt><i>user_comments</i></dt>
-<dd>Unlimited user comment array. Comments stored in normal C 0-terminated strings.</dd>
+<dd>Unlimited user comment array. The individual strings in the array are 8 bit clean, by the Vorbis specification, and as such the <tt>comment_lengths</tt> array should be consulted to determine string length. For convenience, each string is also NULL-terminated by the decode library (although Vorbis comments are not NULL terminated within the bitstream itself).</dd>
+<dt><i>comment_lengths</i></dt>
+<dd>An array that stores the length of each comment string</dd>
<dt><i>comments</i></dt>
-<dd>Int signifying number of user comments in user_comments field.</dd>
+<dd>number of user comments in user_comments field.</dd>
<dt><i>vendor</i></dt>
<dd>Information about the creator of the file. Stored in a standard C 0-terminated string.</dd>
</dl>
@@ -54,11 +57,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2000 vorbis team</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
+<td><p class=tiny>copyright © 2002 Xiph.org Foundation</p></td>
+<td align=right><p class=tiny>Ogg Vorbis</p></td>
</tr><tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
+<td><p class=tiny>Vorbisfile documentation</p></td>
+<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020719</p></td>
</tr>
</table>
<p><p>1.2 +15 -37 ogg/doc/ogg/vorbis_info.html
Index: vorbis_info.html
===================================================================
RCS file: /usr/local/cvsroot/ogg/doc/ogg/vorbis_info.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- vorbis_info.html 2001/02/26 04:06:26 1.1
+++ vorbis_info.html 2002/07/19 10:50:44 1.2
@@ -1,15 +1,15 @@
<html>
<head>
-<title>libvorbis - datatype - vorbis_info</title>
+<title>Vorbisfile - datatype - vorbis_info</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>
<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
-<td><p class=tiny>libvorbis documentation</p></td>
-<td align=right><p class=tiny>libvorbis version 1.25 - 20000615</p></td>
+<td><p class=tiny>Vorbisfile documentation</p></td>
+<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>
</tr>
</table>
@@ -18,8 +18,7 @@
<p><i>declared in "vorbis/codec.h"</i></p>
<p>
-The vorbis_info structure contains information about a vorbis bitstream. Most of the information in this struct is more complex and in-depth than we need for vorbisfile decoding. However, the info's there if we need or want it.
-
+The vorbis_info structure contains basic information about the audio in a vorbis bitstream.
<p>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
@@ -33,33 +32,9 @@
long bitrate_upper;
long bitrate_nominal;
long bitrate_lower;
-
- long blocksizes[2];
+ long bitrate_window;
- int modes;
- int maps;
- int times;
- int floors;
- int residues;
- int books;
- int psys; /* encode only */
-
- vorbis_info_mode *mode_param[64];
- int map_type[64];
- vorbis_info_mapping *map_param[64];
- int time_type[64];
- vorbis_info_time *time_param[64];
- int floor_type[64];
- vorbis_info_floor *floor_param[64];
- int residue_type[64];
- vorbis_info_residue *residue_param[64];
- static_codebook *book_param[256];
- vorbis_info_psy *psy_param[64]; /* encode only */
-
- /* for block long/sort tuning; encode only */
- int envelopesa;
- double preecho_thresh;
- double preecho_clamp;
+ void *codec_setup;
} vorbis_info;</b></pre>
</td>
@@ -80,8 +55,11 @@
<dd>Specifies the average bitrate for a VBR bitstream. May be unset. If the bitrate_upper and bitrate_lower parameters match, the stream is fixed bitrate.</dd>
<dt><i>bitrate_lower</i></dt>
<dd>Specifies the lower limit in a VBR bitstream. If the value matches the bitrate_nominal and bitrate_upper parameters, the stream is fixed bitrate. May be unset if no limit exists.</dd>
-<dt><i>blocksizes[2]</i></dt>
-<dd>Contains the sizes of the long and short blocks for this particular bitstream. These are variable and can be set by the encoder. Vorbis only supports two sizes, long and short.</dd>
+<dt><i>bitrate_window</i></dt>
+<dd>Currently unset.</dd>
+
+<dt><i>codec_setup</i></dt>
+<dd>Internal structure that contains the detailed/unpacked configuration for decoding the current Vorbis bitstream.</dd>
</dl>
@@ -89,11 +67,11 @@
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
-<td><p class=tiny>copyright © 2000 vorbis team</p></td>
-<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a><br><a href="mailto:team at vorbis.org">team at vorbis.org</a></p></td>
+<td><p class=tiny>copyright © 2002 Xiph.org</p></td>
+<td align=right><p class=tiny>Ogg Vorbis</p></td>
</tr><tr>
-<td><p class=tiny>vorbisfile documentation</p></td>
-<td align=right><p class=tiny>vorbisfile version 1.25 - 20000615</p></td>
+<td><p class=tiny>Vorbisfile documentation</p></td>
+<td align=right><p class=tiny>libVorbisfile version 1.65 - 20020702</p></td>
</tr>
</table>
<p><p><p>--- >8 ----
List archives: http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body. No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.
More information about the commits
mailing list