<!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"/>
<title>libkate: Decoding</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Decoding</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoding.html#ga8c115ec78611f65acb573ad4cd0e43b1">kate_decode_is_idheader</a> (const <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoding.html#ga6ee6e5b8aa60a784f29245203e42d5f0">kate_decode_headerin</a> (<a class="el" href="structkate__info.html">kate_info</a> *ki, <a class="el" href="structkate__comment.html">kate_comment</a> *kc, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoding.html#gaecc12ec59e4b3256f50b5c135d4fe90f">kate_decode_init</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, <a class="el" href="structkate__info.html">kate_info</a> *ki)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoding.html#gaa64b1bc38a77b954377609c79e47bd55">kate_decode_packetin</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, <a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoding.html#gacdc7b2786e9fb2c8c685ebe3f483852c">kate_decode_eventout</a> (<a class="el" href="structkate__state.html">kate_state</a> *k, kate_const <a class="el" href="structkate__event.html">kate_event</a> **event)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__decoding.html#gade688e85ce9eaee37f98c7b1cde89674">kate_decode_seek</a> (<a class="el" href="structkate__state.html">kate_state</a> *k)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gacdc7b2786e9fb2c8c685ebe3f483852c"></a><!-- doxytag: member="kate_decode.c::kate_decode_eventout" ref="gacdc7b2786e9fb2c8c685ebe3f483852c" args="(kate_state *k, kate_const kate_event **event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_decode_eventout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">kate_const <a class="el" href="structkate__event.html">kate_event</a> ** </td>
<td class="paramname"> <em>event</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Requests a pointer to the event decoded by the last packet, if there is one. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to get the event from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>a pointer to where to place the pointer to the event, if any </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success, an event was returned </dd>
<dd>
1 success, but there was no event to return </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate_8h_source.html#l00656">KATE_E_INIT</a>, and <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>.</p>
<p>Referenced by <a class="el" href="kate__high_8c_source.html#l00085">kate_high_decode_packetin()</a>.</p>
</div>
</div>
<a class="anchor" id="ga6ee6e5b8aa60a784f29245203e42d5f0"></a><!-- doxytag: member="kate_decode.c::kate_decode_headerin" ref="ga6ee6e5b8aa60a784f29245203e42d5f0" args="(kate_info *ki, kate_comment *kc, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_decode_headerin </td>
<td>(</td>
<td class="paramtype"><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"><a class="el" href="structkate__comment.html">kate_comment</a> * </td>
<td class="paramname"> <em>kc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decodes a header packet, and updates the <a class="el" href="structkate__info.html">kate_info</a> and <a class="el" href="structkate__comment.html">kate_comment</a> structures from the decoded data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ki</em> </td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure to update </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kc</em> </td><td>the <a class="el" href="structkate__comment.html">kate_comment</a> structure to update </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to decode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
1 success, and all headers have been decoded </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate_8h_source.html#l00515">kate_packet::data</a>, <a class="el" href="kate_8h_source.html#l00657">KATE_E_BAD_PACKET</a>, <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>, and <a class="el" href="kate_8h_source.html#l00514">kate_packet::nbytes</a>.</p>
<p>Referenced by <a class="el" href="kate__high_8c_source.html#l00085">kate_high_decode_packetin()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00240">kate_ogg_decode_headerin()</a>.</p>
</div>
</div>
<a class="anchor" id="gaecc12ec59e4b3256f50b5c135d4fe90f"></a><!-- doxytag: member="kate_decode.c::kate_decode_init" ref="gaecc12ec59e4b3256f50b5c135d4fe90f" args="(kate_state *k, kate_info *ki)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_decode_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__info.html">kate_info</a> * </td>
<td class="paramname"> <em>ki</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes a <a class="el" href="structkate__state.html">kate_state</a> structure for decoding using the supplied <a class="el" href="structkate__info.html">kate_info</a> structure. When done, the <a class="el" href="structkate__state.html">kate_state</a> should be cleared using kate_clear. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to initialize for decoding </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ki</em> </td><td>the <a class="el" href="structkate__info.html">kate_info</a> structure initialized from the decoded headers </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>, <a class="el" href="kate_8h_source.html#l00654">KATE_E_OUT_OF_MEMORY</a>, and <a class="el" href="kate_8h_source.html#l00326">kate_state::ki</a>.</p>
</div>
</div>
<a class="anchor" id="ga8c115ec78611f65acb573ad4cd0e43b1"></a><!-- doxytag: member="kate_decode.c::kate_decode_is_idheader" ref="ga8c115ec78611f65acb573ad4cd0e43b1" args="(const kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_decode_is_idheader </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Checks if a packet is a Kate ID header </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to inspect </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 the packet is not an ID header </dd>
<dd>
!=0 the packet is an ID header </dd></dl>
<p>References <a class="el" href="kate_8h_source.html#l00515">kate_packet::data</a>, and <a class="el" href="kate_8h_source.html#l00514">kate_packet::nbytes</a>.</p>
<p>Referenced by <a class="el" href="kate__ogg_8c_source.html#l00222">kate_ogg_decode_is_idheader()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa64b1bc38a77b954377609c79e47bd55"></a><!-- doxytag: member="kate_decode.c::kate_decode_packetin" ref="gaa64b1bc38a77b954377609c79e47bd55" args="(kate_state *k, kate_packet *kp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_decode_packetin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"> <em>kp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Decodes a data packet. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> to decode to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the packet to decode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
1 success, and we're at end of stream </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate_8h_source.html#l00515">kate_packet::data</a>, <a class="el" href="kate_8h_source.html#l00656">KATE_E_INIT</a>, <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>, <a class="el" href="kate_8h_source.html#l00326">kate_state::ki</a>, and <a class="el" href="kate_8h_source.html#l00514">kate_packet::nbytes</a>.</p>
<p>Referenced by <a class="el" href="kate__high_8c_source.html#l00085">kate_high_decode_packetin()</a>, and <a class="el" href="kate__ogg_8c_source.html#l00256">kate_ogg_decode_packetin()</a>.</p>
</div>
</div>
<a class="anchor" id="gade688e85ce9eaee37f98c7b1cde89674"></a><!-- doxytag: member="kate_decode.c::kate_decode_seek" ref="gade688e85ce9eaee37f98c7b1cde89674" args="(kate_state *k)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_decode_seek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__state.html">kate_state</a> * </td>
<td class="paramname"> <em>k</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Informs the Kate decoder that seeking has occured. This will cause the decoder to use any future repeat packets to recover data from past events which are still active, but which original packets were before the seek point, and therefore unavailable. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>k</em> </td><td>the <a class="el" href="structkate__state.html">kate_state</a> for which a seek occured </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate_8h_source.html#l00656">KATE_E_INIT</a>, and <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Dec 23 04:05:07 2009 for libkate by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
