TagLib API Documentation
id3v2framefactory.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_ID3V2FRAMEFACTORY_H
27#define TAGLIB_ID3V2FRAMEFACTORY_H
28
29#include "tbytevector.h"
30#include "taglib_export.h"
31#include "id3v2frame.h"
32#include "id3v2header.h"
33
34namespace TagLib {
35
36 namespace ID3v2 {
37
38 class TextIdentificationFrame;
39
41
68 {
69 public:
70 FrameFactory(const FrameFactory &) = delete;
72
74
79 virtual Frame *createFrame(const ByteVector &origData, const Header *tagHeader) const;
80
87 const String &key, const StringList &values) const;
88
94 virtual void rebuildAggregateFrames(ID3v2::Tag *tag) const;
95
106
117
129
130 protected:
136
141
153 virtual bool updateFrame(Frame::Header *header) const;
154
163 std::pair<Frame::Header *, bool> prepareFrameHeader(
164 ByteVector &data, const Header *tagHeader) const;
165
175 virtual Frame *createFrame(const ByteVector &data, Frame::Header *header,
176 const Header *tagHeader) const;
177
178 private:
179 static FrameFactory factory;
180
181 class FrameFactoryPrivate;
183 std::unique_ptr<FrameFactoryPrivate> d;
184 };
185
186 } // namespace ID3v2
187} // namespace TagLib
188
189#endif
A byte vector.
Definition: tbytevector.h:46
A factory for creating ID3v2 frames during parsing.
Definition: id3v2framefactory.h:68
std::pair< Frame::Header *, bool > prepareFrameHeader(ByteVector &data, const Header *tagHeader) const
bool isUsingDefaultTextEncoding() const
virtual Frame * createFrame(const ByteVector &data, Frame::Header *header, const Header *tagHeader) const
FrameFactory(const FrameFactory &)=delete
FrameFactory & operator=(const FrameFactory &)=delete
static FrameFactory * instance()
virtual Frame * createFrame(const ByteVector &origData, const Header *tagHeader) const
void setDefaultTextEncoding(String::Type encoding)
virtual void rebuildAggregateFrames(ID3v2::Tag *tag) const
virtual Frame * createFrameForProperty(const String &key, const StringList &values) const
virtual bool updateFrame(Frame::Header *header) const
String::Type defaultTextEncoding() const
ID3v2 frame implementation.
Definition: id3v2frame.h:57
An implementation of ID3v2 headers.
Definition: id3v2header.h:49
The main class in the ID3v2 implementation.
Definition: id3v2tag.h:134
A list of strings.
Definition: tstringlist.h:44
A wide string class suitable for unicode.
Definition: tstring.h:83
Type
Definition: tstring.h:96
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
#define TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
Definition: taglib_export.h:55