id3v2frame.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_ID3V2FRAME_H
#define TAGLIB_ID3V2FRAME_H

#include "tstring.h"
#include "tbytevector.h"
#include "taglib_export.h"

namespace TagLib {

  class StringList;
  class PropertyMap;

  namespace ID3v2 {

    class Tag;
    class FrameFactory;


    class TAGLIB_EXPORT Frame
    {
      friend class Tag;

    public:
      class Header;

      virtual ~Frame();

      Frame(const Frame &) = delete;
      Frame &operator=(const Frame &) = delete;

      ByteVector frameID() const;

      unsigned int size() const;

      unsigned int headerSize() const;

      void setData(const ByteVector &data);

      virtual void setText(const String &text);

      virtual String toString() const = 0;

      virtual StringList toStringList() const;

      ByteVector render() const;

      Header *header() const;

      static ByteVector textDelimiter(String::Type t);

      static ByteVector keyToFrameID(const String &);

      static String frameIDToKey(const ByteVector &);

      static const String instrumentPrefix;
      static const String commentPrefix;
      static const String lyricsPrefix;
      static const String urlPrefix;

    protected:
      explicit Frame(const ByteVector &data);

      Frame(Header *h);

      void setHeader(Header *h, bool deleteCurrent = true);

      void parse(const ByteVector &data);

      virtual void parseFields(const ByteVector &data) = 0;

      virtual ByteVector renderFields() const = 0;

      ByteVector fieldData(const ByteVector &frameData) const;

      String readStringField(const ByteVector &data, String::Type encoding,
                             int *position = nullptr);

      String::Type checkTextEncoding(const StringList &fields,
                                     String::Type encoding) const;


      virtual PropertyMap asProperties() const;

      static void splitProperties(const PropertyMap &original, PropertyMap &singleFrameProperties,
          PropertyMap &tiplProperties, PropertyMap &tmclProperties);

    private:
      class FramePrivate;
      friend class FramePrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<FramePrivate> d;
    };


    class TAGLIB_EXPORT Frame::Header
    {
    public:
      explicit Header(const ByteVector &data, unsigned int version = 4);

      virtual ~Header();

      Header(const Header &) = delete;
      Header &operator=(const Header &) = delete;

      void setData(const ByteVector &data, unsigned int version = 4);

      ByteVector frameID() const;

      void setFrameID(const ByteVector &id);

      unsigned int frameSize() const;

      void setFrameSize(unsigned int size);

      unsigned int version() const;

      void setVersion(unsigned int version);

      unsigned int size() const;

      bool tagAlterPreservation() const;

      void setTagAlterPreservation(bool preserve);

      bool fileAlterPreservation() const;

      bool readOnly() const;

      bool groupingIdentity() const;

      bool compression() const;

      bool encryption() const;

      bool unsynchronisation() const;

      bool dataLengthIndicator() const;

      ByteVector render() const;

    private:
      class HeaderPrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<HeaderPrivate> d;
    };

  }  // namespace ID3v2
}  // namespace TagLib

#endif