<!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>liboggz: oggz_io.h File Reference</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.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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 class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>oggz_io.h File Reference</h1>
<p>Overriding the functions used for input and output of raw data.
<a href="#_details">More...</a></p>
<p><a href="oggz__io_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef size_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733">OggzIORead</a> )(void *user_handle, void *buf, size_t n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the signature of a function which you provide for Oggz to call when it needs to acquire raw input data. <a href="#ae4995dabd7027c5a2273fe6db94c4733"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef size_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f">OggzIOWrite</a> )(void *user_handle, void *buf, size_t n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the signature of a function which you provide for Oggz to call when it needs to output raw data. <a href="#a0274a389b81ba93dae32d3d2fe39637f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75">OggzIOSeek</a> )(void *user_handle, long offset, int whence)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the signature of a function which you provide for Oggz to call when it needs to seek on the raw input or output data. <a href="#ab92c1e4e1bc98165cb7e9a0920a09b75"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef long(* </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669">OggzIOTell</a> )(void *user_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the signature of a function which you provide for Oggz to call when it needs to determine the current offset of the raw input or output data. <a href="#adac7e4773781ad067f0591e1699fd669"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3">OggzIOFlush</a> )(void *user_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This is the signature of a function which you provide for Oggz to call when it needs to flush the output data. <a href="#a2d41d748db3b60bb25f716bcebf2f1e3"></a><br/></td></tr>
<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="oggz__io_8h.html#a640ecb60fcee9323f1f735ad23f7abc4">oggz_io_set_read</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, <a class="el" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733">OggzIORead</a> read, void *user_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a function for Oggz to call when it needs to read input data. <a href="#a640ecb60fcee9323f1f735ad23f7abc4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#af5bbd37e9a390e3c282fdc8bfadc43f6">oggz_io_get_read_user_handle</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the user_handle associated with the function you have provided for reading input data. <a href="#af5bbd37e9a390e3c282fdc8bfadc43f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#af92f5b20bb5f247b5302dfc8b4edfbee">oggz_io_set_write</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, <a class="el" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f">OggzIOWrite</a> write, void *user_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a function for Oggz to call when it needs to write output data. <a href="#af92f5b20bb5f247b5302dfc8b4edfbee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#a024a62f080f1b64c465b0bf475ebfd2e">oggz_io_get_write_user_handle</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the user_handle associated with the function you have provided for writing output data. <a href="#a024a62f080f1b64c465b0bf475ebfd2e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#a8482fb0783df2621e811c14d642b01fc">oggz_io_set_seek</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, <a class="el" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75">OggzIOSeek</a> seek, void *user_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a function for Oggz to call when it needs to seek on its raw data. <a href="#a8482fb0783df2621e811c14d642b01fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#a718ea817110f0d94d9d6f3a457707a08">oggz_io_get_seek_user_handle</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the user_handle associated with the function you have provided for seeking on input or output data. <a href="#a718ea817110f0d94d9d6f3a457707a08"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#ad97da84267d72ab9abf8dbb9ff5e8931">oggz_io_set_tell</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, <a class="el" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669">OggzIOTell</a> tell, void *user_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a function for Oggz to call when it needs to determine the offset within its input data (if OGGZ_READ) or output data (if OGGZ_WRITE). <a href="#ad97da84267d72ab9abf8dbb9ff5e8931"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#a54b69e5159280c1224025df925e67b50">oggz_io_get_tell_user_handle</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the user_handle associated with the function you have provided for determining the current offset in input or output data. <a href="#a54b69e5159280c1224025df925e67b50"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#af45a2d33c7e17d1b64f794b32d69e7da">oggz_io_set_flush</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, <a class="el" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3">OggzIOFlush</a> flush, void *user_handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a function for Oggz to call when it needs to flush its output. <a href="#af45a2d33c7e17d1b64f794b32d69e7da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="oggz__io_8h.html#a6150bee0cc28c68553bdcc6d020f6932">oggz_io_get_flush_user_handle</a> (<a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the user_handle associated with the function you have provided for flushing output. <a href="#a6150bee0cc28c68553bdcc6d020f6932"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Overriding the functions used for input and output of raw data. </p>
<p>OggzIO provides a way of overriding the functions Oggz uses to access its raw input or output data. This is required in many situations where the raw stream cannot be accessed via stdio, but can be accessed by other means. This is typically useful within media frameworks, where accessing and moving around in the data is possible only using methods provided by the framework.</p>
<p>The functions you provide for overriding IO will be used by Oggz whenever you call <a class="el" href="group__read__api.html#ga3ce7a31de5da56375057436c6b5108f2" title="Read n bytes into oggz, calling any read callbacks on the fly.">oggz_read()</a> or <a class="el" href="group__write__api.html#ga3c97d94ea425d64546adf9c368b71904" title="Write n bytes from an OGGZ handle.">oggz_write()</a>. They will also be used repeatedly by Oggz when you call <a class="el" href="group__seek__api.html#gaeef4b261d443701207954e5a636d6817" title="Seek to a specific byte offset.">oggz_seek()</a>.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Opening a file with <a class="el" href="oggz_8h.html#a65197cdd03f755f7ebfabf2fdff4c7db" title="Open an Ogg file, creating an OGGZ handle for it.">oggz_open()</a> or <a class="el" href="oggz_8h.html#ac49e9de0bc4ef1d91b43b13605f98b19" title="Create an OGGZ handle associated with a stdio stream.">oggz_open_stdio()</a> is equivalent to calling <a class="el" href="oggz_8h.html#a6eb34d123389ae38d993601f9e7bb9d6" title="Create a new OGGZ object.">oggz_new()</a> and setting stdio based functions for data IO. </dd></dl>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a2d41d748db3b60bb25f716bcebf2f1e3"></a><!-- doxytag: member="oggz_io.h::OggzIOFlush" ref="a2d41d748db3b60bb25f716bcebf2f1e3" args=")(void *user_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* <a class="el" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3">OggzIOFlush</a>)(void *user_handle)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is the signature of a function which you provide for Oggz to call when it needs to flush the output data. </p>
<p>The behaviour of this function is similar to that of fflush() in stdio.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>user_handle</em> </td><td>A generic pointer you have provided earlier </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>Success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>< 0</em> </td><td>An error condition </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae4995dabd7027c5a2273fe6db94c4733"></a><!-- doxytag: member="oggz_io.h::OggzIORead" ref="ae4995dabd7027c5a2273fe6db94c4733" args=")(void *user_handle, void *buf, size_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef size_t(* <a class="el" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733">OggzIORead</a>)(void *user_handle, void *buf, size_t n)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is the signature of a function which you provide for Oggz to call when it needs to acquire raw input 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>user_handle</em> </td><td>A generic pointer you have provided earlier </td></tr>
<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>The length in bytes that Oggz wants to read </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>The buffer that you read data into </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>> 0</em> </td><td>The number of bytes successfully read into the buffer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>to indicate that there is no more data to read (End of file) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>< 0</em> </td><td>An error condition </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab92c1e4e1bc98165cb7e9a0920a09b75"></a><!-- doxytag: member="oggz_io.h::OggzIOSeek" ref="ab92c1e4e1bc98165cb7e9a0920a09b75" args=")(void *user_handle, long offset, int whence)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* <a class="el" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75">OggzIOSeek</a>)(void *user_handle, long offset, int whence)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is the signature of a function which you provide for Oggz to call when it needs to seek on the raw input or output 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>user_handle</em> </td><td>A generic pointer you have provided earlier </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>The offset in bytes to seek to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>whence</em> </td><td>SEEK_SET, SEEK_CUR or SEEK_END (as for stdio.h) </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>>= 0</em> </td><td>The offset seeked to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>< 0</em> </td><td>An error condition</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If you provide an OggzIOSeek function, you MUST also provide an OggzIOTell function, or else all your seeks will fail. </dd></dl>
</div>
</div>
<a class="anchor" id="adac7e4773781ad067f0591e1699fd669"></a><!-- doxytag: member="oggz_io.h::OggzIOTell" ref="adac7e4773781ad067f0591e1699fd669" args=")(void *user_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef long(* <a class="el" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669">OggzIOTell</a>)(void *user_handle)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is the signature of a function which you provide for Oggz to call when it needs to determine the current offset of the raw input or output 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>user_handle</em> </td><td>A generic pointer you have provided earlier </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>>= 0</em> </td><td>The offset </td></tr>
<tr><td valign="top"></td><td valign="top"><em>< 0</em> </td><td>An error condition </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0274a389b81ba93dae32d3d2fe39637f"></a><!-- doxytag: member="oggz_io.h::OggzIOWrite" ref="a0274a389b81ba93dae32d3d2fe39637f" args=")(void *user_handle, void *buf, size_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef size_t(* <a class="el" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f">OggzIOWrite</a>)(void *user_handle, void *buf, size_t n)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is the signature of a function which you provide for Oggz to call when it needs to output raw 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>user_handle</em> </td><td>A generic pointer you have provided earlier </td></tr>
<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>The length in bytes of the data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>A buffer containing data to write </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>>= 0</em> </td><td>The number of bytes successfully written (may be less than <em>n</em> if a write error has occurred) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>< 0</em> </td><td>An error condition </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a6150bee0cc28c68553bdcc6d020f6932"></a><!-- doxytag: member="oggz_io.h::oggz_io_get_flush_user_handle" ref="a6150bee0cc28c68553bdcc6d020f6932" args="(OGGZ *oggz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* oggz_io_get_flush_user_handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the user_handle associated with the function you have provided for flushing output. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the associated user_handle </dd></dl>
</div>
</div>
<a class="anchor" id="af5bbd37e9a390e3c282fdc8bfadc43f6"></a><!-- doxytag: member="oggz_io.h::oggz_io_get_read_user_handle" ref="af5bbd37e9a390e3c282fdc8bfadc43f6" args="(OGGZ *oggz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* oggz_io_get_read_user_handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the user_handle associated with the function you have provided for reading input 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>oggz</em> </td><td>An OGGZ handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the associated user_handle </dd></dl>
</div>
</div>
<a class="anchor" id="a718ea817110f0d94d9d6f3a457707a08"></a><!-- doxytag: member="oggz_io.h::oggz_io_get_seek_user_handle" ref="a718ea817110f0d94d9d6f3a457707a08" args="(OGGZ *oggz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* oggz_io_get_seek_user_handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the user_handle associated with the function you have provided for seeking on input or output 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>oggz</em> </td><td>An OGGZ handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the associated user_handle </dd></dl>
</div>
</div>
<a class="anchor" id="a54b69e5159280c1224025df925e67b50"></a><!-- doxytag: member="oggz_io.h::oggz_io_get_tell_user_handle" ref="a54b69e5159280c1224025df925e67b50" args="(OGGZ *oggz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* oggz_io_get_tell_user_handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the user_handle associated with the function you have provided for determining the current offset in input or output 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>oggz</em> </td><td>An OGGZ handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the associated user_handle </dd></dl>
</div>
</div>
<a class="anchor" id="a024a62f080f1b64c465b0bf475ebfd2e"></a><!-- doxytag: member="oggz_io.h::oggz_io_get_write_user_handle" ref="a024a62f080f1b64c465b0bf475ebfd2e" args="(OGGZ *oggz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* oggz_io_get_write_user_handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the user_handle associated with the function you have provided for writing output 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>oggz</em> </td><td>An OGGZ handle </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the associated user_handle </dd></dl>
</div>
</div>
<a class="anchor" id="af45a2d33c7e17d1b64f794b32d69e7da"></a><!-- doxytag: member="oggz_io.h::oggz_io_set_flush" ref="af45a2d33c7e17d1b64f794b32d69e7da" args="(OGGZ *oggz, OggzIOFlush flush, void *user_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_io_set_flush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3">OggzIOFlush</a> </td>
<td class="paramname"> <em>flush</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>user_handle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a function for Oggz to call when it needs to flush its output. </p>
<p>The meaning of this is similar to that of fflush() in stdio.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flush</em> </td><td>Your flushing function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_handle</em> </td><td>Any arbitrary data you wish to pass to the function </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>Success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_INVALID</em> </td><td>Operation not suitable for this OGGZ; <em>oggz</em> not open for writing. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_OUT_OF_MEMORY</em> </td><td>Out of memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a640ecb60fcee9323f1f735ad23f7abc4"></a><!-- doxytag: member="oggz_io.h::oggz_io_set_read" ref="a640ecb60fcee9323f1f735ad23f7abc4" args="(OGGZ *oggz, OggzIORead read, void *user_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_io_set_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733">OggzIORead</a> </td>
<td class="paramname"> <em>read</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>user_handle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a function for Oggz to call when it needs to read input 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>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>read</em> </td><td>Your reading function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_handle</em> </td><td>Any arbitrary data you wish to pass to the function </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>Success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_INVALID</em> </td><td>Operation not suitable for this OGGZ; <em>oggz</em> not open for reading. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_OUT_OF_MEMORY</em> </td><td>Out of memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8482fb0783df2621e811c14d642b01fc"></a><!-- doxytag: member="oggz_io.h::oggz_io_set_seek" ref="a8482fb0783df2621e811c14d642b01fc" args="(OGGZ *oggz, OggzIOSeek seek, void *user_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_io_set_seek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75">OggzIOSeek</a> </td>
<td class="paramname"> <em>seek</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>user_handle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a function for Oggz to call when it needs to seek on its raw 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>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>seek</em> </td><td>Your seeking function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_handle</em> </td><td>Any arbitrary data you wish to pass to the function </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>Success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_INVALID</em> </td><td>Operation not suitable for this OGGZ </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_OUT_OF_MEMORY</em> </td><td>Out of memory</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If you provide an OggzIOSeek function, you MUST also provide an OggzIOTell function, or else all your seeks will fail. </dd></dl>
</div>
</div>
<a class="anchor" id="ad97da84267d72ab9abf8dbb9ff5e8931"></a><!-- doxytag: member="oggz_io.h::oggz_io_set_tell" ref="ad97da84267d72ab9abf8dbb9ff5e8931" args="(OGGZ *oggz, OggzIOTell tell, void *user_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_io_set_tell </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669">OggzIOTell</a> </td>
<td class="paramname"> <em>tell</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>user_handle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a function for Oggz to call when it needs to determine the offset within its input data (if OGGZ_READ) or output data (if OGGZ_WRITE). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tell</em> </td><td>Your tell function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_handle</em> </td><td>Any arbitrary data you wish to pass to the function </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>Success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_INVALID</em> </td><td>Operation not suitable for this OGGZ </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_OUT_OF_MEMORY</em> </td><td>Out of memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af92f5b20bb5f247b5302dfc8b4edfbee"></a><!-- doxytag: member="oggz_io.h::oggz_io_set_write" ref="af92f5b20bb5f247b5302dfc8b4edfbee" args="(OGGZ *oggz, OggzIOWrite write, void *user_handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int oggz_io_set_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * </td>
<td class="paramname"> <em>oggz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f">OggzIOWrite</a> </td>
<td class="paramname"> <em>write</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>user_handle</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a function for Oggz to call when it needs to write output 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>oggz</em> </td><td>An OGGZ handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>write</em> </td><td>Your writing function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_handle</em> </td><td>Any arbitrary data you wish to pass to the function </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>Success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_BAD_OGGZ</em> </td><td><em>oggz</em> does not refer to an existing OGGZ </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_INVALID</em> </td><td>Operation not suitable for this OGGZ; <em>oggz</em> not open for writing. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>OGGZ_ERR_OUT_OF_MEMORY</em> </td><td>Out of memory </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Apr 24 09:13:55 2010 for liboggz by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>