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