EVOLUTION-MANAGER
Edit File: oggz__read_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_read.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_read.h</div> </div> </div><!--header--> <div class="contents"> <a href="oggz__read_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_READ_H__</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="preprocessor">#define __OGGZ_READ_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="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include <<a class="code" href="oggz__packet_8h.html">oggz/oggz_packet.h</a>></span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> <div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="group__read__api.html#gad9d6114ffc7c956fd179863e51e0d542"> 81</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="group__read__api.html#gad9d6114ffc7c956fd179863e51e0d542">OggzReadPacket</a>) (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <a class="code" href="structoggz__packet.html">oggz_packet</a> * packet, <span class="keywordtype">long</span> serialno,</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> * user_data);</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keywordtype">int</span> <a class="code" href="group__read__api.html#ga6d5aae4f7f186fffe19d4fd3cd63148d">oggz_set_read_callback</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno,</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="group__read__api.html#gad9d6114ffc7c956fd179863e51e0d542">OggzReadPacket</a> read_packet, <span class="keywordtype">void</span> * user_data);</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> <div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="group__read__api.html#ga8a1df0166fad1a0a6fe55d24e1a4b2e6"> 121</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="group__read__api.html#ga8a1df0166fad1a0a6fe55d24e1a4b2e6">OggzReadPage</a>) (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <span class="keyword">const</span> ogg_page * og,</div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">long</span> serialno, <span class="keywordtype">void</span> * user_data);</div> <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="keywordtype">int</span> <a class="code" href="group__read__api.html#gafe738d4fdd4b00b1280f5978be19b2d5">oggz_set_read_page</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno,</div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <a class="code" href="group__read__api.html#ga8a1df0166fad1a0a6fe55d24e1a4b2e6">OggzReadPage</a> read_page, <span class="keywordtype">void</span> * user_data);</div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keywordtype">long</span> <a class="code" href="group__read__api.html#ga3ce7a31de5da56375057436c6b5108f2">oggz_read</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <span class="keywordtype">long</span> n);</div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="keywordtype">long</span> <a class="code" href="group__read__api.html#ga77d4158dd119f496f73311ace7f630d6">oggz_read_input</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * buf, <span class="keywordtype">long</span> n);</div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div> <div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="keywordtype">int</span> <a class="code" href="oggz__read_8h.html#adf606e6641a7d59eff2030b7b9ce51f8">oggz_purge</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz);</div> <div class="line"><a name="l00199"></a><span class="lineno"> 199</span> </div> <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <a class="code" href="oggz__constants_8h.html#ab20058e3d54fc5540aa719a99e1e9598">OggzStreamContent</a> <a class="code" href="oggz__read_8h.html#a1cd43b28f34bf82dc1830cc517b19e14">oggz_stream_get_content</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno);</div> <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div> <div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="oggz__read_8h.html#a85665d758dbc159bc48055bf3f572b37">oggz_stream_get_content_type</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> *oggz, <span class="keywordtype">long</span> serialno);</div> <div class="line"><a name="l00223"></a><span class="lineno"> 223</span> </div> <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="keywordtype">int</span> <a class="code" href="oggz__read_8h.html#ae3b1aa364b5bf0d7b331aab70646ab10">oggz_stream_get_numheaders</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno);</div> <div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div> <div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="preprocessor">#endif </span><span class="comment">/* __OGGZ_READ_H__ */</span><span class="preprocessor"></span></div> <div class="ttc" id="group__read__api_html_ga3ce7a31de5da56375057436c6b5108f2"><div class="ttname"><a href="group__read__api.html#ga3ce7a31de5da56375057436c6b5108f2">oggz_read</a></div><div class="ttdeci">long oggz_read(OGGZ *oggz, long n)</div><div class="ttdoc">Read n bytes into oggz, calling any read callbacks on the fly. </div></div> <div class="ttc" id="oggz__read_8h_html_ae3b1aa364b5bf0d7b331aab70646ab10"><div class="ttname"><a href="oggz__read_8h.html#ae3b1aa364b5bf0d7b331aab70646ab10">oggz_stream_get_numheaders</a></div><div class="ttdeci">int oggz_stream_get_numheaders(OGGZ *oggz, long serialno)</div><div class="ttdoc">Determine the number of headers of the oggz stream referred to by serialno. </div></div> <div class="ttc" id="oggz__read_8h_html_a85665d758dbc159bc48055bf3f572b37"><div class="ttname"><a href="oggz__read_8h.html#a85665d758dbc159bc48055bf3f572b37">oggz_stream_get_content_type</a></div><div class="ttdeci">const char * oggz_stream_get_content_type(OGGZ *oggz, long serialno)</div><div class="ttdoc">Return human-readable string representation of content type of oggz stream referred to by serialno...</div></div> <div class="ttc" id="oggz__read_8h_html_adf606e6641a7d59eff2030b7b9ce51f8"><div class="ttname"><a href="oggz__read_8h.html#adf606e6641a7d59eff2030b7b9ce51f8">oggz_purge</a></div><div class="ttdeci">int oggz_purge(OGGZ *oggz)</div><div class="ttdoc">Erase any input buffered in Oggz. </div></div> <div class="ttc" id="group__read__api_html_ga6d5aae4f7f186fffe19d4fd3cd63148d"><div class="ttname"><a href="group__read__api.html#ga6d5aae4f7f186fffe19d4fd3cd63148d">oggz_set_read_callback</a></div><div class="ttdeci">int oggz_set_read_callback(OGGZ *oggz, long serialno, OggzReadPacket read_packet, void *user_data)</div><div class="ttdoc">Set a callback for Oggz to call when a new Ogg packet is found in the stream. </div></div> <div class="ttc" id="group__read__api_html_ga8a1df0166fad1a0a6fe55d24e1a4b2e6"><div class="ttname"><a href="group__read__api.html#ga8a1df0166fad1a0a6fe55d24e1a4b2e6">OggzReadPage</a></div><div class="ttdeci">int(* OggzReadPage)(OGGZ *oggz, const ogg_page *og, long serialno, void *user_data)</div><div class="ttdoc">This is the signature of a callback which you must provide for Oggz to call whenever it finds a new p...</div><div class="ttdef"><b>Definition:</b> oggz_read.h:121</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__packet_8h_html"><div class="ttname"><a href="oggz__packet_8h.html">oggz_packet.h</a></div><div class="ttdoc">Packet positioning. </div></div> <div class="ttc" id="structoggz__packet_html"><div class="ttname"><a href="structoggz__packet.html">oggz_packet</a></div><div class="ttdoc">An ogg_packet and its position in the stream. </div><div class="ttdef"><b>Definition:</b> oggz_packet.h:84</div></div> <div class="ttc" id="group__read__api_html_gad9d6114ffc7c956fd179863e51e0d542"><div class="ttname"><a href="group__read__api.html#gad9d6114ffc7c956fd179863e51e0d542">OggzReadPacket</a></div><div class="ttdeci">int(* OggzReadPacket)(OGGZ *oggz, oggz_packet *packet, long serialno, void *user_data)</div><div class="ttdoc">This is the signature of a callback which you must provide for Oggz to call whenever it finds a new p...</div><div class="ttdef"><b>Definition:</b> oggz_read.h:81</div></div> <div class="ttc" id="group__read__api_html_ga77d4158dd119f496f73311ace7f630d6"><div class="ttname"><a href="group__read__api.html#ga77d4158dd119f496f73311ace7f630d6">oggz_read_input</a></div><div class="ttdeci">long oggz_read_input(OGGZ *oggz, unsigned char *buf, long n)</div><div class="ttdoc">Input data into oggz. </div></div> <div class="ttc" id="oggz__constants_8h_html_ab20058e3d54fc5540aa719a99e1e9598"><div class="ttname"><a href="oggz__constants_8h.html#ab20058e3d54fc5540aa719a99e1e9598">OggzStreamContent</a></div><div class="ttdeci">OggzStreamContent</div><div class="ttdoc">Definition of stream content types. </div><div class="ttdef"><b>Definition:</b> oggz_constants.h:106</div></div> <div class="ttc" id="group__read__api_html_gafe738d4fdd4b00b1280f5978be19b2d5"><div class="ttname"><a href="group__read__api.html#gafe738d4fdd4b00b1280f5978be19b2d5">oggz_set_read_page</a></div><div class="ttdeci">int oggz_set_read_page(OGGZ *oggz, long serialno, OggzReadPage read_page, void *user_data)</div><div class="ttdoc">Set a callback for Oggz to call when a new Ogg page is found in the stream. </div></div> <div class="ttc" id="oggz__read_8h_html_a1cd43b28f34bf82dc1830cc517b19e14"><div class="ttname"><a href="oggz__read_8h.html#a1cd43b28f34bf82dc1830cc517b19e14">oggz_stream_get_content</a></div><div class="ttdeci">OggzStreamContent oggz_stream_get_content(OGGZ *oggz, long serialno)</div><div class="ttdoc">Determine the content type of the oggz stream referred to by serialno. </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>