TagLib API Documentation
apefile.h
Go to the documentation of this file.
1/***************************************************************************
2 copyright : (C) 2010 by Alex Novichkov
3 email : novichko@atnet.ru
4
5 copyright : (C) 2006 by Lukáš Lalinský
6 email : lalinsky@gmail.com
7 (original WavPack implementation)
8
9 copyright : (C) 2004 by Allan Sandfeld Jensen
10 email : kde@carewolf.org
11 (original MPC implementation)
12 ***************************************************************************/
13
14/***************************************************************************
15 * This library is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU Lesser General Public License version *
17 * 2.1 as published by the Free Software Foundation. *
18 * *
19 * This library is distributed in the hope that it will be useful, but *
20 * WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
22 * Lesser General Public License for more details. *
23 * *
24 * You should have received a copy of the GNU Lesser General Public *
25 * License along with this library; if not, write to the Free Software *
26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
27 * 02110-1301 USA *
28 * *
29 * Alternatively, this file is available under the Mozilla Public *
30 * License Version 1.1. You may obtain a copy of the License at *
31 * http://www.mozilla.org/MPL/ *
32 ***************************************************************************/
33
34#ifndef TAGLIB_APEFILE_H
35#define TAGLIB_APEFILE_H
36
37#include "tfile.h"
38#include "taglib_export.h"
39#include "apeproperties.h"
40
41namespace TagLib {
42
43 class Tag;
44
45 namespace ID3v1 { class Tag; }
46 namespace APE { class Tag; }
47
49
57 namespace APE {
58
60
69 {
70 public:
75 enum TagTypes {
77 NoTags = 0x0000,
79 ID3v1 = 0x0001,
81 APE = 0x0002,
83 AllTags = 0xffff
84 };
85
92 File(FileName file, bool readProperties = true,
94
104 File(IOStream *stream, bool readProperties = true,
106
110 ~File() override;
111
112 File(const File &) = delete;
113 File &operator=(const File &) = delete;
114
119 TagLib::Tag *tag() const override;
120
126 PropertyMap properties() const override;
127
132 void removeUnsupportedProperties(const StringList &properties) override;
133
140
145 Properties *audioProperties() const override;
146
153 bool save() override;
154
172 ID3v1::Tag *ID3v1Tag(bool create = false);
173
191 APE::Tag *APETag(bool create = false);
192
201 void strip(int tags = AllTags);
202
208 bool hasAPETag() const;
209
215 bool hasID3v1Tag() const;
216
224 static bool isSupported(IOStream *stream);
225
226 private:
227 void read(bool readProperties);
228
229 class FilePrivate;
231 std::unique_ptr<FilePrivate> d;
232 };
233 } // namespace APE
234} // namespace TagLib
235
236#endif
An implementation of TagLib::File with APE specific methods.
Definition: apefile.h:69
static bool isSupported(IOStream *stream)
TagTypes
Definition: apefile.h:75
File(const File &)=delete
~File() override
File(IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
APE::Tag * APETag(bool create=false)
void removeUnsupportedProperties(const StringList &properties) override
bool save() override
PropertyMap setProperties(const PropertyMap &) override
PropertyMap properties() const override
void strip(int tags=AllTags)
Properties * audioProperties() const override
File(FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
bool hasAPETag() const
TagLib::Tag * tag() const override
File & operator=(const File &)=delete
ID3v1::Tag * ID3v1Tag(bool create=false)
bool hasID3v1Tag() const
An implementation of audio property reading for APE.
Definition: apeproperties.h:51
An APE tag implementation.
Definition: apetag.h:57
ReadStyle
Definition: audioproperties.h:56
@ Average
Read more of the file and make better values guesses.
Definition: audioproperties.h:60
A file class with some useful methods for tag manipulation.
Definition: tfile.h:51
The main class in the ID3v1 implementation.
Definition: id3v1tag.h:115
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
A list of strings.
Definition: tstringlist.h:44
A simple, generic interface to common audio metadata fields.
Definition: tag.h:49
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