\doxysection{Oggz makes programming with Ogg easy!}\label{index_intro}
This is the documentation for the Oggz C A\+PI. Oggz provides a simple programming interface for reading and writing Ogg files and streams. Ogg is an interleaving data container developed by Monty at {\texttt{ Xiph.\+Org}}, originally to support the Ogg Vorbis audio format.

liboggz supports the flexibility afforded by the Ogg file format while presenting the following A\+PI niceties\+:


\begin{DoxyItemize}
\item Strict adherence to the formatting requirements of Ogg \doxyref{bitstreams }{p.}{group__basics}, to ensure that only valid bitstreams are generated
\item A simple, callback based open/read/close or open/write/close \doxyref{interface }{p.}{oggz_8h} to raw Ogg files
\item A customisable \doxyref{seeking }{p.}{group__seek__api} abstraction for seeking on multitrack Ogg data
\item A packet queue for feeding incoming packets for writing, with callback based notification when this queue is empty
\item A means of overriding the \doxyref{IO functions }{p.}{oggz__io_8h} used by Oggz, for easier integration with media frameworks and similar systems.
\item A handy \doxyref{table }{p.}{oggz__table_8h} structure for storing information on each logical bitstream
\end{DoxyItemize}\doxysubsection{Contents}\label{index_contents}

\begin{DoxyItemize}
\item \doxyref{Basics }{p.}{group__basics}\+: Information about Ogg required to understand liboggz
\item \doxyref{oggz.\+h }{p.}{oggz_8h}\+: Documentation of the Oggz C A\+PI
\item \doxyref{Configuration }{p.}{group__configuration}\+: Customizing liboggz to only read or write.
\item \doxyref{Building }{p.}{group__building}\+: Information related to building software that uses liboggz.
\end{DoxyItemize}\doxysection{Licensing}\label{index_Licensing}
liboggz is provided under the following B\+S\+D-\/style open source license\+:


\begin{DoxyCodeInclude}{0}
\DoxyCodeLine{   Copyright (C) 2003 CSIRO Australia}
\DoxyCodeLine{}
\DoxyCodeLine{   Redistribution and use in source and binary forms, with or without}
\DoxyCodeLine{   modification, are permitted provided that the following conditions}
\DoxyCodeLine{   are met:}
\DoxyCodeLine{   }
\DoxyCodeLine{   -\/ Redistributions of source code must retain the above copyright}
\DoxyCodeLine{   notice, this list of conditions and the following disclaimer.}
\DoxyCodeLine{   }
\DoxyCodeLine{   -\/ Redistributions in binary form must reproduce the above copyright}
\DoxyCodeLine{   notice, this list of conditions and the following disclaimer in the}
\DoxyCodeLine{   documentation and/or other materials provided with the distribution.}
\DoxyCodeLine{   }
\DoxyCodeLine{   -\/ Neither the name of the CSIRO nor the names of its}
\DoxyCodeLine{   contributors may be used to endorse or promote products derived from}
\DoxyCodeLine{   this software without specific prior written permission.}
\DoxyCodeLine{   }
\DoxyCodeLine{   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS}
\DoxyCodeLine{   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT}
\DoxyCodeLine{   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A}
\DoxyCodeLine{   PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR}
\DoxyCodeLine{   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,}
\DoxyCodeLine{   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,}
\DoxyCodeLine{   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR}
\DoxyCodeLine{   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF}
\DoxyCodeLine{   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING}
\DoxyCodeLine{   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS}
\DoxyCodeLine{   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.}
\DoxyCodeLine{}
\end{DoxyCodeInclude}
 