File: group__granule.html

package info (click to toggle)
libkate 0.3.7-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 4,484 kB
  • ctags: 4,083
  • sloc: ansic: 10,002; sh: 8,853; yacc: 2,250; python: 721; lex: 362; makefile: 239
file content (275 lines) | stat: -rw-r--r-- 13,559 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
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libkate: Granule calculations</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    <li><a href="examples.html"><span>Examples</span></a></li>
  </ul>
</div>
<h1>Granule calculations</h1><hr><a name="_details"></a><h2>Detailed Description</h2>

<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#ge265915dec153797580ab25cc4d12762">kate_granule_shift</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">kate_int64_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#g39a421f2d4da4e657a35328d9154290f">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><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#g8a77ab382e5469b1ef4e6ee5088e0ba7">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><td class="memItemLeft" nowrap align="right" valign="top">kate_float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#g22c52f60e9bfe21611e36b8e49db75b2">kate_granule_time</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki, kate_int64_t granulepos)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">kate_int64_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#g97968d326ab6e2d78ac46fbb0e825f44">kate_duration_granule</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki, kate_float duration)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">kate_float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__granule.html#g193045390452ca2de8d59754715ca6da">kate_granule_duration</a> (const <a class="el" href="structkate__info.html">kate_info</a> *ki, kate_int64_t duration)</td></tr>

</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g97968d326ab6e2d78ac46fbb0e825f44"></a><!-- doxytag: member="kate_granule.c::kate_duration_granule" ref="g97968d326ab6e2d78ac46fbb0e825f44" args="(const kate_info *ki, kate_float duration)" -->
<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> *&nbsp;</td>
          <td class="paramname"> <em>ki</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">kate_float&nbsp;</td>
          <td class="paramname"> <em>duration</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Converts a duration to a granule duration <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ki</em>&nbsp;</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>duration</em>&nbsp;</td><td>the duration in seconds to convert to a granulepos offset </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>&gt;=0 the time corresponding to the granulepos <p>
KATE_E_* error </dd></dl>

</div>
</div><p>
<a class="anchor" name="g193045390452ca2de8d59754715ca6da"></a><!-- doxytag: member="kate_granule.c::kate_granule_duration" ref="g193045390452ca2de8d59754715ca6da" args="(const kate_info *ki, kate_int64_t duration)" -->
<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> *&nbsp;</td>
          <td class="paramname"> <em>ki</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">kate_int64_t&nbsp;</td>
          <td class="paramname"> <em>duration</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Converts a granule offset position to a time in seconds. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ki</em>&nbsp;</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>duration</em>&nbsp;</td><td>the granulepos offset to convert to a time </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>&gt;=0 the time corresponding to the granulepos offset <p>
KATE_E_* error </dd></dl>

</div>
</div><p>
<a class="anchor" name="ge265915dec153797580ab25cc4d12762"></a><!-- doxytag: member="kate_granule.c::kate_granule_shift" ref="ge265915dec153797580ab25cc4d12762" args="(const kate_info *ki)" -->
<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> *&nbsp;</td>
          <td class="paramname"> <em>ki</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the granule shift for the given stream <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ki</em>&nbsp;</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>&gt;=0 the granule shift <p>
KATE_E_* error </dd></dl>

</div>
</div><p>
<a class="anchor" name="g8a77ab382e5469b1ef4e6ee5088e0ba7"></a><!-- doxytag: member="kate_granule.c::kate_granule_split_time" ref="g8a77ab382e5469b1ef4e6ee5088e0ba7" args="(const kate_info *ki, kate_int64_t granulepos, kate_float *base, kate_float *offset)" -->
<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> *&nbsp;</td>
          <td class="paramname"> <em>ki</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">kate_int64_t&nbsp;</td>
          <td class="paramname"> <em>granulepos</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">kate_float *&nbsp;</td>
          <td class="paramname"> <em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">kate_float *&nbsp;</td>
          <td class="paramname"> <em>offset</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Converts a granule position to a base+offset time representation in seconds. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ki</em>&nbsp;</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>granulepos</em>&nbsp;</td><td>the granulepos to convert to a time representation </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>base</em>&nbsp;</td><td>a pointer where to store the base part of the time corresponding to the granulepos </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>a pointer where to store the offset part of the time corresponding to the granulepos </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 success <p>
KATE_E_* error </dd></dl>

</div>
</div><p>
<a class="anchor" name="g22c52f60e9bfe21611e36b8e49db75b2"></a><!-- doxytag: member="kate_granule.c::kate_granule_time" ref="g22c52f60e9bfe21611e36b8e49db75b2" args="(const kate_info *ki, kate_int64_t granulepos)" -->
<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> *&nbsp;</td>
          <td class="paramname"> <em>ki</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">kate_int64_t&nbsp;</td>
          <td class="paramname"> <em>granulepos</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Converts a granule position to a time in seconds. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ki</em>&nbsp;</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>granulepos</em>&nbsp;</td><td>the granulepos to convert to a time </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>&gt;=0 the time corresponding to the granulepos <p>
KATE_E_* error </dd></dl>

</div>
</div><p>
<a class="anchor" name="g39a421f2d4da4e657a35328d9154290f"></a><!-- doxytag: member="kate_granule.c::kate_time_granule" ref="g39a421f2d4da4e657a35328d9154290f" args="(const kate_info *ki, kate_float base, kate_float offset)" -->
<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> *&nbsp;</td>
          <td class="paramname"> <em>ki</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">kate_float&nbsp;</td>
          <td class="paramname"> <em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">kate_float&nbsp;</td>
          <td class="paramname"> <em>offset</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Converts a base/offset pair in seconds to a granule position <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ki</em>&nbsp;</td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure describing the granule encoding setup </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>base</em>&nbsp;</td><td>the base time in seconds to convert </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>the time offset in seconds to convert </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>&gt;=0 the granule corresponding to the base/offset pair <p>
KATE_E_* error </dd></dl>

</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Nov 15 17:26:07 2009 for libkate by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>