TagLib API Documentation
aifffile.h
Go to the documentation of this file.
1/***************************************************************************
2 copyright : (C) 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_AIFFFILE_H
27#define TAGLIB_AIFFFILE_H
28
29#include "rifffile.h"
30#include "id3v2tag.h"
31#include "aiffproperties.h"
32
33namespace TagLib {
34
35 namespace RIFF {
36
38
46 namespace AIFF {
47
49
58 {
59 public:
69 File(FileName file, bool readProperties = true,
71 ID3v2::FrameFactory *frameFactory = nullptr);
72
85 File(IOStream *stream, bool readProperties = true,
87 ID3v2::FrameFactory *frameFactory = nullptr);
88
92 ~File() override;
93
94 File(const File &) = delete;
95 File &operator=(const File &) = delete;
96
106 ID3v2::Tag *tag() const override;
107
112 PropertyMap properties() const override;
113
114 void removeUnsupportedProperties(const StringList &unsupported) override;
115
121
126 Properties *audioProperties() const override;
127
131 bool save() override;
132
136 bool save(ID3v2::Version version);
137
143 bool hasID3v2Tag() const;
144
151 static bool isSupported(IOStream *stream);
152
153 private:
154 void read(bool readProperties);
155
156 friend class Properties;
157
158 class FilePrivate;
160 std::unique_ptr<FilePrivate> d;
161 };
162 } // namespace AIFF
163 } // namespace RIFF
164} // namespace TagLib
165
166#endif
ReadStyle
Definition: audioproperties.h:56
@ Average
Read more of the file and make better values guesses.
Definition: audioproperties.h:60
A factory for creating ID3v2 frames during parsing.
Definition: id3v2framefactory.h:68
The main class in the ID3v2 implementation.
Definition: id3v2tag.h:134
An abstract class that provides operations on a sequence of bytes.
Definition: tiostream.h:65
A map for format-independent <key,values> tag representations.
Definition: tpropertymap.h:122
An implementation of TagLib::File with AIFF specific methods.
Definition: aifffile.h:58
bool save() override
PropertyMap properties() const override
File(IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average, ID3v2::FrameFactory *frameFactory=nullptr)
PropertyMap setProperties(const PropertyMap &) override
static bool isSupported(IOStream *stream)
Properties * audioProperties() const override
bool save(ID3v2::Version version)
ID3v2::Tag * tag() const override
File(const File &)=delete
File(FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average, ID3v2::FrameFactory *frameFactory=nullptr)
File & operator=(const File &)=delete
void removeUnsupportedProperties(const StringList &unsupported) override
An implementation of audio property reading for AIFF.
Definition: aiffproperties.h:48
A RIFF file class with some useful methods specific to RIFF.
Definition: rifffile.h:47
A list of strings.
Definition: tstringlist.h:44
Version
Definition: id3v2.h:27
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
const char * FileName
Definition: tiostream.h:59
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
#define TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
Definition: taglib_export.h:55