<!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_read.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.7.3 -->
<div id="top">
<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>
<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 class="header">
<div class="headertitle">
<h1>oggz_read.h</h1> </div>
</div>
<div class="contents">
<a href="oggz__read_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'' 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_READ_H__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define __OGGZ_READ_H__</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <oggz/oggz_packet.h></span>
<a name="l00041"></a>00041
<a name="l00081"></a><a class="code" href="group__read__api.html#gad9d6114ffc7c956fd179863e51e0d542">00081</a> <span class="keyword">typedef</span> int (*<a class="code" href="group__read__api.html#gad9d6114ffc7c956fd179863e51e0d542" title="This is the signature of a callback which you must provide for Oggz to call whenever it finds a new p...">OggzReadPacket</a>) (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <a class="code" href="structoggz__packet.html" title="An ogg_packet and its position in the stream.">oggz_packet</a> * packet, <span class="keywordtype">long</span> serialno,
<a name="l00082"></a>00082 <span class="keywordtype">void</span> * user_data);
<a name="l00083"></a>00083
<a name="l00108"></a>00108 <span class="keywordtype">int</span> <a class="code" href="group__read__api.html#ga6d5aae4f7f186fffe19d4fd3cd63148d" title="Set a callback for Oggz to call when a new Ogg packet is found in the stream.">oggz_set_read_callback</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno,
<a name="l00109"></a>00109 <a class="code" href="group__read__api.html#gad9d6114ffc7c956fd179863e51e0d542" title="This is the signature of a callback which you must provide for Oggz to call whenever it finds a new p...">OggzReadPacket</a> read_packet, <span class="keywordtype">void</span> * user_data);
<a name="l00110"></a>00110
<a name="l00121"></a><a class="code" href="group__read__api.html#ga8a1df0166fad1a0a6fe55d24e1a4b2e6">00121</a> <span class="keyword">typedef</span> int (*<a class="code" href="group__read__api.html#ga8a1df0166fad1a0a6fe55d24e1a4b2e6" title="This is the signature of a callback which you must provide for Oggz to call whenever it finds a new p...">OggzReadPage</a>) (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keyword">const</span> ogg_page * og,
<a name="l00122"></a>00122 <span class="keywordtype">long</span> serialno, <span class="keywordtype">void</span> * user_data);
<a name="l00123"></a>00123
<a name="l00146"></a>00146 <span class="keywordtype">int</span> <a class="code" href="group__read__api.html#gafe738d4fdd4b00b1280f5978be19b2d5" title="Set a callback for Oggz to call when a new Ogg page is found in the stream.">oggz_set_read_page</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno,
<a name="l00147"></a>00147 <a class="code" href="group__read__api.html#ga8a1df0166fad1a0a6fe55d24e1a4b2e6" title="This is the signature of a callback which you must provide for Oggz to call whenever it finds a new p...">OggzReadPage</a> read_page, <span class="keywordtype">void</span> * user_data);
<a name="l00148"></a>00148
<a name="l00149"></a>00149
<a name="l00166"></a>00166 <span class="keywordtype">long</span> <a class="code" href="group__read__api.html#ga3ce7a31de5da56375057436c6b5108f2" title="Read n bytes into oggz, calling any read callbacks on the fly.">oggz_read</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> n);
<a name="l00167"></a>00167
<a name="l00183"></a>00183 <span class="keywordtype">long</span> <a class="code" href="group__read__api.html#ga77d4158dd119f496f73311ace7f630d6" title="Input data into oggz.">oggz_read_input</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * buf, <span class="keywordtype">long</span> n);
<a name="l00184"></a>00184
<a name="l00198"></a>00198 <span class="keywordtype">int</span> <a class="code" href="oggz__read_8h.html#adf606e6641a7d59eff2030b7b9ce51f8" title="Erase any input buffered in Oggz.">oggz_purge</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz);
<a name="l00199"></a>00199
<a name="l00211"></a>00211 <a class="code" href="oggz__constants_8h.html#ab20058e3d54fc5540aa719a99e1e9598" title="Definition of stream content types.">OggzStreamContent</a> <a class="code" href="oggz__read_8h.html#a1cd43b28f34bf82dc1830cc517b19e14" title="Determine the content type of the oggz stream referred to by serialno.">oggz_stream_get_content</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno);
<a name="l00212"></a>00212
<a name="l00222"></a>00222 <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="oggz__read_8h.html#a85665d758dbc159bc48055bf3f572b37" title="Return human-readable string representation of content type of oggz stream referred to by serialno...">oggz_stream_get_content_type</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> *oggz, <span class="keywordtype">long</span> serialno);
<a name="l00223"></a>00223
<a name="l00236"></a>00236 <span class="keywordtype">int</span> <a class="code" href="oggz__read_8h.html#ae3b1aa364b5bf0d7b331aab70646ab10" title="Determine the number of headers of the oggz stream referred to by serialno.">oggz_stream_get_numheaders</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno);
<a name="l00237"></a>00237
<a name="l00238"></a>00238 <span class="preprocessor">#endif </span><span class="comment">/* __OGGZ_READ_H__ */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 8 2011 for liboggz by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
