vorbisfile.h
Go to the documentation of this file.
1 /***************************************************************************
2  copyright : (C) 2002 - 2008 by Scott Wheeler
3  email : wheeler@kde.org
4  ***************************************************************************/
5 
6 /***************************************************************************
7  * This library is free software; you can redistribute it and/or modify *
8  * it under the terms of the GNU Lesser General Public License version *
9  * 2.1 as published by the Free Software Foundation. *
10  * *
11  * This library is distributed in the hope that it will be useful, but *
12  * WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the Free Software *
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
19  * 02110-1301 USA *
20  * *
21  * Alternatively, this file is available under the Mozilla Public *
22  * License Version 1.1. You may obtain a copy of the License at *
23  * http://www.mozilla.org/MPL/ *
24  ***************************************************************************/
25 
26 #ifndef TAGLIB_VORBISFILE_H
27 #define TAGLIB_VORBISFILE_H
28 
29 #include "taglib_export.h"
30 #include "oggfile.h"
31 #include "xiphcomment.h"
32 
33 #include "vorbisproperties.h"
34 
35 namespace TagLib {
36 
37 /*
38  * This is just to make this appear to be in the Ogg namespace in the
39  * documentation. The typedef below will make this work with the current code.
40  * In the next BIC version of TagLib this will be really moved into the Ogg
41  * namespace.
42  */
43 
44 #ifdef DOXYGEN
45  namespace Ogg {
46 #endif
47 
49 
50  namespace Vorbis {
51 
52 
54 
62  class TAGLIB_EXPORT File : public Ogg::File
63  {
64  public:
71  File(FileName file, bool readProperties = true,
72  Properties::ReadStyle propertiesStyle = Properties::Average);
73 
83  File(IOStream *stream, bool readProperties = true,
84  Properties::ReadStyle propertiesStyle = Properties::Average);
85 
89  virtual ~File();
90 
96  virtual Ogg::XiphComment *tag() const;
97 
98 
103  PropertyMap properties() const;
104 
109  PropertyMap setProperties(const PropertyMap &);
110 
115  virtual Properties *audioProperties() const;
116 
117  virtual bool save();
118 
119  private:
120  File(const File &);
121  File &operator=(const File &);
122 
123  void read(bool readProperties, Properties::ReadStyle propertiesStyle);
124 
125  class FilePrivate;
126  FilePrivate *d;
127  };
128  }
129 
130 /*
131  * To keep compatibility with the current version put Vorbis in the Ogg namespace
132  * only in the docs and provide a typedef to make it work. In the next BIC
133  * version this will be removed and it will only exist in the Ogg namespace.
134  */
135 
136 #ifdef DOXYGEN
137  }
138 #else
139  namespace Ogg { namespace Vorbis { typedef TagLib::Vorbis::File File; } }
140 #endif
141 
142 }
143 
144 #endif