Mercurial > hg > sv-dependency-builds

annotate src/flac-1.2.1/doc/html/api/structFLAC____FrameHeader.html @ 86:98c1576536ae

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