<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>vorbisfile.h Source File (TagLib)</title>
<link href="taglib-api.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="container">
<table border="0" width="100%">
<tr>
<td width="1">
<img src="../taglib.png">
</td>
<td>
<div id="intro">
<table border="0" height="119" cellpadding="0" cellspacing="0" width="100%">
<tr><td valign="top"><h1>TagLib 1.8.0 (vorbisfile.h Source File)</h1></td></tr>
<tr>
<td valign="bottom">
<div id="links">
<a href="index.html">Home</a>
<a href="inherits.html">Class Hierarchy</a>
<a href="namespaces.html">Namespaces</a>
<a href="annotated.html">Classes</a>
<a href="files.html">Headers</a>
<a href="namespacemembers.html">Namespace Members</a>
<a href="functions.html">Class Members</a>
<a href="globals.html">File Members</a>
</div>
</td>
</tr>
</table>
</div>
</td>
</tr>
</table>
<div id="text">
<!-- Generated by Doxygen 1.8.3 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_b83727240c17e6d2210e34d27bf7473a.html">taglib</a></li><li class="navelem"><a class="el" href="dir_42e64e6e2e34acf97c97104eb697a37c.html">ogg</a></li><li class="navelem"><a class="el" href="dir_ebd8fec9f80f6502f3bfb9e2baa0388a.html">vorbis</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">vorbisfile.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="vorbisfile_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/***************************************************************************</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> copyright : (C) 2002 - 2008 by Scott Wheeler</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> email : wheeler@kde.org</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> ***************************************************************************/</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/***************************************************************************</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * This library is free software; you can redistribute it and/or modify *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License version *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * 2.1 as published by the Free Software Foundation. *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * This library is distributed in the hope that it will be useful, but *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * Lesser General Public License for more details. *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * License along with this library; if not, write to the Free Software *</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * 02110-1301 USA *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * *</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * Alternatively, this file is available under the Mozilla Public *</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * License Version 1.1. You may obtain a copy of the License at *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * http://www.mozilla.org/MPL/ *</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> ***************************************************************************/</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef TAGLIB_VORBISFILE_H</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span><span class="preprocessor">#define TAGLIB_VORBISFILE_H</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="taglib__export_8h.html">taglib_export.h</a>"</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="oggfile_8h.html">oggfile.h</a>"</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="xiphcomment_8h.html">xiphcomment.h</a>"</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="vorbisproperties_8h.html">vorbisproperties.h</a>"</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>TagLib {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * This is just to make this appear to be in the Ogg namespace in the</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * documentation. The typedef below will make this work with the current code.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * In the next BIC version of TagLib this will be really moved into the Ogg</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * namespace.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#ifdef DOXYGEN</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span> <span class="keyword">namespace </span>Ogg {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="namespaceTagLib_1_1Ogg_1_1Vorbis.html"> 50</a></span>  <span class="keyword">namespace </span>Vorbis {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1File.html"> 62</a></span>  <span class="keyword">class </span><a class="code" href="taglib__export_8h.html#a869a58b518ef871f14a9b4ccfe86ecfb">TAGLIB_EXPORT</a> <a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1File.html" title="An implementation of Ogg::File with Vorbis specific methods.">File</a> : <span class="keyword">public</span> <a class="code" href="classTagLib_1_1Ogg_1_1File.html" title="An implementation of TagLib::File with some helpers for Ogg based formats.">Ogg::File</a></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1File.html" title="An implementation of Ogg::File with Vorbis specific methods.">File</a>(<a class="code" href="namespaceTagLib.html#a14b47d9629bae2779b5c8a7517329fbb">FileName</a> file, <span class="keywordtype">bool</span> readProperties = <span class="keyword">true</span>,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="classTagLib_1_1AudioProperties.html#ae43831c9807aaf08d60d9b3b5efb67bb">Properties::ReadStyle</a> propertiesStyle = <a class="code" href="classTagLib_1_1AudioProperties.html#ae43831c9807aaf08d60d9b3b5efb67bbac7b0fcdd909bbb360f26d60c6bc57f4e" title="Read more of the file and make better values guesses.">Properties::Average</a>);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1File.html" title="An implementation of Ogg::File with Vorbis specific methods.">File</a>(<a class="code" href="classTagLib_1_1IOStream.html" title="An abstract class that provides operations on a sequence of bytes.">IOStream</a> *stream, <span class="keywordtype">bool</span> readProperties = <span class="keyword">true</span>,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="classTagLib_1_1AudioProperties.html#ae43831c9807aaf08d60d9b3b5efb67bb">Properties::ReadStyle</a> propertiesStyle = <a class="code" href="classTagLib_1_1AudioProperties.html#ae43831c9807aaf08d60d9b3b5efb67bbac7b0fcdd909bbb360f26d60c6bc57f4e" title="Read more of the file and make better values guesses.">Properties::Average</a>);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">virtual</span> ~<a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1File.html" title="An implementation of Ogg::File with Vorbis specific methods.">File</a>();</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">virtual</span> <a class="code" href="classTagLib_1_1Ogg_1_1XiphComment.html" title="Ogg Vorbis comment implementation.">Ogg::XiphComment</a> *tag() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classTagLib_1_1PropertyMap.html" title="A map for format-independent <key,valuelist> tag representations.">PropertyMap</a> properties() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="classTagLib_1_1PropertyMap.html" title="A map for format-independent <key,valuelist> tag representations.">PropertyMap</a> setProperties(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1PropertyMap.html" title="A map for format-independent <key,valuelist> tag representations.">PropertyMap</a> &);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">virtual</span> <a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1Properties.html" title="An implementation of audio property reading for Ogg Vorbis.">Properties</a> *audioProperties() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> save();</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1File.html" title="An implementation of Ogg::File with Vorbis specific methods.">File</a>(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1File.html" title="An implementation of Ogg::File with Vorbis specific methods.">File</a> &);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1File.html" title="An implementation of Ogg::File with Vorbis specific methods.">File</a> &operator=(<span class="keyword">const</span> <a class="code" href="classTagLib_1_1Ogg_1_1Vorbis_1_1File.html" title="An implementation of Ogg::File with Vorbis specific methods.">File</a> &);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">void</span> read(<span class="keywordtype">bool</span> readProperties, <a class="code" href="classTagLib_1_1AudioProperties.html#ae43831c9807aaf08d60d9b3b5efb67bb">Properties::ReadStyle</a> propertiesStyle);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">class </span>FilePrivate;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  FilePrivate *d;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  };</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  }</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * To keep compatibility with the current version put Vorbis in the Ogg namespace</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * only in the docs and provide a typedef to make it work. In the next BIC</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * version this will be removed and it will only exist in the Ogg namespace.</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#ifdef DOXYGEN</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor"></span> }</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="preprocessor"></span> <span class="keyword">namespace </span>Ogg { <span class="keyword">namespace </span>Vorbis { <span class="keyword">typedef</span> TagLib::Vorbis::File <a class="code" href="classTagLib_1_1File.html" title="A file class with some useful methods for tag manipulation.">File</a>; } }</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> }</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div>
</div>
</body>
</html>
