Blob Blame History Raw
<!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 Source File</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&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 class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<h1>oggz_io.h</h1><a href="oggz__io_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">   Copyright (C) 2003 Commonwealth Scientific and Industrial Research</span>
<a name="l00003"></a>00003 <span class="comment">   Organisation (CSIRO) Australia</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">   Redistribution and use in source and binary forms, with or without</span>
<a name="l00006"></a>00006 <span class="comment">   modification, are permitted provided that the following conditions</span>
<a name="l00007"></a>00007 <span class="comment">   are met:</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">   - Redistributions of source code must retain the above copyright</span>
<a name="l00010"></a>00010 <span class="comment">   notice, this list of conditions and the following disclaimer.</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment">   - Redistributions in binary form must reproduce the above copyright</span>
<a name="l00013"></a>00013 <span class="comment">   notice, this list of conditions and the following disclaimer in the</span>
<a name="l00014"></a>00014 <span class="comment">   documentation and/or other materials provided with the distribution.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">   - Neither the name of CSIRO Australia nor the names of its</span>
<a name="l00017"></a>00017 <span class="comment">   contributors may be used to endorse or promote products derived from</span>
<a name="l00018"></a>00018 <span class="comment">   this software without specific prior written permission.</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
<a name="l00021"></a>00021 <span class="comment">   ``AS IS&#39;&#39; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
<a name="l00022"></a>00022 <span class="comment">   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</span>
<a name="l00023"></a>00023 <span class="comment">   PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR</span>
<a name="l00024"></a>00024 <span class="comment">   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span>
<a name="l00025"></a>00025 <span class="comment">   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span>
<a name="l00026"></a>00026 <span class="comment">   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<a name="l00027"></a>00027 <span class="comment">   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</span>
<a name="l00028"></a>00028 <span class="comment">   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span>
<a name="l00029"></a>00029 <span class="comment">   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
<a name="l00030"></a>00030 <span class="comment">   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00031"></a>00031 <span class="comment">*/</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="preprocessor">#ifndef __OGGZ_IO_H__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define __OGGZ_IO_H__</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00065"></a><a class="code" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733">00065</a> <span class="keyword">typedef</span> size_t (*<a class="code" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIORead</a>) (<span class="keywordtype">void</span> * user_handle, <span class="keywordtype">void</span> * buf, <span class="keywordtype">size_t</span> n);
<a name="l00066"></a>00066 
<a name="l00078"></a><a class="code" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f">00078</a> <span class="keyword">typedef</span> size_t (*<a class="code" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIOWrite</a>) (<span class="keywordtype">void</span> * user_handle, <span class="keywordtype">void</span> * buf, <span class="keywordtype">size_t</span> n);
<a name="l00079"></a>00079 
<a name="l00093"></a><a class="code" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75">00093</a> <span class="keyword">typedef</span> int (*<a class="code" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIOSeek</a>) (<span class="keywordtype">void</span> * user_handle, <span class="keywordtype">long</span> offset, <span class="keywordtype">int</span> whence);
<a name="l00094"></a>00094 
<a name="l00104"></a><a class="code" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669">00104</a> <span class="keyword">typedef</span> long (*<a class="code" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIOTell</a>) (<span class="keywordtype">void</span> * user_handle);
<a name="l00105"></a>00105 
<a name="l00115"></a><a class="code" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3">00115</a> <span class="keyword">typedef</span> int (*<a class="code" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIOFlush</a>) (<span class="keywordtype">void</span> * user_handle);
<a name="l00116"></a>00116 
<a name="l00117"></a>00117 
<a name="l00130"></a>00130 <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#a640ecb60fcee9323f1f735ad23f7abc4" title="Set a function for Oggz to call when it needs to read input data.">oggz_io_set_read</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#ae4995dabd7027c5a2273fe6db94c4733" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIORead</a> read, <span class="keywordtype">void</span> * user_handle);
<a name="l00131"></a>00131 
<a name="l00139"></a>00139 <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#af5bbd37e9a390e3c282fdc8bfadc43f6" title="Retrieve the user_handle associated with the function you have provided for reading...">oggz_io_get_read_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz);
<a name="l00140"></a>00140 
<a name="l00153"></a>00153 <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#af92f5b20bb5f247b5302dfc8b4edfbee" title="Set a function for Oggz to call when it needs to write output data.">oggz_io_set_write</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#a0274a389b81ba93dae32d3d2fe39637f" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIOWrite</a> write, <span class="keywordtype">void</span> * user_handle);
<a name="l00154"></a>00154 
<a name="l00162"></a>00162 <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#a024a62f080f1b64c465b0bf475ebfd2e" title="Retrieve the user_handle associated with the function you have provided for writing...">oggz_io_get_write_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz);
<a name="l00163"></a>00163 
<a name="l00178"></a>00178 <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#a8482fb0783df2621e811c14d642b01fc" title="Set a function for Oggz to call when it needs to seek on its raw data.">oggz_io_set_seek</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#ab92c1e4e1bc98165cb7e9a0920a09b75" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIOSeek</a> seek, <span class="keywordtype">void</span> * user_handle);
<a name="l00179"></a>00179 
<a name="l00187"></a>00187 <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#a718ea817110f0d94d9d6f3a457707a08" title="Retrieve the user_handle associated with the function you have provided for seeking...">oggz_io_get_seek_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz);
<a name="l00188"></a>00188 
<a name="l00201"></a>00201 <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#ad97da84267d72ab9abf8dbb9ff5e8931" title="Set a function for Oggz to call when it needs to determine the offset within its...">oggz_io_set_tell</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#adac7e4773781ad067f0591e1699fd669" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIOTell</a> tell, <span class="keywordtype">void</span> * user_handle);
<a name="l00202"></a>00202 
<a name="l00210"></a>00210 <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#a54b69e5159280c1224025df925e67b50" title="Retrieve the user_handle associated with the function you have provided for determining...">oggz_io_get_tell_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz);
<a name="l00211"></a>00211 
<a name="l00225"></a>00225 <span class="keywordtype">int</span> <a class="code" href="oggz__io_8h.html#af45a2d33c7e17d1b64f794b32d69e7da" title="Set a function for Oggz to call when it needs to flush its output.">oggz_io_set_flush</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <a class="code" href="oggz__io_8h.html#a2d41d748db3b60bb25f716bcebf2f1e3" title="This is the signature of a function which you provide for Oggz to call when it needs...">OggzIOFlush</a> flush, <span class="keywordtype">void</span> * user_handle);
<a name="l00226"></a>00226 
<a name="l00234"></a>00234 <span class="keywordtype">void</span> * <a class="code" href="oggz__io_8h.html#a6150bee0cc28c68553bdcc6d020f6932" title="Retrieve the user_handle associated with the function you have provided for flushing...">oggz_io_get_flush_user_handle</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz);
<a name="l00235"></a>00235 
<a name="l00236"></a>00236 <span class="preprocessor">#endif </span><span class="comment">/* __OGGZ_IO_H__ */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Apr 24 09:13:55 2010 for liboggz by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>