<!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_comments.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_comments.h</h1><a href="oggz__comments_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_COMMENT_H__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define __OGGZ_COMMENT_H__</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00086"></a>00086 <span class="preprocessor">#include <<a class="code" href="oggz_8h.html" title="The liboggz C API.">oggz/oggz.h</a>></span>
<a name="l00087"></a>00087
<a name="l00091"></a><a class="code" href="structOggzComment.html">00091</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00093"></a><a class="code" href="structOggzComment.html#af1b4e3c3e42e17054b6164bbdee5a37f">00093</a> <span class="keywordtype">char</span> * name;
<a name="l00094"></a>00094
<a name="l00096"></a><a class="code" href="structOggzComment.html#ae300da8b29b69ea083b47035e944f9bb">00096</a> <span class="keywordtype">char</span> * value;
<a name="l00097"></a>00097 } <a class="code" href="structOggzComment.html" title="A comment.">OggzComment</a>;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00101"></a>00101 <span class="preprocessor">#endif</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span>
<a name="l00112"></a>00112 <span class="keyword">const</span> <span class="keywordtype">char</span> *
<a name="l00113"></a>00113 <a class="code" href="oggz__comments_8h.html#ae5d522df5fce262953d8bb5cb8c00b00" title="Retrieve the vendor string.">oggz_comment_get_vendor</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno);
<a name="l00114"></a>00114
<a name="l00128"></a>00128 <span class="keywordtype">int</span>
<a name="l00129"></a>00129 <a class="code" href="oggz__comments_8h.html#a281a0956a9a160337f7d00f102d18131" title="Set the vendor string.">oggz_comment_set_vendor</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno,
<a name="l00130"></a>00130 <span class="keyword">const</span> <span class="keywordtype">char</span> * vendor_string);
<a name="l00131"></a>00131
<a name="l00140"></a>00140 <span class="keyword">const</span> <a class="code" href="structOggzComment.html" title="A comment.">OggzComment</a> *
<a name="l00141"></a>00141 <a class="code" href="oggz__comments_8h.html#a306a979d84b61932930d44ea5d4f95d9" title="Retrieve the first comment.">oggz_comment_first</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno);
<a name="l00142"></a>00142
<a name="l00153"></a>00153 <span class="keyword">const</span> <a class="code" href="structOggzComment.html" title="A comment.">OggzComment</a> *
<a name="l00154"></a>00154 <a class="code" href="oggz__comments_8h.html#a9501d8c166187c8d503e1335827b2d5e" title="Retrieve the next comment.">oggz_comment_next</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno, <span class="keyword">const</span> <a class="code" href="structOggzComment.html" title="A comment.">OggzComment</a> * comment);
<a name="l00155"></a>00155
<a name="l00167"></a>00167 <span class="keyword">const</span> <a class="code" href="structOggzComment.html" title="A comment.">OggzComment</a> *
<a name="l00168"></a>00168 <a class="code" href="oggz__comments_8h.html#a9a3a72be012b6474a1e1d95f7ce7afe8" title="Retrieve the first comment with a given name.">oggz_comment_first_byname</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno, <span class="keywordtype">char</span> * name);
<a name="l00169"></a>00169
<a name="l00182"></a>00182 <span class="keyword">const</span> <a class="code" href="structOggzComment.html" title="A comment.">OggzComment</a> *
<a name="l00183"></a>00183 <a class="code" href="oggz__comments_8h.html#a1dd05e02a121ba639b8012acaa21a37c" title="Retrieve the next comment following and with the same name as a given comment.">oggz_comment_next_byname</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno,
<a name="l00184"></a>00184 <span class="keyword">const</span> <a class="code" href="structOggzComment.html" title="A comment.">OggzComment</a> * comment);
<a name="l00185"></a>00185
<a name="l00196"></a>00196 <span class="keywordtype">int</span>
<a name="l00197"></a>00197 <a class="code" href="oggz__comments_8h.html#ade23081a738d67bec473bdaf317a68d8" title="Add a comment.">oggz_comment_add</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno, <a class="code" href="structOggzComment.html" title="A comment.">OggzComment</a> * comment);
<a name="l00198"></a>00198
<a name="l00210"></a>00210 <span class="keywordtype">int</span>
<a name="l00211"></a>00211 <a class="code" href="oggz__comments_8h.html#ad869a8a7246567ba4162183436127a6f" title="Add a comment by name and value.">oggz_comment_add_byname</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno,
<a name="l00212"></a>00212 <span class="keyword">const</span> <span class="keywordtype">char</span> * name, <span class="keyword">const</span> <span class="keywordtype">char</span> * value);
<a name="l00213"></a>00213
<a name="l00226"></a>00226 <span class="keywordtype">int</span>
<a name="l00227"></a>00227 <a class="code" href="oggz__comments_8h.html#a75ca47a020dcddce846a320481120a8e" title="Remove a comment.">oggz_comment_remove</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno, <a class="code" href="structOggzComment.html" title="A comment.">OggzComment</a> * comment);
<a name="l00228"></a>00228
<a name="l00240"></a>00240 <span class="keywordtype">int</span>
<a name="l00241"></a>00241 <a class="code" href="oggz__comments_8h.html#aa0f3f3a3ea3ca28d8678b94495634876" title="Remove all comments with a given name.">oggz_comment_remove_byname</a> (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno, <span class="keywordtype">char</span> * name);
<a name="l00242"></a>00242
<a name="l00265"></a>00265 ogg_packet *
<a name="l00266"></a>00266 <a class="code" href="oggz__comments_8h.html#a1ee69481fa517d80e63db962a23d53ae" title="Output a comment packet for the specified stream.">oggz_comments_generate</a>(<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * oggz, <span class="keywordtype">long</span> serialno,
<a name="l00267"></a>00267 <span class="keywordtype">int</span> FLAC_final_metadata_block);
<a name="l00268"></a>00268
<a name="l00269"></a>00269 <span class="comment">/*</span>
<a name="l00270"></a>00270 <span class="comment"> * Copy comments between two streams.</span>
<a name="l00271"></a>00271 <span class="comment"> * \param src A OGGZ* handle</span>
<a name="l00272"></a>00272 <span class="comment"> * \param src_serialno Identify a logical bitstream within \a src</span>
<a name="l00273"></a>00273 <span class="comment"> * \param dest A OGGZ* handle (created with OGGZ_WRITE)</span>
<a name="l00274"></a>00274 <span class="comment"> * \param dest_serialno Identify a logical bitstream within \a dest</span>
<a name="l00275"></a>00275 <span class="comment"> * \retval OGGZ_ERR_BAD \a oggz is not a valid OGGZ* handle</span>
<a name="l00276"></a>00276 <span class="comment"> * \retval OGGZ_ERR_INVALID Operation not suitable for \a dest</span>
<a name="l00277"></a>00277 <span class="comment"> */</span>
<a name="l00278"></a>00278 <span class="keywordtype">int</span>
<a name="l00279"></a>00279 oggz_comments_copy (<a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * src, <span class="keywordtype">long</span> src_serialno,
<a name="l00280"></a>00280 <a class="code" href="oggz_8h.html#a672d218df13da45a4b41d5366211bfee" title="An opaque handle to an Ogg file.">OGGZ</a> * dest, <span class="keywordtype">long</span> dest_serialno);
<a name="l00281"></a>00281
<a name="l00287"></a>00287 <span class="keywordtype">void</span> <a class="code" href="oggz__comments_8h.html#a9301332e99b0397cff54c3593595b809" title="Free a packet and its payload.">oggz_packet_destroy</a> (ogg_packet *packet);
<a name="l00288"></a>00288
<a name="l00289"></a>00289 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00290"></a>00290 <span class="preprocessor"></span>}
<a name="l00291"></a>00291 <span class="preprocessor">#endif</span>
<a name="l00292"></a>00292 <span class="preprocessor"></span>
<a name="l00293"></a>00293 <span class="preprocessor">#endif </span><span class="comment">/* __OGGZ_COMMENTS_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>