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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libkate: Granule calculations</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 id="projectrow">
<td id="projectalign">
<div id="projectname">libkate<span id="projectnumber"> 0.4.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Granule calculations</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gae265915dec153797580ab25cc4d12762"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#gae265915dec153797580ab25cc4d12762">kate_granule_shift</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki)</td></tr>
<tr class="separator:gae265915dec153797580ab25cc4d12762"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga39a421f2d4da4e657a35328d9154290f"><td class="memItemLeft" align="right" valign="top">kate_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#ga39a421f2d4da4e657a35328d9154290f">kate_time_granule</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki, kate_float base, kate_float offset)</td></tr>
<tr class="separator:ga39a421f2d4da4e657a35328d9154290f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8a77ab382e5469b1ef4e6ee5088e0ba7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#ga8a77ab382e5469b1ef4e6ee5088e0ba7">kate_granule_split_time</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki, kate_int64_t granulepos, kate_float *base, kate_float *offset)</td></tr>
<tr class="separator:ga8a77ab382e5469b1ef4e6ee5088e0ba7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga22c52f60e9bfe21611e36b8e49db75b2"><td class="memItemLeft" align="right" valign="top">kate_float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#ga22c52f60e9bfe21611e36b8e49db75b2">kate_granule_time</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki, kate_int64_t granulepos)</td></tr>
<tr class="separator:ga22c52f60e9bfe21611e36b8e49db75b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga97968d326ab6e2d78ac46fbb0e825f44"><td class="memItemLeft" align="right" valign="top">kate_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#ga97968d326ab6e2d78ac46fbb0e825f44">kate_duration_granule</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki, kate_float duration)</td></tr>
<tr class="separator:ga97968d326ab6e2d78ac46fbb0e825f44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga193045390452ca2de8d59754715ca6da"><td class="memItemLeft" align="right" valign="top">kate_float </td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#ga193045390452ca2de8d59754715ca6da">kate_granule_duration</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki, kate_int64_t duration)</td></tr>
<tr class="separator:ga193045390452ca2de8d59754715ca6da"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga97968d326ab6e2d78ac46fbb0e825f44" name="ga97968d326ab6e2d78ac46fbb0e825f44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga97968d326ab6e2d78ac46fbb0e825f44">◆ </a></span>kate_duration_granule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_int64_t kate_duration_granule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structkate__info.html">kate_info</a> * </td>
<td class="paramname"><em>ki</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"><em>duration</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Converts a duration to a granule duration </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ki</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
<tr><td class="paramname">duration</td><td>the duration in seconds to convert to a granulepos offset </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>>=0 the time corresponding to the granulepos </dd>
<dd>
KATE_E_* error </dd></dl>
<p class="reference">References <a class="el" href="structkate__info.html#a00c2253966d5a22cc3e56f4f98dd4995">kate_info::gps_denominator</a>, <a class="el" href="structkate__info.html#a7eb196702d96e5676b27838cadfd6acf">kate_info::gps_numerator</a>, <a class="el" href="kate_8h.html#aab7f2fdb1ad034628d6949958bbbb3bf">KATE_E_BAD_GRANULE</a>, and <a class="el" href="kate_8h.html#ae8ebebffaa4e6519c307a079d6d13107">KATE_E_INVALID_PARAMETER</a>.</p>
<p class="reference">Referenced by <a class="el" href="group__encoding.html#gafad57b37a14cc49ede82fd198e9f0e66">kate_encode_finish()</a>, <a class="el" href="group__encoding.html#ga78e91931f72e168c5abe7fda8c137836">kate_encode_keepalive()</a>, <a class="el" href="group__encoding.html#gae3b9b3f260d5365745e4cdd888502683">kate_encode_repeat()</a>, and <a class="el" href="group__encoding.html#ga83a014a63281d6b9a7e5f95b1ca0271b">kate_encode_text()</a>.</p>
</div>
</div>
<a id="ga193045390452ca2de8d59754715ca6da" name="ga193045390452ca2de8d59754715ca6da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga193045390452ca2de8d59754715ca6da">◆ </a></span>kate_granule_duration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_float kate_granule_duration </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structkate__info.html">kate_info</a> * </td>
<td class="paramname"><em>ki</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"><em>duration</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Converts a granule offset position to a time in seconds. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ki</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
<tr><td class="paramname">duration</td><td>the granulepos offset to convert to a time </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>>=0 the time corresponding to the granulepos offset </dd>
<dd>
KATE_E_* error </dd></dl>
<p class="reference">References <a class="el" href="structkate__info.html#a00c2253966d5a22cc3e56f4f98dd4995">kate_info::gps_denominator</a>, <a class="el" href="structkate__info.html#a7eb196702d96e5676b27838cadfd6acf">kate_info::gps_numerator</a>, and <a class="el" href="kate_8h.html#ae8ebebffaa4e6519c307a079d6d13107">KATE_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a id="gae265915dec153797580ab25cc4d12762" name="gae265915dec153797580ab25cc4d12762"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae265915dec153797580ab25cc4d12762">◆ </a></span>kate_granule_shift()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_granule_shift </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structkate__info.html">kate_info</a> * </td>
<td class="paramname"><em>ki</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Returns the granule shift for the given stream </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ki</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>>=0 the granule shift </dd>
<dd>
KATE_E_* error </dd></dl>
<p class="reference">References <a class="el" href="structkate__info.html#a1bf457732577344fa6d0f035d30d1e13">kate_info::granule_shift</a>, and <a class="el" href="kate_8h.html#ae8ebebffaa4e6519c307a079d6d13107">KATE_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a id="ga8a77ab382e5469b1ef4e6ee5088e0ba7" name="ga8a77ab382e5469b1ef4e6ee5088e0ba7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8a77ab382e5469b1ef4e6ee5088e0ba7">◆ </a></span>kate_granule_split_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_granule_split_time </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structkate__info.html">kate_info</a> * </td>
<td class="paramname"><em>ki</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"><em>granulepos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float * </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float * </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Converts a granule position to a base+offset time representation in seconds. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ki</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
<tr><td class="paramname">granulepos</td><td>the granulepos to convert to a time representation </td></tr>
<tr><td class="paramname">base</td><td>a pointer where to store the base part of the time corresponding to the granulepos </td></tr>
<tr><td class="paramname">offset</td><td>a pointer where to store the offset part of the time corresponding to the granulepos </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p class="reference">References <a class="el" href="structkate__info.html#a00c2253966d5a22cc3e56f4f98dd4995">kate_info::gps_denominator</a>, <a class="el" href="structkate__info.html#a7eb196702d96e5676b27838cadfd6acf">kate_info::gps_numerator</a>, <a class="el" href="structkate__info.html#a1bf457732577344fa6d0f035d30d1e13">kate_info::granule_shift</a>, and <a class="el" href="kate_8h.html#ae8ebebffaa4e6519c307a079d6d13107">KATE_E_INVALID_PARAMETER</a>.</p>
<p class="reference">Referenced by <a class="el" href="group__granule.html#ga22c52f60e9bfe21611e36b8e49db75b2">kate_granule_time()</a>.</p>
</div>
</div>
<a id="ga22c52f60e9bfe21611e36b8e49db75b2" name="ga22c52f60e9bfe21611e36b8e49db75b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga22c52f60e9bfe21611e36b8e49db75b2">◆ </a></span>kate_granule_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_float kate_granule_time </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structkate__info.html">kate_info</a> * </td>
<td class="paramname"><em>ki</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_int64_t </td>
<td class="paramname"><em>granulepos</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Converts a granule position to a time in seconds. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ki</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
<tr><td class="paramname">granulepos</td><td>the granulepos to convert to a time </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>>=0 the time corresponding to the granulepos </dd>
<dd>
KATE_E_* error </dd></dl>
<p class="reference">References <a class="el" href="group__granule.html#ga8a77ab382e5469b1ef4e6ee5088e0ba7">kate_granule_split_time()</a>.</p>
</div>
</div>
<a id="ga39a421f2d4da4e657a35328d9154290f" name="ga39a421f2d4da4e657a35328d9154290f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga39a421f2d4da4e657a35328d9154290f">◆ </a></span>kate_time_granule()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_int64_t kate_time_granule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structkate__info.html">kate_info</a> * </td>
<td class="paramname"><em>ki</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_float </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Converts a base/offset pair in seconds to a granule position </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ki</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
<tr><td class="paramname">base</td><td>the base time in seconds to convert </td></tr>
<tr><td class="paramname">offset</td><td>the time offset in seconds to convert </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>>=0 the granule corresponding to the base/offset pair </dd>
<dd>
KATE_E_* error </dd></dl>
<p class="reference">References <a class="el" href="structkate__info.html#a00c2253966d5a22cc3e56f4f98dd4995">kate_info::gps_denominator</a>, <a class="el" href="structkate__info.html#a7eb196702d96e5676b27838cadfd6acf">kate_info::gps_numerator</a>, <a class="el" href="structkate__info.html#a1bf457732577344fa6d0f035d30d1e13">kate_info::granule_shift</a>, <a class="el" href="kate_8h.html#ae8ebebffaa4e6519c307a079d6d13107">KATE_E_INVALID_PARAMETER</a>, and <a class="el" href="kate_8h.html#a3ef26b965c00b12c65c6af720591d601">KATE_E_LIMIT</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
|
