<!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.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 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 class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>oggz.h</h1><a href="oggz_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_H__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define __OGGZ_H__</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <stdio.h></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <sys/types.h></span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="preprocessor">#include <ogg/ogg.h></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <<a class="code" href="oggz__constants_8h.html" title="General constants used by liboggz.">oggz/oggz_constants.h</a>></span>
<a name="l00041"></a>00041 <span class="preprocessor">#include <<a class="code" href="oggz__table_8h.html" title="A lookup table.">oggz/oggz_table.h</a>></span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00045"></a>00045 <span class="preprocessor">#endif</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00441"></a><a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee">00441</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> <a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a>;
<a name="l00442"></a>00442
<a name="l00449"></a>00449 OGGZ * <a class="code" href="oggz_8h.html#a6eb34d123389ae38d993601f9e7bb9d6" title="Create a new OGGZ object.">oggz_new</a> (<span class="keywordtype">int</span> flags);
<a name="l00450"></a>00450
<a name="l00458"></a>00458 OGGZ * <a class="code" href="oggz_8h.html#a65197cdd03f755f7ebfabf2fdff4c7db" title="Open an Ogg file, creating an OGGZ handle for it.">oggz_open</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> * filename, <span class="keywordtype">int</span> flags);
<a name="l00459"></a>00459
<a name="l00467"></a>00467 OGGZ * <a class="code" href="oggz_8h.html#ac49e9de0bc4ef1d91b43b13605f98b19" title="Create an OGGZ handle associated with a stdio stream.">oggz_open_stdio</a> (FILE * file, <span class="keywordtype">int</span> flags);
<a name="l00468"></a>00468
<a name="l00477"></a>00477 <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#a8090c7e886af90dbea4dd5df8035dbf3" title="Ensure any associated io streams are flushed.">oggz_flush</a> (OGGZ * oggz);
<a name="l00478"></a>00478
<a name="l00500"></a>00500 <span class="keywordtype">long</span> <a class="code" href="oggz_8h.html#a0561df532fc37f98725007a79f898356" title="Run an OGGZ until completion, or error.">oggz_run</a> (OGGZ * oggz);
<a name="l00501"></a>00501
<a name="l00510"></a>00510 <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#ad500c8ed7147f7fb1ddc6c915a6c10d7" title="Set the blocksize to use internally for oggz_run().">oggz_run_set_blocksize</a> (OGGZ * oggz, <span class="keywordtype">long</span> blocksize);
<a name="l00511"></a>00511
<a name="l00519"></a>00519 <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#aadcfc04b2930660710bbcbc93140b783" title="Close an OGGZ handle.">oggz_close</a> (OGGZ * oggz);
<a name="l00520"></a>00520
<a name="l00531"></a>00531 <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#a357244f9e73d219015d9ce8260ee08d3" title="Determine if a given logical bitstream is at bos (beginning of stream).">oggz_get_bos</a> (OGGZ * oggz, <span class="keywordtype">long</span> serialno);
<a name="l00532"></a>00532
<a name="l00543"></a>00543 <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#aee6a754e123ec0fd347d1ed0d4d4b3b7" title="Determine if a given logical bitstream is at eos (end of stream).">oggz_get_eos</a> (OGGZ * oggz, <span class="keywordtype">long</span> serialno);
<a name="l00544"></a>00544
<a name="l00555"></a>00555 <span class="keywordtype">int</span> <a class="code" href="oggz_8h.html#a0dd3be49fc94531e35546318c14b64e7" title="Query the number of tracks (logical bitstreams).">oggz_get_numtracks</a> (OGGZ * oggz);
<a name="l00556"></a>00556
<a name="l00564"></a>00564 <span class="keywordtype">long</span> <a class="code" href="oggz_8h.html#aaf89877e3e89408387d422f487bcf094" title="Request a new serialno, as required for a new stream, ensuring the serialno is not...">oggz_serialno_new</a> (OGGZ * oggz);
<a name="l00565"></a>00565
<a name="l00572"></a>00572 <span class="keyword">const</span> <span class="keywordtype">char</span> *
<a name="l00573"></a>00573 <a class="code" href="oggz_8h.html#ab1b16dec307b6544b5f82a60a14c8518" title="Return human-readable string representation of a content type.">oggz_content_type</a> (<a class="code" href="oggz__constants_8h.html#ab20058e3d54fc5540aa719a99e1e9598" title="Definition of stream content types.">OggzStreamContent</a> content);
<a name="l00574"></a>00574
<a name="l00575"></a>00575 <span class="preprocessor">#include <<a class="code" href="oggz__off__t_8h.html" title="Architecture-dependent type and printf format for file position.">oggz/oggz_off_t.h</a>></span>
<a name="l00576"></a>00576 <span class="preprocessor">#include <<a class="code" href="oggz__read_8h.html" title="Interfaces for reading Ogg files and streams.">oggz/oggz_read.h</a>></span>
<a name="l00577"></a>00577 <span class="preprocessor">#include <<a class="code" href="oggz__stream_8h.html" title="Interfaces for querying Ogg streams.">oggz/oggz_stream.h</a>></span>
<a name="l00578"></a>00578 <span class="preprocessor">#include <<a class="code" href="oggz__seek_8h.html" title="Seeking within files.">oggz/oggz_seek.h</a>></span>
<a name="l00579"></a>00579 <span class="preprocessor">#include <<a class="code" href="oggz__write_8h.html" title="Interfaces for writing Ogg files and streams.">oggz/oggz_write.h</a>></span>
<a name="l00580"></a>00580 <span class="preprocessor">#include <<a class="code" href="oggz__io_8h.html" title="Overriding the functions used for input and output of raw data.">oggz/oggz_io.h</a>></span>
<a name="l00581"></a>00581 <span class="preprocessor">#include <<a class="code" href="oggz__comments_8h.html" title="Reading of comments.">oggz/oggz_comments.h</a>></span>
<a name="l00582"></a>00582 <span class="preprocessor">#include <<a class="code" href="oggz__deprecated_8h.html" title="Deprecated interfaces.">oggz/oggz_deprecated.h</a>></span>
<a name="l00583"></a>00583
<a name="l00584"></a>00584 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00585"></a>00585 <span class="preprocessor"></span>}
<a name="l00586"></a>00586 <span class="preprocessor">#endif</span>
<a name="l00587"></a>00587 <span class="preprocessor"></span>
<a name="l00588"></a>00588 <span class="preprocessor">#endif </span><span class="comment">/* __OGGZ_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
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>