id3v2tag.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_ID3V2TAG_H
#define TAGLIB_ID3V2TAG_H

#include "tbytevector.h"
#include "tstring.h"
#include "tlist.h"
#include "tmap.h"
#include "taglib.h"
#include "taglib_export.h"
#include "tag.h"
#include "id3v2.h"
#include "id3v2framefactory.h"

namespace TagLib {

  class File;

  namespace ID3v2 {

    class Header;
    class ExtendedHeader;

    using FrameList = List<Frame *>;
    using FrameListMap = Map<ByteVector, FrameList>;


    class TAGLIB_EXPORT Latin1StringHandler
    {
    public:
      Latin1StringHandler();
      virtual ~Latin1StringHandler();
      Latin1StringHandler(const Latin1StringHandler &) = delete;
      Latin1StringHandler &operator=(const Latin1StringHandler &) = delete;

      virtual String parse(const ByteVector &data) const;

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


    class TAGLIB_EXPORT Tag : public TagLib::Tag
    {
    public:
      Tag();

      Tag(File *file, offset_t tagOffset,
          const FrameFactory *factory = FrameFactory::instance());

      ~Tag() override;

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

      // Reimplementations.

      String title() const override;
      String artist() const override;
      String album() const override;
      String comment() const override;
      String genre() const override;
      unsigned int year() const override;
      unsigned int track() const override;

      void setTitle(const String &s) override;
      void setArtist(const String &s) override;
      void setAlbum(const String &s) override;
      void setComment(const String &s) override;
      void setGenre(const String &s) override;
      void setYear(unsigned int i) override;
      void setTrack(unsigned int i) override;

      bool isEmpty() const override;

      Header *header() const;

      ExtendedHeader *extendedHeader() const;

      const FrameListMap &frameListMap() const;

      const FrameList &frameList() const;

      const FrameList &frameList(const ByteVector &frameID) const;

      void addFrame(Frame *frame);

      void removeFrame(Frame *frame, bool del = true);

      void removeFrames(const ByteVector &id);

      PropertyMap properties() const override;

      void removeUnsupportedProperties(const StringList &properties) override;

      PropertyMap setProperties(const PropertyMap &) override;

      StringList complexPropertyKeys() const override;
      List<VariantMap> complexProperties(const String &key) const override;
      bool setComplexProperties(const String &key, const List<VariantMap> &value) override;

      ByteVector render() const;

      ByteVector render(Version version) const;

      static Latin1StringHandler const *latin1StringHandler();

      static void setLatin1StringHandler(const Latin1StringHandler *handler);

    protected:
      void read();

      void parse(const ByteVector &origData);

      void setTextFrame(const ByteVector &id, const String &value);

      void downgradeFrames(FrameList *frames, FrameList *newFrames) const;

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

  }  // namespace ID3v2
}  // namespace TagLib

#endif