EVOLUTION-MANAGER
Edit File: oggz__io_8h_source.html
<!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.5"/> <title>liboggz: oggz_io.h Source File</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 style="padding-left: 0.5em;"> <div id="projectname">liboggz  <span id="projectnumber">1.1.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d87111fb9e25a5f2a11bf853c53bb708.html">oggz</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">oggz_io.h</div> </div> </div><!--header--> <div class="contents"> <a href="oggz__io_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Copyright (C) 2003 Commonwealth Scientific and Industrial Research</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Organisation (CSIRO) Australia</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> Redistribution and use in source and binary forms, with or without</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> modification, are permitted provided that the following conditions</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> are met:</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> - Redistributions of source code must retain the above copyright</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> notice, this list of conditions and the following disclaimer.</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> - Redistributions in binary form must reproduce the above copyright</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> notice, this list of conditions and the following disclaimer in the</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> documentation and/or other materials provided with the distribution.</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> - Neither the name of CSIRO Australia nor the names of its</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> contributors may be used to endorse or promote products derived from</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> this software without specific prior written permission.</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"></span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">*/</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#ifndef __OGGZ_IO_H__</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="preprocessor">#define __OGGZ_IO_H__</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733"> 65</a></span> <span class="keyword">typedef</span> size_t (*<a class="code" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733">OggzIORead</a>) (<span class="keywordtype">void</span> * user_handle, <span class="keywordtype">void</span> * buf, <span class="keywordtype">size_t</span> n);</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f"> 78</a></span> <span class="keyword">typedef</span> size_t (*<a class="code" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f">OggzIOWrite</a>) (<span class="keywordtype">void</span> * user_handle, <span class="keywordtype">void</span> * buf, <span class="keywordtype">size_t</span> n);</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> <div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75"> 93</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75">OggzIOSeek</a>) (<span class="keywordtype">void</span> * user_handle, <span class="keywordtype">long</span> offset, <span class="keywordtype">int</span> whence);</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> <div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669"> 104</a></span> <span class="keyword">typedef</span> long (*<a class="code" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669">OggzIOTell</a>) (<span class="keywordtype">void</span> * user_handle);</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div> <div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3"> 115</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3">OggzIOFlush</a>) (<span class="keywordtype">void</span> * user_handle);</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div> <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#a640ecb60fcee9323f1f735ad23f7abc4">oggz_io_set_read</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733">OggzIORead</a> read, <span class="keywordtype">void</span> * user_handle);</div> <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div> <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#af5bbd37e9a390e3c282fdc8bfadc43f6">oggz_io_get_read_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz);</div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#af92f5b20bb5f247b5302dfc8b4edfbee">oggz_io_set_write</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f">OggzIOWrite</a> write, <span class="keywordtype">void</span> * user_handle);</div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div> <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#a024a62f080f1b64c465b0bf475ebfd2e">oggz_io_get_write_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz);</div> <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#a8482fb0783df2621e811c14d642b01fc">oggz_io_set_seek</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75">OggzIOSeek</a> seek, <span class="keywordtype">void</span> * user_handle);</div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#a718ea817110f0d94d9d6f3a457707a08">oggz_io_get_seek_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz);</div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div> <div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#ad97da84267d72ab9abf8dbb9ff5e8931">oggz_io_set_tell</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669">OggzIOTell</a> tell, <span class="keywordtype">void</span> * user_handle);</div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div> <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#a54b69e5159280c1224025df925e67b50">oggz_io_get_tell_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz);</div> <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div> <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#af45a2d33c7e17d1b64f794b32d69e7da">oggz_io_set_flush</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3">OggzIOFlush</a> flush, <span class="keywordtype">void</span> * user_handle);</div> <div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div> <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#a6150bee0cc28c68553bdcc6d020f6932">oggz_io_get_flush_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz);</div> <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> </div> <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="preprocessor">#endif </span><span class="comment">/* __OGGZ_IO_H__ */</span><span class="preprocessor"></span></div> <div class="ttc" id="oggz__io_8h_html_a6150bee0cc28c68553bdcc6d020f6932"><div class="ttname"><a href="oggz__io_8h.html#a6150bee0cc28c68553bdcc6d020f6932">oggz_io_get_flush_user_handle</a></div><div class="ttdeci">void * oggz_io_get_flush_user_handle(OGGZ *oggz)</div><div class="ttdoc">Retrieve the user_handle associated with the function you have provided for flushing output...</div></div> <div class="ttc" id="oggz__io_8h_html_a0274a389b81ba93dae32d3d2fe39637f"><div class="ttname"><a href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f">OggzIOWrite</a></div><div class="ttdeci">size_t(* OggzIOWrite)(void *user_handle, void *buf, size_t n)</div><div class="ttdoc">This is the signature of a function which you provide for Oggz to call when it needs to output raw da...</div><div class="ttdef"><b>Definition:</b> oggz_io.h:78</div></div> <div class="ttc" id="oggz__io_8h_html_ad97da84267d72ab9abf8dbb9ff5e8931"><div class="ttname"><a href="oggz__io_8h.html#ad97da84267d72ab9abf8dbb9ff5e8931">oggz_io_set_tell</a></div><div class="ttdeci">int oggz_io_set_tell(OGGZ *oggz, OggzIOTell tell, void *user_handle)</div><div class="ttdoc">Set a function for Oggz to call when it needs to determine the offset within its input data (if OGGZ_...</div></div> <div class="ttc" id="oggz__io_8h_html_ae4995dabd7027c5a2273fe6db94c4733"><div class="ttname"><a href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733">OggzIORead</a></div><div class="ttdeci">size_t(* OggzIORead)(void *user_handle, void *buf, size_t n)</div><div class="ttdoc">This is the signature of a function which you provide for Oggz to call when it needs to acquire raw i...</div><div class="ttdef"><b>Definition:</b> oggz_io.h:65</div></div> <div class="ttc" id="oggz__io_8h_html_af45a2d33c7e17d1b64f794b32d69e7da"><div class="ttname"><a href="oggz__io_8h.html#af45a2d33c7e17d1b64f794b32d69e7da">oggz_io_set_flush</a></div><div class="ttdeci">int oggz_io_set_flush(OGGZ *oggz, OggzIOFlush flush, void *user_handle)</div><div class="ttdoc">Set a function for Oggz to call when it needs to flush its output. </div></div> <div class="ttc" id="oggz__io_8h_html_ab92c1e4e1bc98165cb7e9a0920a09b75"><div class="ttname"><a href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75">OggzIOSeek</a></div><div class="ttdeci">int(* OggzIOSeek)(void *user_handle, long offset, int whence)</div><div class="ttdoc">This is the signature of a function which you provide for Oggz to call when it needs to seek on the r...</div><div class="ttdef"><b>Definition:</b> oggz_io.h:93</div></div> <div class="ttc" id="oggz__io_8h_html_a8482fb0783df2621e811c14d642b01fc"><div class="ttname"><a href="oggz__io_8h.html#a8482fb0783df2621e811c14d642b01fc">oggz_io_set_seek</a></div><div class="ttdeci">int oggz_io_set_seek(OGGZ *oggz, OggzIOSeek seek, void *user_handle)</div><div class="ttdoc">Set a function for Oggz to call when it needs to seek on its raw data. </div></div> <div class="ttc" id="oggz__io_8h_html_a024a62f080f1b64c465b0bf475ebfd2e"><div class="ttname"><a href="oggz__io_8h.html#a024a62f080f1b64c465b0bf475ebfd2e">oggz_io_get_write_user_handle</a></div><div class="ttdeci">void * oggz_io_get_write_user_handle(OGGZ *oggz)</div><div class="ttdoc">Retrieve the user_handle associated with the function you have provided for writing output data...</div></div> <div class="ttc" id="oggz__io_8h_html_a640ecb60fcee9323f1f735ad23f7abc4"><div class="ttname"><a href="oggz__io_8h.html#a640ecb60fcee9323f1f735ad23f7abc4">oggz_io_set_read</a></div><div class="ttdeci">int oggz_io_set_read(OGGZ *oggz, OggzIORead read, void *user_handle)</div><div class="ttdoc">Set a function for Oggz to call when it needs to read input data. </div></div> <div class="ttc" id="oggz_8h_html_a672d218df13da45a4b41d5366211bfee"><div class="ttname"><a href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a></div><div class="ttdeci">void OGGZ</div><div class="ttdoc">An opaque handle to an Ogg file. </div><div class="ttdef"><b>Definition:</b> oggz.h:441</div></div> <div class="ttc" id="oggz__io_8h_html_a718ea817110f0d94d9d6f3a457707a08"><div class="ttname"><a href="oggz__io_8h.html#a718ea817110f0d94d9d6f3a457707a08">oggz_io_get_seek_user_handle</a></div><div class="ttdeci">void * oggz_io_get_seek_user_handle(OGGZ *oggz)</div><div class="ttdoc">Retrieve the user_handle associated with the function you have provided for seeking on input or outpu...</div></div> <div class="ttc" id="oggz__io_8h_html_adac7e4773781ad067f0591e1699fd669"><div class="ttname"><a href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669">OggzIOTell</a></div><div class="ttdeci">long(* OggzIOTell)(void *user_handle)</div><div class="ttdoc">This is the signature of a function which you provide for Oggz to call when it needs to determine the...</div><div class="ttdef"><b>Definition:</b> oggz_io.h:104</div></div> <div class="ttc" id="oggz__io_8h_html_af92f5b20bb5f247b5302dfc8b4edfbee"><div class="ttname"><a href="oggz__io_8h.html#af92f5b20bb5f247b5302dfc8b4edfbee">oggz_io_set_write</a></div><div class="ttdeci">int oggz_io_set_write(OGGZ *oggz, OggzIOWrite write, void *user_handle)</div><div class="ttdoc">Set a function for Oggz to call when it needs to write output data. </div></div> <div class="ttc" id="oggz__io_8h_html_a2d41d748db3b60bb25f716bcebf2f1e3"><div class="ttname"><a href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3">OggzIOFlush</a></div><div class="ttdeci">int(* OggzIOFlush)(void *user_handle)</div><div class="ttdoc">This is the signature of a function which you provide for Oggz to call when it needs to flush the out...</div><div class="ttdef"><b>Definition:</b> oggz_io.h:115</div></div> <div class="ttc" id="oggz__io_8h_html_a54b69e5159280c1224025df925e67b50"><div class="ttname"><a href="oggz__io_8h.html#a54b69e5159280c1224025df925e67b50">oggz_io_get_tell_user_handle</a></div><div class="ttdeci">void * oggz_io_get_tell_user_handle(OGGZ *oggz)</div><div class="ttdoc">Retrieve the user_handle associated with the function you have provided for determining the current o...</div></div> <div class="ttc" id="oggz__io_8h_html_af5bbd37e9a390e3c282fdc8bfadc43f6"><div class="ttname"><a href="oggz__io_8h.html#af5bbd37e9a390e3c282fdc8bfadc43f6">oggz_io_get_read_user_handle</a></div><div class="ttdeci">void * oggz_io_get_read_user_handle(OGGZ *oggz)</div><div class="ttdoc">Retrieve the user_handle associated with the function you have provided for reading input data...</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>