/usr/share/doc/libopusfile-doc/html/structOpusTags.html is in libopusfile-doc 0.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>opusfile: OpusTags Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="opus_logo.svg"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">opusfile
 <span id="projectnumber">0.6</span>
</div>
<div id="projectbrief">Stand-alone decoder library for .opus files.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Modules</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">OpusTags Struct Reference<div class="ingroups"><a class="el" href="group__header__info.html">Header Information</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The metadata from an Ogg Opus stream.
<a href="structOpusTags.html#details">More...</a></p>
<p><code>#include <<a class="el" href="opusfile_8h_source.html">opusfile.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ad53d571bd8b23691089242e4e161358a"><td class="memItemLeft" align="right" valign="top">char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpusTags.html#ad53d571bd8b23691089242e4e161358a">user_comments</a></td></tr>
<tr class="memdesc:ad53d571bd8b23691089242e4e161358a"><td class="mdescLeft"> </td><td class="mdescRight">The array of comment string vectors. <a href="#ad53d571bd8b23691089242e4e161358a">More...</a><br /></td></tr>
<tr class="separator:ad53d571bd8b23691089242e4e161358a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa99547abb03d7dbe0cd7095d8b706170"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpusTags.html#aa99547abb03d7dbe0cd7095d8b706170">comment_lengths</a></td></tr>
<tr class="memdesc:aa99547abb03d7dbe0cd7095d8b706170"><td class="mdescLeft"> </td><td class="mdescRight">An array of the corresponding length of each vector, in bytes. <a href="#aa99547abb03d7dbe0cd7095d8b706170">More...</a><br /></td></tr>
<tr class="separator:aa99547abb03d7dbe0cd7095d8b706170"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65c37166930a1f5d682fa6c863fc28c6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpusTags.html#a65c37166930a1f5d682fa6c863fc28c6">comments</a></td></tr>
<tr class="memdesc:a65c37166930a1f5d682fa6c863fc28c6"><td class="mdescLeft"> </td><td class="mdescRight">The total number of comment streams. <a href="#a65c37166930a1f5d682fa6c863fc28c6">More...</a><br /></td></tr>
<tr class="separator:a65c37166930a1f5d682fa6c863fc28c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6ff133dfd801934d981bc5905dae0bd"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpusTags.html#af6ff133dfd801934d981bc5905dae0bd">vendor</a></td></tr>
<tr class="memdesc:af6ff133dfd801934d981bc5905dae0bd"><td class="mdescLeft"> </td><td class="mdescRight">The null-terminated vendor string. <a href="#af6ff133dfd801934d981bc5905dae0bd">More...</a><br /></td></tr>
<tr class="separator:af6ff133dfd801934d981bc5905dae0bd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The metadata from an Ogg Opus stream. </p>
<p>This structure holds the in-stream metadata corresponding to the 'comment' header packet of an Ogg Opus stream. The comment header is meant to be used much like someone jotting a quick note on the label of a CD. It should be a short, to the point text note that can be more than a couple words, but not more than a short paragraph.</p>
<p>The metadata is stored as a series of (tag, value) pairs, in length-encoded string vectors, using the same format as Vorbis (without the final "framing
bit"), Theora, and Speex, except for the packet header. The first occurrence of the '=' character delimits the tag and value. A particular tag may occur more than once, and order is significant. The character set encoding for the strings is always UTF-8, but the tag names are limited to ASCII, and treated as case-insensitive. See <a href="http://www.xiph.org/vorbis/doc/v-comment.html">the Vorbis comment header specification</a> for details.</p>
<p>In filling in this structure, <code>libopusfile</code> will null-terminate the <a class="el" href="structOpusTags.html#ad53d571bd8b23691089242e4e161358a" title="The array of comment string vectors. ">user_comments</a> strings for safety. However, the bitstream format itself treats them as 8-bit clean vectors, possibly containing NUL characters, so the <a class="el" href="structOpusTags.html#aa99547abb03d7dbe0cd7095d8b706170" title="An array of the corresponding length of each vector, in bytes. ">comment_lengths</a> array should be treated as their authoritative length.</p>
<p>This structure is binary and source-compatible with a <code>vorbis_comment</code>, and pointers to it may be freely cast to <code>vorbis_comment</code> pointers, and vice versa. It is provided as a separate type to avoid introducing a compile-time dependency on the libvorbis headers. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ad53d571bd8b23691089242e4e161358a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char** OpusTags::user_comments</td>
</tr>
</table>
</div><div class="memdoc">
<p>The array of comment string vectors. </p>
</div>
</div>
<a class="anchor" id="aa99547abb03d7dbe0cd7095d8b706170"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int* OpusTags::comment_lengths</td>
</tr>
</table>
</div><div class="memdoc">
<p>An array of the corresponding length of each vector, in bytes. </p>
</div>
</div>
<a class="anchor" id="a65c37166930a1f5d682fa6c863fc28c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int OpusTags::comments</td>
</tr>
</table>
</div><div class="memdoc">
<p>The total number of comment streams. </p>
</div>
</div>
<a class="anchor" id="af6ff133dfd801934d981bc5905dae0bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* OpusTags::vendor</td>
</tr>
</table>
</div><div class="memdoc">
<p>The null-terminated vendor string. </p>
<p>This identifies the software used to encode the stream. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/tmp/buildd/opusfile-0.6/include/<a class="el" href="opusfile_8h_source.html">opusfile.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Oct 4 2014 01:50:10 for opusfile by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
|