File: structFLAC____FrameHeader.html

package info (click to toggle)
flac 1.3.3-2%2Bdeb11u2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 15,556 kB
  • sloc: ansic: 51,278; cpp: 8,278; sh: 6,142; makefile: 958; perl: 162; javascript: 126
file content (228 lines) | stat: -rw-r--r-- 11,600 bytes parent folder | download
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FLAC: FLAC__FrameHeader 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="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="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">FLAC
   &#160;<span id="projectnumber">1.3.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structFLAC____FrameHeader-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">FLAC__FrameHeader Struct Reference<div class="ingroups"><a class="el" href="group__flac.html">FLAC C API</a> &raquo; <a class="el" href="group__flac__format.html">FLAC/format.h: format components</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="format_8h_source.html">format.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1898caa360a783bfa799332573b5c735"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#a1898caa360a783bfa799332573b5c735">blocksize</a></td></tr>
<tr class="separator:a1898caa360a783bfa799332573b5c735"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f01343180309a48b91d03bcfd58a5cc"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#a2f01343180309a48b91d03bcfd58a5cc">sample_rate</a></td></tr>
<tr class="separator:a2f01343180309a48b91d03bcfd58a5cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9518ce587ec26d2c1e315edcc99c1e82"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#a9518ce587ec26d2c1e315edcc99c1e82">channels</a></td></tr>
<tr class="separator:a9518ce587ec26d2c1e315edcc99c1e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a31f752e16da9d690f8d5ff85aed89c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__format.html#ga79855f8525672e37f299bbe02952ef9c">FLAC__ChannelAssignment</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#a9a31f752e16da9d690f8d5ff85aed89c">channel_assignment</a></td></tr>
<tr class="separator:a9a31f752e16da9d690f8d5ff85aed89c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd1db9449935817aedeab02d8aedd2fd"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#abd1db9449935817aedeab02d8aedd2fd">bits_per_sample</a></td></tr>
<tr class="separator:abd1db9449935817aedeab02d8aedd2fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a62ec09e6f3029297179ef65377265f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__flac__format.html#ga8fe9ebc78386cd2a3d23b7b8e3818e1c">FLAC__FrameNumberType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#a7a62ec09e6f3029297179ef65377265f">number_type</a></td></tr>
<tr class="separator:a7a62ec09e6f3029297179ef65377265f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affc849f1d7c044302e4e5c6c733c4642"><td class="memItemLeft" >union {</td></tr>
<tr class="memitem:aff48c512aec0dfa3a0526ee525f6701c"><td class="memItemLeft" >
&#160;&#160;&#160;FLAC__uint32&#160;&#160;&#160;<b>frame_number</b></td></tr>
<tr class="separator:aff48c512aec0dfa3a0526ee525f6701c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2e8cd0baca10a277d8fd9a96aa6fbfe"><td class="memItemLeft" >
&#160;&#160;&#160;FLAC__uint64&#160;&#160;&#160;<b>sample_number</b></td></tr>
<tr class="separator:aa2e8cd0baca10a277d8fd9a96aa6fbfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affc849f1d7c044302e4e5c6c733c4642"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#affc849f1d7c044302e4e5c6c733c4642">number</a></td></tr>
<tr class="separator:affc849f1d7c044302e4e5c6c733c4642"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a980438c380697df6f332cb27dc4672c4"><td class="memItemLeft" align="right" valign="top">FLAC__uint8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____FrameHeader.html#a980438c380697df6f332cb27dc4672c4">crc</a></td></tr>
<tr class="separator:a980438c380697df6f332cb27dc4672c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>FLAC frame header structure. (c.f. <a href="../format.html#frame_header">format specification</a>) </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a1898caa360a783bfa799332573b5c735"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1898caa360a783bfa799332573b5c735">&#9670;&nbsp;</a></span>blocksize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__FrameHeader::blocksize</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The number of samples per subframe. </p>

</div>
</div>
<a id="a2f01343180309a48b91d03bcfd58a5cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f01343180309a48b91d03bcfd58a5cc">&#9670;&nbsp;</a></span>sample_rate</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__FrameHeader::sample_rate</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The sample rate in Hz. </p>

</div>
</div>
<a id="a9518ce587ec26d2c1e315edcc99c1e82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9518ce587ec26d2c1e315edcc99c1e82">&#9670;&nbsp;</a></span>channels</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__FrameHeader::channels</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The number of channels (== number of subframes). </p>

</div>
</div>
<a id="a9a31f752e16da9d690f8d5ff85aed89c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a31f752e16da9d690f8d5ff85aed89c">&#9670;&nbsp;</a></span>channel_assignment</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__format.html#ga79855f8525672e37f299bbe02952ef9c">FLAC__ChannelAssignment</a> FLAC__FrameHeader::channel_assignment</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The channel assignment for the frame. </p>

</div>
</div>
<a id="abd1db9449935817aedeab02d8aedd2fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd1db9449935817aedeab02d8aedd2fd">&#9670;&nbsp;</a></span>bits_per_sample</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t FLAC__FrameHeader::bits_per_sample</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The sample resolution. </p>

</div>
</div>
<a id="a7a62ec09e6f3029297179ef65377265f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a62ec09e6f3029297179ef65377265f">&#9670;&nbsp;</a></span>number_type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__flac__format.html#ga8fe9ebc78386cd2a3d23b7b8e3818e1c">FLAC__FrameNumberType</a> FLAC__FrameHeader::number_type</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>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. </p>

</div>
</div>
<a id="affc849f1d7c044302e4e5c6c733c4642"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affc849f1d7c044302e4e5c6c733c4642">&#9670;&nbsp;</a></span>number</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">union { ... }   FLAC__FrameHeader::number</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The frame number or sample number of first sample in frame; use the <em>number_type</em> value to determine which to use. </p>

</div>
</div>
<a id="a980438c380697df6f332cb27dc4672c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a980438c380697df6f332cb27dc4672c4">&#9670;&nbsp;</a></span>crc</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FLAC__uint8 FLAC__FrameHeader::crc</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>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. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/FLAC/<a class="el" href="format_8h_source.html">format.h</a></li>
</ul>
</div><!-- contents -->

<hr size="1"/>
<div class="copyright">
	<!-- @@@ oh so hacky -->
	<table>
		<tr>
			<td align="left">
				Copyright (c) 2000-2009  Josh Coalson
				Copyright (c) 2011-2016  Xiph.Org Foundation
			</td>
			<td width="1%" align="right">
				<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>
			</td>
		</tr>
	</table>
</div>
<!-- Copyright (c) 2000-2009  Josh Coalson -->
<!-- Copyright (c) 2011-2016  Xiph.Org Foundation -->
<!-- Permission is granted to copy, distribute and/or modify this document -->
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
<!-- or any later version published by the Free Software Foundation; -->
<!-- with no invariant sections. -->
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
</body>
</html>