vorbisproperties.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_VORBISPROPERTIES_H
27 #define TAGLIB_VORBISPROPERTIES_H
28 
29 #include "taglib_export.h"
30 #include "audioproperties.h"
31 
32 namespace TagLib {
33 
34 /*
35  * This is just to make this appear to be in the Ogg namespace in the
36  * documentation. The typedef below will make this work with the current code.
37  * In the next BIC version of TagLib this will be really moved into the Ogg
38  * namespace.
39  */
40 
41 #ifdef DOXYGEN
42  namespace Ogg {
43 #endif
44 
45  namespace Vorbis {
46 
47  class File;
48 
50 
57  {
58  public:
63  Properties(File *file, ReadStyle style = Average);
64 
68  virtual ~Properties();
69 
78  virtual int length() const;
79 
86  // BIC: make virtual
87  int lengthInSeconds() const;
88 
94  // BIC: make virtual
95  int lengthInMilliseconds() const;
96 
100  virtual int bitrate() const;
101 
105  virtual int sampleRate() const;
106 
110  virtual int channels() const;
111 
115  int vorbisVersion() const;
116 
121  int bitrateMaximum() const;
122 
127  int bitrateNominal() const;
128 
133  int bitrateMinimum() const;
134 
135  private:
136  Properties(const Properties &);
137  Properties &operator=(const Properties &);
138 
139  void read(File *file);
140 
141  class PropertiesPrivate;
142  PropertiesPrivate *d;
143  };
144  }
145 
146 /*
147  * To keep compatibility with the current version put Vorbis in the Ogg namespace
148  * only in the docs and provide a typedef to make it work. In the next BIC
149  * version this will be removed and it will only exist in the Ogg namespace.
150  */
151 
152 #ifdef DOXYGEN
153  }
154 #else
155  namespace Ogg { namespace Vorbis { typedef TagLib::AudioProperties AudioProperties; } }
156 #endif
157 
158 }
159 
160 #endif
An implementation of Ogg::File with Vorbis specific methods.
Definition: vorbisfile.h:62
An implementation of audio property reading for Ogg Vorbis.
Definition: vorbisproperties.h:56
ReadStyle
Definition: audioproperties.h:53
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
A simple, abstract interface to common audio properties.
Definition: audioproperties.h:42
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41