<!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: Main Page</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 class="current"><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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<h1>liboggz Documentation</h1> </div>
</div>
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="intro"></a>
Oggz makes programming with Ogg easy!</h2>
<p>This is the documentation for the Oggz C API. Oggz provides a simple programming interface for reading and writing Ogg files and streams. Ogg is an interleaving data container developed by Monty at <a href="http://www.xiph.org/">Xiph.Org</a>, originally to support the Ogg Vorbis audio format.</p>
<p>liboggz supports the flexibility afforded by the Ogg file format while presenting the following API niceties:</p>
<ul>
<li>Strict adherence to the formatting requirements of Ogg <a class="el" href="group__basics.html">bitstreams </a>, to ensure that only valid bitstreams are generated</li>
<li>A simple, callback based open/read/close or open/write/close <a class="el" href="oggz_8h.html">interface </a> to raw Ogg files</li>
<li>A customisable <a class="el" href="group__seek__api.html">seeking </a> abstraction for seeking on multitrack Ogg data</li>
<li>A packet queue for feeding incoming packets for writing, with callback based notification when this queue is empty</li>
<li>A means of overriding the <a class="el" href="oggz__io_8h.html">IO functions </a> used by Oggz, for easier integration with media frameworks and similar systems.</li>
<li>A handy <a class="el" href="oggz__table_8h.html">table </a> structure for storing information on each logical bitstream</li>
</ul>
<h3><a class="anchor" id="contents"></a>
Contents</h3>
<ul>
<li><a class="el" href="group__basics.html">Basics </a>: Information about Ogg required to understand liboggz</li>
</ul>
<ul>
<li><a class="el" href="oggz_8h.html">oggz.h </a>: Documentation of the Oggz C API</li>
</ul>
<ul>
<li><a class="el" href="group__configuration.html">Configuration </a>: Customizing liboggz to only read or write.</li>
</ul>
<ul>
<li><a class="el" href="group__building.html">Building </a>: Information related to building software that uses liboggz.</li>
</ul>
<h2><a class="anchor" id="Licensing"></a>
Licensing</h2>
<p>liboggz is provided under the following BSD-style open source license:</p>
<div class="fragment"><pre class="fragment"> Copyright (C) 2003 CSIRO Australia
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
- Redistributions of source code must retain the above copyright
notice, <span class="keyword">this</span> list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, <span class="keyword">this</span> list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
- Neither the name of the CSIRO nor the names of its
contributors may be used to endorse or promote products derived from
<span class="keyword">this</span> software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS<span class="stringliteral">''</span> AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</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>
