@OggVorbisソリューション/libvorbis-1.3.5/doc/libvorbis/vorbis_comment.html

   1 <html>
   2
   3 <head>
   4 <title>libvorbis - datatype - vorbis_comment</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>libvorbis documentation</p></td>
  12 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>vorbis_comment</h1>
  17
  18 <p><i>declared in "vorbis/codec.h"</i></p>
  19
  20 <p>
  21 The vorbis_comment structure defines an Ogg Vorbis comment.
  22 <p>
  23 Only the fields the program needs must be defined.  If a field isn't
  24 defined by the application, it will either be blank (if it's a string value)
  25 or set to some reasonable default (usually 0).
  26 <p>
  27 <i>Note:</i> When encoding, while it <i>is</i> supported to modify a
  28 vorbis_comment structure directly, be sure to read the notes on the
  29 <a href="vorbis_comment_init.html">vorbis_comment_init</a> and
  30 <a href="vorbis_comment_clear.html">vorbis_comment_clear</a> pages for
  31 considerations on memory allocation and freeing before you do so. Rule of
  32 thumb: call vorbis_comment_init, then <i>either</i> do all allocation,
  33 freeing, and modification yourself and <i>do not</i> call
  34 vorbis_comment_clear, <i>or</i> do all modification using libvorbis
  35 functions and <i>do</i> call vorbis_comment_clear.
  36 <p>
  37
  38 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  39 <tr bgcolor=#cccccc>
  40         <td>
  41 <pre><b>typedef struct vorbis_comment{
  42   /* unlimited user comment fields. */
  43   char **user_comments;
  44   int  *comment_lengths;
  45   int  comments;
  46   char *vendor;
  47
  48 } vorbis_comment;</b></pre>
  49         </td>
  50 </tr>
  51 </table>
  52
  53 <h3>Parameters</h3>
  54 <dl>
  55 <dt><i>user_comments</i></dt>
  56 <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>
  57 <dt><i>comment_lengths</i></dt>
  58 <dd>An int array that stores the length of each comment string</dd>
  59 <dt><i>comments</i></dt>
  60 <dd>Int signifying number of user comments in user_comments field.</dd>
  61 <dt><i>vendor</i></dt>
  62 <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>
  63 </dl>
  64
  65
  66 <br><br>
  67 <hr noshade>
  68 <table border=0 width=100%>
  69 <tr valign=top>
  70 <td><p class=tiny>copyright &copy; 2000-2010 Xiph.Org</p></td>
  71 <td align=right><p class=tiny><a href="http://www.xiph.org/ogg/vorbis/">Ogg Vorbis</a></p></td>
  72 </tr><tr>
  73 <td><p class=tiny>libvorbis documentation</p></td>
  74 <td align=right><p class=tiny>libvorbis version 1.3.2 - 20101101</p></td>
  75 </tr>
  76 </table>
  77
  78 </body>
  79
  80 </html>