\doxysection{oggz\+\_\+comments.\+h}
\label{oggz__comments_8h_source}\index{oggz\_comments.h@{oggz\_comments.h}}
\textbf{ Go to the documentation of this file.}
\begin{DoxyCode}{0}
\DoxyCodeLine{00001\ \textcolor{comment}{/*}}
\DoxyCodeLine{00002\ \textcolor{comment}{\ \ \ Copyright\ (C)\ 2003\ Commonwealth\ Scientific\ and\ Industrial\ Research}}
\DoxyCodeLine{00003\ \textcolor{comment}{\ \ \ Organisation\ (CSIRO)\ Australia}}
\DoxyCodeLine{00004\ \textcolor{comment}{}}
\DoxyCodeLine{00005\ \textcolor{comment}{\ \ \ Redistribution\ and\ use\ in\ source\ and\ binary\ forms,\ with\ or\ without}}
\DoxyCodeLine{00006\ \textcolor{comment}{\ \ \ modification,\ are\ permitted\ provided\ that\ the\ following\ conditions}}
\DoxyCodeLine{00007\ \textcolor{comment}{\ \ \ are\ met:}}
\DoxyCodeLine{00008\ \textcolor{comment}{}}
\DoxyCodeLine{00009\ \textcolor{comment}{\ \ \ -\/\ Redistributions\ of\ source\ code\ must\ retain\ the\ above\ copyright}}
\DoxyCodeLine{00010\ \textcolor{comment}{\ \ \ notice,\ this\ list\ of\ conditions\ and\ the\ following\ disclaimer.}}
\DoxyCodeLine{00011\ \textcolor{comment}{}}
\DoxyCodeLine{00012\ \textcolor{comment}{\ \ \ -\/\ Redistributions\ in\ binary\ form\ must\ reproduce\ the\ above\ copyright}}
\DoxyCodeLine{00013\ \textcolor{comment}{\ \ \ notice,\ this\ list\ of\ conditions\ and\ the\ following\ disclaimer\ in\ the}}
\DoxyCodeLine{00014\ \textcolor{comment}{\ \ \ documentation\ and/or\ other\ materials\ provided\ with\ the\ distribution.}}
\DoxyCodeLine{00015\ \textcolor{comment}{}}
\DoxyCodeLine{00016\ \textcolor{comment}{\ \ \ -\/\ Neither\ the\ name\ of\ CSIRO\ Australia\ nor\ the\ names\ of\ its}}
\DoxyCodeLine{00017\ \textcolor{comment}{\ \ \ contributors\ may\ be\ used\ to\ endorse\ or\ promote\ products\ derived\ from}}
\DoxyCodeLine{00018\ \textcolor{comment}{\ \ \ this\ software\ without\ specific\ prior\ written\ permission.}}
\DoxyCodeLine{00019\ \textcolor{comment}{}}
\DoxyCodeLine{00020\ \textcolor{comment}{\ \ \ THIS\ SOFTWARE\ IS\ PROVIDED\ BY\ THE\ COPYRIGHT\ HOLDERS\ AND\ CONTRIBUTORS}}
\DoxyCodeLine{00021\ \textcolor{comment}{\ \ \ \`{}\`{}AS\ IS''\ AND\ ANY\ EXPRESS\ OR\ IMPLIED\ WARRANTIES,\ INCLUDING,\ BUT\ NOT}}
\DoxyCodeLine{00022\ \textcolor{comment}{\ \ \ LIMITED\ TO,\ THE\ IMPLIED\ WARRANTIES\ OF\ MERCHANTABILITY\ AND\ FITNESS\ FOR\ A}}
\DoxyCodeLine{00023\ \textcolor{comment}{\ \ \ PARTICULAR\ PURPOSE\ ARE\ DISCLAIMED.\ \ IN\ NO\ EVENT\ SHALL\ THE\ ORGANISATION\ OR}}
\DoxyCodeLine{00024\ \textcolor{comment}{\ \ \ CONTRIBUTORS\ BE\ LIABLE\ FOR\ ANY\ DIRECT,\ INDIRECT,\ INCIDENTAL,\ SPECIAL,}}
\DoxyCodeLine{00025\ \textcolor{comment}{\ \ \ EXEMPLARY,\ OR\ CONSEQUENTIAL\ DAMAGES\ (INCLUDING,\ BUT\ NOT\ LIMITED\ TO,}}
\DoxyCodeLine{00026\ \textcolor{comment}{\ \ \ PROCUREMENT\ OF\ SUBSTITUTE\ GOODS\ OR\ SERVICES;\ LOSS\ OF\ USE,\ DATA,\ OR}}
\DoxyCodeLine{00027\ \textcolor{comment}{\ \ \ PROFITS;\ OR\ BUSINESS\ INTERRUPTION)\ HOWEVER\ CAUSED\ AND\ ON\ ANY\ THEORY\ OF}}
\DoxyCodeLine{00028\ \textcolor{comment}{\ \ \ LIABILITY,\ WHETHER\ IN\ CONTRACT,\ STRICT\ LIABILITY,\ OR\ TORT\ (INCLUDING}}
\DoxyCodeLine{00029\ \textcolor{comment}{\ \ \ NEGLIGENCE\ OR\ OTHERWISE)\ ARISING\ IN\ ANY\ WAY\ OUT\ OF\ THE\ USE\ OF\ THIS}}
\DoxyCodeLine{00030\ \textcolor{comment}{\ \ \ SOFTWARE,\ EVEN\ IF\ ADVISED\ OF\ THE\ POSSIBILITY\ OF\ SUCH\ DAMAGE.}}
\DoxyCodeLine{00031\ \textcolor{comment}{*/}}
\DoxyCodeLine{00032\ }
\DoxyCodeLine{00033\ \textcolor{preprocessor}{\#ifndef\ \_\_OGGZ\_COMMENT\_H\_\_}}
\DoxyCodeLine{00034\ \textcolor{preprocessor}{\#define\ \_\_OGGZ\_COMMENT\_H\_\_}}
\DoxyCodeLine{00035\ }
\DoxyCodeLine{00085\ }
\DoxyCodeLine{00086\ \textcolor{preprocessor}{\#include\ <oggz/oggz.h>}}
\DoxyCodeLine{00087\ }
\DoxyCodeLine{00091\ \textcolor{keyword}{typedef}\ \textcolor{keyword}{struct\ }\{}
\DoxyCodeLine{00093\ \ \ \textcolor{keywordtype}{char}\ *\ name;}
\DoxyCodeLine{00094\ }
\DoxyCodeLine{00096\ \ \ \textcolor{keywordtype}{char}\ *\ value;}
\DoxyCodeLine{00097\ \}\ OggzComment;}
\DoxyCodeLine{00098\ }
\DoxyCodeLine{00099\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}}
\DoxyCodeLine{00100\ \textcolor{keyword}{extern}\ \textcolor{stringliteral}{"{}C"{}}\ \{}
\DoxyCodeLine{00101\ \textcolor{preprocessor}{\#endif}}
\DoxyCodeLine{00102\ }
\DoxyCodeLine{00112\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *}
\DoxyCodeLine{00113\ oggz\_comment\_get\_vendor\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno);}
\DoxyCodeLine{00114\ }
\DoxyCodeLine{00128\ \textcolor{keywordtype}{int}}
\DoxyCodeLine{00129\ oggz\_comment\_set\_vendor\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno,}
\DoxyCodeLine{00130\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *\ vendor\_string);}
\DoxyCodeLine{00131\ }
\DoxyCodeLine{00140\ \textcolor{keyword}{const}\ OggzComment\ *}
\DoxyCodeLine{00141\ oggz\_comment\_first\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno);}
\DoxyCodeLine{00142\ }
\DoxyCodeLine{00153\ \textcolor{keyword}{const}\ OggzComment\ *}
\DoxyCodeLine{00154\ oggz\_comment\_next\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno,\ \textcolor{keyword}{const}\ OggzComment\ *\ comment);}
\DoxyCodeLine{00155\ }
\DoxyCodeLine{00167\ \textcolor{keyword}{const}\ OggzComment\ *}
\DoxyCodeLine{00168\ oggz\_comment\_first\_byname\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno,\ \textcolor{keywordtype}{char}\ *\ name);}
\DoxyCodeLine{00169\ }
\DoxyCodeLine{00182\ \textcolor{keyword}{const}\ OggzComment\ *}
\DoxyCodeLine{00183\ oggz\_comment\_next\_byname\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno,}
\DoxyCodeLine{00184\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ OggzComment\ *\ comment);}
\DoxyCodeLine{00185\ }
\DoxyCodeLine{00196\ \textcolor{keywordtype}{int}}
\DoxyCodeLine{00197\ oggz\_comment\_add\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno,\ OggzComment\ *\ comment);}
\DoxyCodeLine{00198\ }
\DoxyCodeLine{00210\ \textcolor{keywordtype}{int}}
\DoxyCodeLine{00211\ oggz\_comment\_add\_byname\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno,}
\DoxyCodeLine{00212\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *\ name,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{char}\ *\ value);}
\DoxyCodeLine{00213\ }
\DoxyCodeLine{00226\ \textcolor{keywordtype}{int}}
\DoxyCodeLine{00227\ oggz\_comment\_remove\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno,\ OggzComment\ *\ comment);}
\DoxyCodeLine{00228\ }
\DoxyCodeLine{00240\ \textcolor{keywordtype}{int}}
\DoxyCodeLine{00241\ oggz\_comment\_remove\_byname\ (OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno,\ \textcolor{keywordtype}{char}\ *\ name);}
\DoxyCodeLine{00242\ }
\DoxyCodeLine{00265\ ogg\_packet\ *}
\DoxyCodeLine{00266\ oggz\_comments\_generate(OGGZ\ *\ oggz,\ \textcolor{keywordtype}{long}\ serialno,}
\DoxyCodeLine{00267\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \textcolor{keywordtype}{int}\ FLAC\_final\_metadata\_block);}
\DoxyCodeLine{00268\ \ \ }
\DoxyCodeLine{00269\ \textcolor{comment}{/*}}
\DoxyCodeLine{00270\ \textcolor{comment}{\ *\ Copy\ comments\ between\ two\ streams.}}
\DoxyCodeLine{00271\ \textcolor{comment}{\ *\ \(\backslash\)param\ src\ A\ OGGZ*\ handle}}
\DoxyCodeLine{00272\ \textcolor{comment}{\ *\ \(\backslash\)param\ src\_serialno\ Identify\ a\ logical\ bitstream\ within\ \(\backslash\)a\ src}}
\DoxyCodeLine{00273\ \textcolor{comment}{\ *\ \(\backslash\)param\ dest\ A\ OGGZ*\ handle\ (created\ with\ OGGZ\_WRITE)}}
\DoxyCodeLine{00274\ \textcolor{comment}{\ *\ \(\backslash\)param\ dest\_serialno\ Identify\ a\ logical\ bitstream\ within\ \(\backslash\)a\ dest}}
\DoxyCodeLine{00275\ \textcolor{comment}{\ *\ \(\backslash\)retval\ OGGZ\_ERR\_BAD\ \(\backslash\)a\ oggz\ is\ not\ a\ valid\ OGGZ*\ handle}}
\DoxyCodeLine{00276\ \textcolor{comment}{\ *\ \(\backslash\)retval\ OGGZ\_ERR\_INVALID\ Operation\ not\ suitable\ for\ \(\backslash\)a\ dest}}
\DoxyCodeLine{00277\ \textcolor{comment}{\ */}}
\DoxyCodeLine{00278\ \textcolor{keywordtype}{int}}
\DoxyCodeLine{00279\ oggz\_comments\_copy\ (OGGZ\ *\ src,\ \textcolor{keywordtype}{long}\ src\_serialno,}
\DoxyCodeLine{00280\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ OGGZ\ *\ dest,\ \textcolor{keywordtype}{long}\ dest\_serialno);}
\DoxyCodeLine{00281\ }
\DoxyCodeLine{00287\ \textcolor{keywordtype}{void}\ oggz\_packet\_destroy\ (ogg\_packet\ *packet);}
\DoxyCodeLine{00288\ }
\DoxyCodeLine{00289\ \textcolor{preprocessor}{\#ifdef\ \_\_cplusplus}}
\DoxyCodeLine{00290\ \}}
\DoxyCodeLine{00291\ \textcolor{preprocessor}{\#endif}}
\DoxyCodeLine{00292\ }
\DoxyCodeLine{00293\ \textcolor{preprocessor}{\#endif\ }\textcolor{comment}{/*\ \_\_OGGZ\_COMMENTS\_H\_\_\ */}\textcolor{preprocessor}{}}

\end{DoxyCode}
