| TagLib 1.13 |  |

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
122 virtual bool save();
123
130 static bool isSupported(IOStream *stream);
131
132 private:
133 File(const File &);
134 File &operator=(const File &);
135
136 void read(bool readProperties);
137
138 class FilePrivate;
139 FilePrivate *d;
140 };
141 }
142
143/*
144 * To keep compatibility with the current version put Vorbis in the Ogg namespace
145 * only in the docs and provide a typedef to make it work. In the next BIC
146 * version this will be removed and it will only exist in the Ogg namespace.
147 */
148
149#ifdef DOXYGEN
150 }
151#else
152 namespace Ogg { namespace Vorbis { typedef TagLib::Vorbis::File File; } }
153#endif
154
155}
156
157#endif
TagLib::AudioProperties::ReadStyle
ReadStyle
Definition: audioproperties.h:53
TagLib::AudioProperties::Average
@ Average
Read more of the file and make better values guesses.
Definition: audioproperties.h:57
TagLib::File
A file class with some useful methods for tag manipulation.
Definition: tfile.h:51
TagLib::IOStream
An abstract class that provides operations on a sequence of bytes.
Definition: tiostream.h:63
TagLib::Ogg::File
An implementation of TagLib::File with some helpers for Ogg based formats.
Definition: oggfile.h:51
TagLib::Ogg::Vorbis::File
An implementation of Ogg::File with Vorbis specific methods.
Definition: vorbisfile.h:63
TagLib::Ogg::Vorbis::File::isSupported
static bool isSupported(IOStream *stream)
TagLib::Ogg::Vorbis::File::File
File(IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
TagLib::Ogg::Vorbis::File::setProperties
PropertyMap setProperties(const PropertyMap &)
TagLib::Ogg::Vorbis::File::~File
virtual ~File()
TagLib::Ogg::Vorbis::File::audioProperties
virtual Properties * audioProperties() const
TagLib::Ogg::Vorbis::File::save
virtual bool save()
TagLib::Ogg::Vorbis::File::File
File(FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
TagLib::Ogg::Vorbis::File::properties
PropertyMap properties() const
TagLib::Ogg::Vorbis::File::tag
virtual Ogg::XiphComment * tag() const
TagLib::Ogg::Vorbis::Properties
An implementation of audio property reading for Ogg Vorbis.
Definition: vorbisproperties.h:57
TagLib::Ogg::XiphComment
Ogg Vorbis comment implementation.
Definition: xiphcomment.h:71
TagLib::PropertyMap
A map for format-independent <key,valuelist> tag representations.
Definition: tpropertymap.h:119
TagLib
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
TagLib::FileName
const char * FileName
Definition: tiostream.h:57
oggfile.h
taglib_export.h
TAGLIB_EXPORT
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
vorbisproperties.h
xiphcomment.h