EVOLUTION-MANAGER
Edit File: oggz_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.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.h</div> </div> </div><!--header--> <div class="contents"> <a href="oggz_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_H__</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="preprocessor">#define __OGGZ_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="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <stdio.h></span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <sys/types.h></span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <ogg/ogg.h></span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include <<a class="code" href="oggz__constants_8h.html">oggz/oggz_constants.h</a>></span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include <<a class="code" href="oggz__table_8h.html">oggz/oggz_table.h</a>></span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00441"></a><span class="lineno"><a class="line" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee"> 441</a></span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">OGGZ</a>;</div> <div class="line"><a name="l00442"></a><span class="lineno"> 442</span> </div> <div class="line"><a name="l00449"></a><span class="lineno"> 449</span> OGGZ * <a class="code" href="oggz_8h.html#a6eb34d123389ae38d993601f9e7bb9d6">oggz_new</a> (<span class="keywordtype">int</span> flags);</div> <div class="line"><a name="l00450"></a><span class="lineno"> 450</span> </div> <div class="line"><a name="l00458"></a><span class="lineno"> 458</span> OGGZ * <a class="code" href="oggz_8h.html#a65197cdd03f755f7ebfabf2fdff4c7db">oggz_open</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * filename, <span class="keywordtype">int</span> flags);</div> <div class="line"><a name="l00459"></a><span class="lineno"> 459</span> </div> <div class="line"><a name="l00467"></a><span class="lineno"> 467</span> OGGZ * <a class="code" href="oggz_8h.html#ac49e9de0bc4ef1d91b43b13605f98b19">oggz_open_stdio</a> (FILE * file, <span class="keywordtype">int</span> flags);</div> <div class="line"><a name="l00468"></a><span class="lineno"> 468</span> </div> <div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#a8090c7e886af90dbea4dd5df8035dbf3">oggz_flush</a> (OGGZ * oggz);</div> <div class="line"><a name="l00478"></a><span class="lineno"> 478</span> </div> <div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="keywordtype">long</span> <a class="code" href="oggz_8h.html#a0561df532fc37f98725007a79f898356">oggz_run</a> (OGGZ * oggz);</div> <div class="line"><a name="l00501"></a><span class="lineno"> 501</span> </div> <div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#ad500c8ed7147f7fb1ddc6c915a6c10d7">oggz_run_set_blocksize</a> (OGGZ * oggz, <span class="keywordtype">long</span> blocksize);</div> <div class="line"><a name="l00511"></a><span class="lineno"> 511</span> </div> <div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#aadcfc04b2930660710bbcbc93140b783">oggz_close</a> (OGGZ * oggz);</div> <div class="line"><a name="l00520"></a><span class="lineno"> 520</span> </div> <div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#a357244f9e73d219015d9ce8260ee08d3">oggz_get_bos</a> (OGGZ * oggz, <span class="keywordtype">long</span> serialno);</div> <div class="line"><a name="l00532"></a><span class="lineno"> 532</span> </div> <div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#aee6a754e123ec0fd347d1ed0d4d4b3b7">oggz_get_eos</a> (OGGZ * oggz, <span class="keywordtype">long</span> serialno);</div> <div class="line"><a name="l00544"></a><span class="lineno"> 544</span> </div> <div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#a0dd3be49fc94531e35546318c14b64e7">oggz_get_numtracks</a> (OGGZ * oggz);</div> <div class="line"><a name="l00556"></a><span class="lineno"> 556</span> </div> <div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="keywordtype">long</span> <a class="code" href="oggz_8h.html#aaf89877e3e89408387d422f487bcf094">oggz_serialno_new</a> (OGGZ * oggz);</div> <div class="line"><a name="l00565"></a><span class="lineno"> 565</span> </div> <div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *</div> <div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <a class="code" href="oggz_8h.html#ab1b16dec307b6544b5f82a60a14c8518">oggz_content_type</a> (<a class="code" href="oggz__constants_8h.html#ab20058e3d54fc5540aa719a99e1e9598">OggzStreamContent</a> content);</div> <div class="line"><a name="l00574"></a><span class="lineno"> 574</span> </div> <div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="preprocessor">#include <<a class="code" href="oggz__off__t_8h.html">oggz/oggz_off_t.h</a>></span></div> <div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="preprocessor">#include <<a class="code" href="oggz__read_8h.html">oggz/oggz_read.h</a>></span></div> <div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="preprocessor">#include <<a class="code" href="oggz__stream_8h.html">oggz/oggz_stream.h</a>></span></div> <div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="preprocessor">#include <<a class="code" href="oggz__seek_8h.html">oggz/oggz_seek.h</a>></span></div> <div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="preprocessor">#include <<a class="code" href="oggz__write_8h.html">oggz/oggz_write.h</a>></span></div> <div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="preprocessor">#include <<a class="code" href="oggz__io_8h.html">oggz/oggz_io.h</a>></span></div> <div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="preprocessor">#include <<a class="code" href="oggz__comments_8h.html">oggz/oggz_comments.h</a>></span></div> <div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="preprocessor">#include <<a class="code" href="oggz__deprecated_8h.html">oggz/oggz_deprecated.h</a>></span></div> <div class="line"><a name="l00583"></a><span class="lineno"> 583</span> </div> <div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="preprocessor">#endif </span><span class="comment">/* __OGGZ_H__ */</span><span class="preprocessor"></span></div> <div class="ttc" id="oggz_8h_html_aee6a754e123ec0fd347d1ed0d4d4b3b7"><div class="ttname"><a href="oggz_8h.html#aee6a754e123ec0fd347d1ed0d4d4b3b7">oggz_get_eos</a></div><div class="ttdeci">int oggz_get_eos(OGGZ *oggz, long serialno)</div><div class="ttdoc">Determine if a given logical bitstream is at eos (end of stream). </div></div> <div class="ttc" id="oggz__stream_8h_html"><div class="ttname"><a href="oggz__stream_8h.html">oggz_stream.h</a></div><div class="ttdoc">Interfaces for querying Ogg streams. </div></div> <div class="ttc" id="oggz_8h_html_a357244f9e73d219015d9ce8260ee08d3"><div class="ttname"><a href="oggz_8h.html#a357244f9e73d219015d9ce8260ee08d3">oggz_get_bos</a></div><div class="ttdeci">int oggz_get_bos(OGGZ *oggz, long serialno)</div><div class="ttdoc">Determine if a given logical bitstream is at bos (beginning of stream). </div></div> <div class="ttc" id="oggz_8h_html_ad500c8ed7147f7fb1ddc6c915a6c10d7"><div class="ttname"><a href="oggz_8h.html#ad500c8ed7147f7fb1ddc6c915a6c10d7">oggz_run_set_blocksize</a></div><div class="ttdeci">int oggz_run_set_blocksize(OGGZ *oggz, long blocksize)</div><div class="ttdoc">Set the blocksize to use internally for oggz_run() </div></div> <div class="ttc" id="oggz__table_8h_html"><div class="ttname"><a href="oggz__table_8h.html">oggz_table.h</a></div><div class="ttdoc">A lookup table. </div></div> <div class="ttc" id="oggz__deprecated_8h_html"><div class="ttname"><a href="oggz__deprecated_8h.html">oggz_deprecated.h</a></div><div class="ttdoc">Deprecated interfaces. </div></div> <div class="ttc" id="oggz_8h_html_a6eb34d123389ae38d993601f9e7bb9d6"><div class="ttname"><a href="oggz_8h.html#a6eb34d123389ae38d993601f9e7bb9d6">oggz_new</a></div><div class="ttdeci">OGGZ * oggz_new(int flags)</div><div class="ttdoc">Create a new OGGZ object. </div></div> <div class="ttc" id="oggz__off__t_8h_html"><div class="ttname"><a href="oggz__off__t_8h.html">oggz_off_t.h</a></div><div class="ttdoc">Architecture-dependent type and printf format for file position. </div></div> <div class="ttc" id="oggz__io_8h_html"><div class="ttname"><a href="oggz__io_8h.html">oggz_io.h</a></div><div class="ttdoc">Overriding the functions used for input and output of raw data. </div></div> <div class="ttc" id="oggz_8h_html_a8090c7e886af90dbea4dd5df8035dbf3"><div class="ttname"><a href="oggz_8h.html#a8090c7e886af90dbea4dd5df8035dbf3">oggz_flush</a></div><div class="ttdeci">int oggz_flush(OGGZ *oggz)</div><div class="ttdoc">Ensure any associated io streams are flushed. </div></div> <div class="ttc" id="oggz_8h_html_a0561df532fc37f98725007a79f898356"><div class="ttname"><a href="oggz_8h.html#a0561df532fc37f98725007a79f898356">oggz_run</a></div><div class="ttdeci">long oggz_run(OGGZ *oggz)</div><div class="ttdoc">Run an OGGZ until completion, or error. </div></div> <div class="ttc" id="oggz_8h_html_ac49e9de0bc4ef1d91b43b13605f98b19"><div class="ttname"><a href="oggz_8h.html#ac49e9de0bc4ef1d91b43b13605f98b19">oggz_open_stdio</a></div><div class="ttdeci">OGGZ * oggz_open_stdio(FILE *file, int flags)</div><div class="ttdoc">Create an OGGZ handle associated with a stdio stream. </div></div> <div class="ttc" id="oggz__comments_8h_html"><div class="ttname"><a href="oggz__comments_8h.html">oggz_comments.h</a></div><div class="ttdoc">Reading of comments. </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__read_8h_html"><div class="ttname"><a href="oggz__read_8h.html">oggz_read.h</a></div><div class="ttdoc">Interfaces for reading Ogg files and streams. </div></div> <div class="ttc" id="oggz__write_8h_html"><div class="ttname"><a href="oggz__write_8h.html">oggz_write.h</a></div><div class="ttdoc">Interfaces for writing Ogg files and streams. </div></div> <div class="ttc" id="oggz__constants_8h_html"><div class="ttname"><a href="oggz__constants_8h.html">oggz_constants.h</a></div><div class="ttdoc">General constants used by liboggz. </div></div> <div class="ttc" id="oggz_8h_html_aaf89877e3e89408387d422f487bcf094"><div class="ttname"><a href="oggz_8h.html#aaf89877e3e89408387d422f487bcf094">oggz_serialno_new</a></div><div class="ttdeci">long oggz_serialno_new(OGGZ *oggz)</div><div class="ttdoc">Request a new serialno, as required for a new stream, ensuring the serialno is not yet used for any o...</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="oggz_8h_html_ab1b16dec307b6544b5f82a60a14c8518"><div class="ttname"><a href="oggz_8h.html#ab1b16dec307b6544b5f82a60a14c8518">oggz_content_type</a></div><div class="ttdeci">const char * oggz_content_type(OggzStreamContent content)</div><div class="ttdoc">Return human-readable string representation of a content type. </div></div> <div class="ttc" id="oggz__seek_8h_html"><div class="ttname"><a href="oggz__seek_8h.html">oggz_seek.h</a></div><div class="ttdoc">Seeking within files. </div></div> <div class="ttc" id="oggz_8h_html_aadcfc04b2930660710bbcbc93140b783"><div class="ttname"><a href="oggz_8h.html#aadcfc04b2930660710bbcbc93140b783">oggz_close</a></div><div class="ttdeci">int oggz_close(OGGZ *oggz)</div><div class="ttdoc">Close an OGGZ handle. </div></div> <div class="ttc" id="oggz_8h_html_a65197cdd03f755f7ebfabf2fdff4c7db"><div class="ttname"><a href="oggz_8h.html#a65197cdd03f755f7ebfabf2fdff4c7db">oggz_open</a></div><div class="ttdeci">OGGZ * oggz_open(const char *filename, int flags)</div><div class="ttdoc">Open an Ogg file, creating an OGGZ handle for it. </div></div> <div class="ttc" id="oggz_8h_html_a0dd3be49fc94531e35546318c14b64e7"><div class="ttname"><a href="oggz_8h.html#a0dd3be49fc94531e35546318c14b64e7">oggz_get_numtracks</a></div><div class="ttdeci">int oggz_get_numtracks(OGGZ *oggz)</div><div class="ttdoc">Query the number of tracks (logical bitstreams). </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>