TagLib API Documentation
mp4file.h
Go to the documentation of this file.
1/**************************************************************************
2 copyright : (C) 2007 by Lukáš Lalinský
3 email : lalinsky@gmail.com
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_MP4FILE_H
27#define TAGLIB_MP4FILE_H
28
29#include "tfile.h"
30#include "taglib_export.h"
31#include "mp4tag.h"
32#include "tag.h"
33#include "mp4properties.h"
34
35namespace TagLib {
37 namespace MP4 {
38 class Atoms;
39 class ItemFactory;
40
42
50 {
51 public:
56 enum TagTypes {
58 NoTags = 0x0000,
60 MP4 = 0x0001,
62 AllTags = 0xffff
63 };
64
73 File(FileName file, bool readProperties = true,
74 Properties::ReadStyle audioPropertiesStyle = Properties::Average,
75 ItemFactory *itemFactory = nullptr);
76
88 File(IOStream *stream, bool readProperties = true,
89 Properties::ReadStyle audioPropertiesStyle = Properties::Average,
90 ItemFactory *itemFactory = nullptr);
91
95 ~File() override;
96
97 File(const File &) = delete;
98 File &operator=(const File &) = delete;
99
110 Tag *tag() const override;
111
115 PropertyMap properties() const override;
116
121 void removeUnsupportedProperties(const StringList &properties) override;
122
127
131 Properties *audioProperties() const override;
132
138 bool save() override;
139
147 bool strip(int tags = AllTags);
148
153 bool hasMP4Tag() const;
154
162 static bool isSupported(IOStream *stream);
163
164 private:
165 void read(bool readProperties);
166
167 class FilePrivate;
169 std::unique_ptr<FilePrivate> d;
170 };
171 } // namespace MP4
172} // namespace TagLib
173#endif
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
An abstract class that provides operations on a sequence of bytes.
Definition: tiostream.h:65
An implementation of TagLib::File with MP4 specific methods.
Definition: mp4file.h:50
File(IOStream *stream, bool readProperties=true, Properties::ReadStyle audioPropertiesStyle=Properties::Average, ItemFactory *itemFactory=nullptr)
File(FileName file, bool readProperties=true, Properties::ReadStyle audioPropertiesStyle=Properties::Average, ItemFactory *itemFactory=nullptr)
PropertyMap setProperties(const PropertyMap &) override
PropertyMap properties() const override
~File() override
Properties * audioProperties() const override
bool save() override
File(const File &)=delete
static bool isSupported(IOStream *stream)
File & operator=(const File &)=delete
TagTypes
Definition: mp4file.h:56
void removeUnsupportedProperties(const StringList &properties) override
bool strip(int tags=AllTags)
Tag * tag() const override
bool hasMP4Tag() const
A factory for creating MP4 items during parsing.
Definition: mp4itemfactory.h:70
An implementation of MP4 audio properties.
Definition: mp4properties.h:39
An MP4 tag implementation.
Definition: mp4tag.h:44
A map for format-independent <key,values> tag representations.
Definition: tpropertymap.h:122
A list of strings.
Definition: tstringlist.h:44
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