Mercurial > hg > sv-dependency-builds

annotate src/flac-1.2.1/doc/html/api/structFLAC____FrameHeader.html @ 1:05aa0afa9217

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Bring in flac, ogg, vorbis
author Chris Cannam
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
Chris@1 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
Chris@1 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
Chris@1 3 <title>FLAC: FLAC__FrameHeader Struct Reference</title>
Chris@1 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
Chris@1 5 </head><body>
Chris@1 6 <!-- Generated by Doxygen 1.4.2 -->
Chris@1 7 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
Chris@1 8 <h1>FLAC__FrameHeader Struct Reference<br>
Chris@1 9 <small>
Chris@1 10 [<a class="el" href="group__flac__format.html">FLAC/format.h: format components</a>]</small>
Chris@1 11 </h1><code>#include &lt;<a class="el" href="format_8h-source.html">format.h</a>&gt;</code>
Chris@1 12 <p>
Chris@1 13 <a href="structFLAC____FrameHeader-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Chris@1 14 FLAC frame header structure. (c.f. <a href="../format.html#frame_header">format specification</a>)
Chris@1 15 <p>
Chris@1 16 <table border="0" cellpadding="0" cellspacing="0">
Chris@1 17 <tr><td></td></tr>
Chris@1 18 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
Chris@1 19 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero0">blocksize</a></td></tr>
Chris@1 20
Chris@1 21 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero1">sample_rate</a></td></tr>
Chris@1 22
Chris@1 23 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero2">channels</a></td></tr>
Chris@1 24
Chris@1 25 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__format.html#ga111">FLAC__ChannelAssignment</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero3">channel_assignment</a></td></tr>
Chris@1 26
Chris@1 27 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero4">bits_per_sample</a></td></tr>
Chris@1 28
Chris@1 29 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__format.html#ga112">FLAC__FrameNumberType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero5">number_type</a></td></tr>
Chris@1 30
Chris@1 31 <tr><td class="memItemLeft" nowrap>union {</td></tr>
Chris@1 32
Chris@1 33 <tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;FLAC__uint32&nbsp;&nbsp;&nbsp;<b>frame_number</b></td></tr>
Chris@1 34
Chris@1 35 <tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;FLAC__uint64&nbsp;&nbsp;&nbsp;<b>sample_number</b></td></tr>
Chris@1 36
Chris@1 37 <tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero8">number</a></td></tr>
Chris@1 38
Chris@1 39 <tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__uint8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero9">crc</a></td></tr>
Chris@1 40
Chris@1 41 </table>
Chris@1 42 <hr><h2>Member Data Documentation</h2>
Chris@1 43 <a class="anchor" name="FLAC____FrameHeadero0" doxytag="FLAC__FrameHeader::blocksize"></a><p>
Chris@1 44 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 45 <tr>
Chris@1 46 <td class="mdRow">
Chris@1 47 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 48 <tr>
Chris@1 49 <td class="md" nowrap valign="top">unsigned <a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero0">FLAC__FrameHeader::blocksize</a> </td>
Chris@1 50 </tr>
Chris@1 51 </table>
Chris@1 52 </td>
Chris@1 53 </tr>
Chris@1 54 </table>
Chris@1 55 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 56 <tr>
Chris@1 57 <td>
Chris@1 58 &nbsp;
Chris@1 59 </td>
Chris@1 60 <td>
Chris@1 61
Chris@1 62 <p>
Chris@1 63 The number of samples per subframe. </td>
Chris@1 64 </tr>
Chris@1 65 </table>
Chris@1 66 <a class="anchor" name="FLAC____FrameHeadero1" doxytag="FLAC__FrameHeader::sample_rate"></a><p>
Chris@1 67 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 68 <tr>
Chris@1 69 <td class="mdRow">
Chris@1 70 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 71 <tr>
Chris@1 72 <td class="md" nowrap valign="top">unsigned <a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero1">FLAC__FrameHeader::sample_rate</a> </td>
Chris@1 73 </tr>
Chris@1 74 </table>
Chris@1 75 </td>
Chris@1 76 </tr>
Chris@1 77 </table>
Chris@1 78 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 79 <tr>
Chris@1 80 <td>
Chris@1 81 &nbsp;
Chris@1 82 </td>
Chris@1 83 <td>
Chris@1 84
Chris@1 85 <p>
Chris@1 86 The sample rate in Hz. </td>
Chris@1 87 </tr>
Chris@1 88 </table>
Chris@1 89 <a class="anchor" name="FLAC____FrameHeadero2" doxytag="FLAC__FrameHeader::channels"></a><p>
Chris@1 90 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 91 <tr>
Chris@1 92 <td class="mdRow">
Chris@1 93 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 94 <tr>
Chris@1 95 <td class="md" nowrap valign="top">unsigned <a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero2">FLAC__FrameHeader::channels</a> </td>
Chris@1 96 </tr>
Chris@1 97 </table>
Chris@1 98 </td>
Chris@1 99 </tr>
Chris@1 100 </table>
Chris@1 101 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 102 <tr>
Chris@1 103 <td>
Chris@1 104 &nbsp;
Chris@1 105 </td>
Chris@1 106 <td>
Chris@1 107
Chris@1 108 <p>
Chris@1 109 The number of channels (== number of subframes). </td>
Chris@1 110 </tr>
Chris@1 111 </table>
Chris@1 112 <a class="anchor" name="FLAC____FrameHeadero3" doxytag="FLAC__FrameHeader::channel_assignment"></a><p>
Chris@1 113 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 114 <tr>
Chris@1 115 <td class="mdRow">
Chris@1 116 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 117 <tr>
Chris@1 118 <td class="md" nowrap valign="top"><a class="el" href="group__flac__format.html#ga111">FLAC__ChannelAssignment</a> <a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero3">FLAC__FrameHeader::channel_assignment</a> </td>
Chris@1 119 </tr>
Chris@1 120 </table>
Chris@1 121 </td>
Chris@1 122 </tr>
Chris@1 123 </table>
Chris@1 124 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 125 <tr>
Chris@1 126 <td>
Chris@1 127 &nbsp;
Chris@1 128 </td>
Chris@1 129 <td>
Chris@1 130
Chris@1 131 <p>
Chris@1 132 The channel assignment for the frame. </td>
Chris@1 133 </tr>
Chris@1 134 </table>
Chris@1 135 <a class="anchor" name="FLAC____FrameHeadero4" doxytag="FLAC__FrameHeader::bits_per_sample"></a><p>
Chris@1 136 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 137 <tr>
Chris@1 138 <td class="mdRow">
Chris@1 139 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 140 <tr>
Chris@1 141 <td class="md" nowrap valign="top">unsigned <a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero4">FLAC__FrameHeader::bits_per_sample</a> </td>
Chris@1 142 </tr>
Chris@1 143 </table>
Chris@1 144 </td>
Chris@1 145 </tr>
Chris@1 146 </table>
Chris@1 147 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 148 <tr>
Chris@1 149 <td>
Chris@1 150 &nbsp;
Chris@1 151 </td>
Chris@1 152 <td>
Chris@1 153
Chris@1 154 <p>
Chris@1 155 The sample resolution. </td>
Chris@1 156 </tr>
Chris@1 157 </table>
Chris@1 158 <a class="anchor" name="FLAC____FrameHeadero5" doxytag="FLAC__FrameHeader::number_type"></a><p>
Chris@1 159 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 160 <tr>
Chris@1 161 <td class="mdRow">
Chris@1 162 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 163 <tr>
Chris@1 164 <td class="md" nowrap valign="top"><a class="el" href="group__flac__format.html#ga112">FLAC__FrameNumberType</a> <a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero5">FLAC__FrameHeader::number_type</a> </td>
Chris@1 165 </tr>
Chris@1 166 </table>
Chris@1 167 </td>
Chris@1 168 </tr>
Chris@1 169 </table>
Chris@1 170 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 171 <tr>
Chris@1 172 <td>
Chris@1 173 &nbsp;
Chris@1 174 </td>
Chris@1 175 <td>
Chris@1 176
Chris@1 177 <p>
Chris@1 178 The numbering scheme used for the frame. As a convenience, the decoder will always convert a frame number to a sample number because the rules are complex. </td>
Chris@1 179 </tr>
Chris@1 180 </table>
Chris@1 181 <a class="anchor" name="FLAC____FrameHeadero8" doxytag="FLAC__FrameHeader::number"></a><p>
Chris@1 182 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 183 <tr>
Chris@1 184 <td class="mdRow">
Chris@1 185 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 186 <tr>
Chris@1 187 <td class="md" nowrap valign="top">union { ... } <a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero8">FLAC__FrameHeader::number</a> </td>
Chris@1 188 </tr>
Chris@1 189 </table>
Chris@1 190 </td>
Chris@1 191 </tr>
Chris@1 192 </table>
Chris@1 193 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 194 <tr>
Chris@1 195 <td>
Chris@1 196 &nbsp;
Chris@1 197 </td>
Chris@1 198 <td>
Chris@1 199
Chris@1 200 <p>
Chris@1 201 The frame number or sample number of first sample in frame; use the <em>number_type</em> value to determine which to use. </td>
Chris@1 202 </tr>
Chris@1 203 </table>
Chris@1 204 <a class="anchor" name="FLAC____FrameHeadero9" doxytag="FLAC__FrameHeader::crc"></a><p>
Chris@1 205 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 206 <tr>
Chris@1 207 <td class="mdRow">
Chris@1 208 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 209 <tr>
Chris@1 210 <td class="md" nowrap valign="top">FLAC__uint8 <a class="el" href="structFLAC____FrameHeader.html#FLAC____FrameHeadero9">FLAC__FrameHeader::crc</a> </td>
Chris@1 211 </tr>
Chris@1 212 </table>
Chris@1 213 </td>
Chris@1 214 </tr>
Chris@1 215 </table>
Chris@1 216 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 217 <tr>
Chris@1 218 <td>
Chris@1 219 &nbsp;
Chris@1 220 </td>
Chris@1 221 <td>
Chris@1 222
Chris@1 223 <p>
Chris@1 224 CRC-8 (polynomial = x^8 + x^2 + x^1 + x^0, initialized with 0) of the raw frame header bytes, meaning everything before the CRC byte including the sync code. </td>
Chris@1 225 </tr>
Chris@1 226 </table>
Chris@1 227 <hr>The documentation for this struct was generated from the following file:<ul>
Chris@1 228 <li>include/FLAC/<a class="el" href="format_8h-source.html">format.h</a></ul>
Chris@1 229
Chris@1 230 <hr size="1">
Chris@1 231 <div class="copyright">
Chris@1 232 <!-- @@@ oh so hacky -->
Chris@1 233 <table>
Chris@1 234 <tr>
Chris@1 235 <td align="left">
Chris@1 236 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson
Chris@1 237 </td>
Chris@1 238 <td width="1%" align="right">
Chris@1 239 <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
Chris@1 240 </td>
Chris@1 241 </tr>
Chris@1 242 </table>
Chris@1 243 </div>
Chris@1 244 <!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson -->
Chris@1 245 <!-- Permission is granted to copy, distribute and/or modify this document -->
Chris@1 246 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
Chris@1 247 <!-- or any later version published by the Free Software Foundation; -->
Chris@1 248 <!-- with no invariant sections. -->
Chris@1 249 <!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
Chris@1 250 </body>
Chris@1 251 </html>