mirror of
https://github.com/etlegacy/etlegacy-libs.git
synced 2025-02-24 20:21:11 +00:00
81 lines
2.9 KiB
HTML
81 lines
2.9 KiB
HTML
|
<html>
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<title>libvorbis - 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>libvorbis documentation</p></td>
|
||
|
|
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h1>vorbis_comment</h1>
|
||
|
|
|
||
|
|
<p><i>declared in "vorbis/codec.h"</i></p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
The vorbis_comment structure defines an Ogg Vorbis comment.
|
||
|
|
<p>
|
||
|
|
Only the fields the program needs must be defined. If a field isn't
|
||
|
|
defined by the application, it will either be blank (if it's a string value)
|
||
|
|
or set to some reasonable default (usually 0).
|
||
|
|
<p>
|
||
|
|
<i>Note:</i> When encoding, while it <i>is</i> supported to modify a
|
||
|
|
vorbis_comment structure directly, be sure to read the notes on the
|
||
|
|
<a href="vorbis_comment_init.html">vorbis_comment_init</a> and
|
||
|
|
<a href="vorbis_comment_clear.html">vorbis_comment_clear</a> pages for
|
||
|
|
considerations on memory allocation and freeing before you do so. Rule of
|
||
|
|
thumb: call vorbis_comment_init, then <i>either</i> do all allocation,
|
||
|
|
freeing, and modification yourself and <i>do not</i> call
|
||
|
|
vorbis_comment_clear, <i>or</i> do all modification using libvorbis
|
||
|
|
functions and <i>do</i> call vorbis_comment_clear.
|
||
|
|
<p>
|
||
|
|
|
||
|
|
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
|
||
|
|
<tr bgcolor=#cccccc>
|
||
|
|
<td>
|
||
|
|
<pre><b>typedef struct vorbis_comment{
|
||
|
|
/* unlimited user comment fields. */
|
||
|
|
char **user_comments;
|
||
|
|
int *comment_lengths;
|
||
|
|
int comments;
|
||
|
|
char *vendor;
|
||
|
|
|
||
|
|
} vorbis_comment;</b></pre>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
<dl>
|
||
|
|
<dt><i>user_comments</i></dt>
|
||
|
|
<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 int 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>
|
||
|
|
<dt><i>vendor</i></dt>
|
||
|
|
<dd>Information about the Vorbis implementation that encoded the file. Stored in a standard C 0-terminated string. Libvorbis will fill this in itself when encoding a comment packet from this structure; when decoding, this contains the vendor string that was in the comment packet.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
<br><br>
|
||
|
|
<hr noshade>
|
||
|
|
<table border=0 width=100%>
|
||
|
|
<tr valign=top>
|
||
|
|
<td><p class=tiny>copyright © 2000-2010 Xiph.Org</p></td>
|
||
|
|
<td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
|
||
|
|
</tr><tr>
|
||
|
|
<td><p class=tiny>libvorbis documentation</p></td>
|
||
|
|
<td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
|
||
|
|
</html>
|