id3v2framefactory.h
Go to the documentation of this file.
/***************************************************************************
copyright : (C) 2002 - 2008 by Scott Wheeler
email : wheeler@kde.org
***************************************************************************/
/***************************************************************************
* This library is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License version *
* 2.1 as published by the Free Software Foundation. *
* *
* This library is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free Software *
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
* 02110-1301 USA *
* *
* Alternatively, this file is available under the Mozilla Public *
* License Version 1.1. You may obtain a copy of the License at *
* http://www.mozilla.org/MPL/ *
***************************************************************************/
#ifndef TAGLIB_ID3V2FRAMEFACTORY_H
#define TAGLIB_ID3V2FRAMEFACTORY_H
#include "tbytevector.h"
#include "taglib_export.h"
#include "id3v2frame.h"
#include "id3v2header.h"
namespace TagLib {
namespace ID3v2 {
class TextIdentificationFrame;
class TAGLIB_EXPORT FrameFactory
{
public:
FrameFactory(const FrameFactory &) = delete;
FrameFactory &operator=(const FrameFactory &) = delete;
static FrameFactory *instance();
virtual Frame *createFrame(const ByteVector &origData, const Header *tagHeader) const;
virtual Frame *createFrameForProperty(
const String &key, const StringList &values) const;
virtual void rebuildAggregateFrames(ID3v2::Tag *tag) const;
String::Type defaultTextEncoding() const;
void setDefaultTextEncoding(String::Type encoding);
bool isUsingDefaultTextEncoding() const;
protected:
FrameFactory();
~FrameFactory();
virtual bool updateFrame(Frame::Header *header) const;
std::pair<Frame::Header *, bool> prepareFrameHeader(
ByteVector &data, const Header *tagHeader) const;
virtual Frame *createFrame(const ByteVector &data, Frame::Header *header,
const Header *tagHeader) const;
private:
static FrameFactory factory;
class FrameFactoryPrivate;
TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
std::unique_ptr<FrameFactoryPrivate> d;
};
} // namespace ID3v2
} // namespace TagLib
#endif
TagLib::ByteVector
A byte vector.
Definition tbytevector.h:46
TagLib::ID3v2::FrameFactory::prepareFrameHeader
std::pair< Frame::Header *, bool > prepareFrameHeader(ByteVector &data, const Header *tagHeader) const
TagLib::ID3v2::FrameFactory::isUsingDefaultTextEncoding
bool isUsingDefaultTextEncoding() const
TagLib::ID3v2::FrameFactory::createFrame
virtual Frame * createFrame(const ByteVector &data, Frame::Header *header, const Header *tagHeader) const
TagLib::ID3v2::FrameFactory::FrameFactory
FrameFactory(const FrameFactory &)=delete
TagLib::ID3v2::FrameFactory::operator=
FrameFactory & operator=(const FrameFactory &)=delete
TagLib::ID3v2::FrameFactory::instance
static FrameFactory * instance()
TagLib::ID3v2::FrameFactory::createFrame
virtual Frame * createFrame(const ByteVector &origData, const Header *tagHeader) const
TagLib::ID3v2::FrameFactory::~FrameFactory
~FrameFactory()
TagLib::ID3v2::FrameFactory::setDefaultTextEncoding
void setDefaultTextEncoding(String::Type encoding)
TagLib::ID3v2::FrameFactory::rebuildAggregateFrames
virtual void rebuildAggregateFrames(ID3v2::Tag *tag) const
TagLib::ID3v2::FrameFactory::createFrameForProperty
virtual Frame * createFrameForProperty(const String &key, const StringList &values) const
TagLib::ID3v2::FrameFactory::updateFrame
virtual bool updateFrame(Frame::Header *header) const
TagLib::ID3v2::FrameFactory::defaultTextEncoding
String::Type defaultTextEncoding() const
TagLib::ID3v2::FrameFactory::FrameFactory
FrameFactory()
TagLib::ID3v2::Frame::Header
ID3v2 frame header implementation.
Definition id3v2frame.h:293
TagLib::ID3v2::Frame
ID3v2 frame implementation.
Definition id3v2frame.h:57
TagLib::ID3v2::Header
An implementation of ID3v2 headers.
Definition id3v2header.h:49
TagLib::ID3v2::Tag
The main class in the ID3v2 implementation.
Definition id3v2tag.h:134
TagLib::ID3v2::TextIdentificationFrame
An ID3v2 text identification frame implementation.
Definition textidentificationframe.h:107
TagLib::StringList
A list of strings.
Definition tstringlist.h:44
TagLib::String
A wide string class suitable for unicode.
Definition tstring.h:83
TagLib::String::Type
Type
Definition tstring.h:96
id3v2frame.h
id3v2header.h
TagLib::ID3v2
An ID3v2 implementation.
Definition flacfile.h:39
TagLib
A namespace for all TagLib related classes and functions.
Definition apefile.h:41
taglib_export.h
TAGLIB_EXPORT
#define TAGLIB_EXPORT
Definition taglib_export.h:40
TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
#define TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
Definition taglib_export.h:55
tbytevector.h