Added TagLib (with AUTORS and COPYING files)
[someplayer] / src / taglib / ogg / speex / speexproperties.h
1 /***************************************************************************
2     copyright            : (C) 2006 by Lukáš Lalinský
3     email                : lalinsky@gmail.com
4
5     copyright            : (C) 2002 - 2008 by Scott Wheeler
6     email                : wheeler@kde.org
7                            (original Vorbis implementation)
8 ***************************************************************************/
9
10 /***************************************************************************
11  *   This library is free software; you can redistribute it and/or modify  *
12  *   it under the terms of the GNU Lesser General Public License version   *
13  *   2.1 as published by the Free Software Foundation.                     *
14  *                                                                         *
15  *   This library is distributed in the hope that it will be useful, but   *
16  *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
17  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
18  *   Lesser General Public License for more details.                       *
19  *                                                                         *
20  *   You should have received a copy of the GNU Lesser General Public      *
21  *   License along with this library; if not, write to the Free Software   *
22  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
23  *   USA                                                                   *
24  *                                                                         *
25  *   Alternatively, this file is available under the Mozilla Public        *
26  *   License Version 1.1.  You may obtain a copy of the License at         *
27  *   http://www.mozilla.org/MPL/                                           *
28  ***************************************************************************/
29
30 #ifndef TAGLIB_SPEEXPROPERTIES_H
31 #define TAGLIB_SPEEXPROPERTIES_H
32
33 #include "audioproperties.h"
34
35 namespace TagLib {
36
37   namespace Ogg {
38
39     namespace Speex {
40
41       class File;
42
43       //! An implementation of audio property reading for Ogg Speex
44
45       /*!
46        * This reads the data from an Ogg Speex stream found in the AudioProperties
47        * API.
48        */
49
50       class TAGLIB_EXPORT Properties : public AudioProperties
51       {
52       public:
53         /*!
54          * Create an instance of Speex::Properties with the data read from the
55          * Speex::File \a file.
56          */
57         Properties(File *file, ReadStyle style = Average);
58
59         /*!
60          * Destroys this Speex::Properties instance.
61          */
62         virtual ~Properties();
63
64         // Reimplementations.
65
66         virtual int length() const;
67         virtual int bitrate() const;
68         virtual int sampleRate() const;
69         virtual int channels() const;
70
71         /*!
72          * Returns the Speex version, currently "0" (as specified by the spec).
73          */
74         int speexVersion() const;
75
76       private:
77         Properties(const Properties &);
78         Properties &operator=(const Properties &);
79
80         void read();
81
82         class PropertiesPrivate;
83         PropertiesPrivate *d;
84       };
85     }
86   }
87 }
88
89 #endif