textidentificationframe.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_TEXTIDENTIFICATIONFRAME_H
#define TAGLIB_TEXTIDENTIFICATIONFRAME_H

#include "tstringlist.h"
#include "tmap.h"
#include "taglib_export.h"
#include "id3v2frame.h"

namespace TagLib {

  namespace ID3v2 {

    class Tag;
    using KeyConversionMap = Map<String, String>;


    class TAGLIB_EXPORT TextIdentificationFrame : public Frame
    {
      friend class FrameFactory;

    public:
      TextIdentificationFrame(const ByteVector &type, String::Type encoding);

      explicit TextIdentificationFrame(const ByteVector &data);

      static TextIdentificationFrame *createTIPLFrame(const PropertyMap &properties);

      static TextIdentificationFrame *createTMCLFrame(const PropertyMap &properties);
      ~TextIdentificationFrame() override;

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

      void setText(const StringList &l);

      // Reimplementations.

      void setText(const String &s) override;
      String toString() const override;
      StringList toStringList() const override;

      String::Type textEncoding() const;

      void setTextEncoding(String::Type encoding);

      StringList fieldList() const;

      static const KeyConversionMap &involvedPeopleMap();

      PropertyMap asProperties() const override;

    protected:
      // Reimplementations.

      void parseFields(const ByteVector &data) override;
      ByteVector renderFields() const override;

      TextIdentificationFrame(const ByteVector &data, Header *h);

    private:
      PropertyMap makeTIPLProperties() const;
      PropertyMap makeTMCLProperties() const;
      class TextIdentificationFramePrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<TextIdentificationFramePrivate> d;
    };


    class TAGLIB_EXPORT UserTextIdentificationFrame : public TextIdentificationFrame
    {
      friend class FrameFactory;

    public:
      explicit UserTextIdentificationFrame(String::Type encoding = String::Latin1);

      explicit UserTextIdentificationFrame(const ByteVector &data);

      UserTextIdentificationFrame(const String &description, const StringList &values, String::Type encoding = String::UTF8);

      ~UserTextIdentificationFrame() override;

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

      String toString() const override;

      String description() const;

      void setDescription(const String &s);

      void setText(const String &text) override;
      void setText(const StringList &fields);

      PropertyMap asProperties() const override;

      static UserTextIdentificationFrame *find(const Tag *tag, const String &description);

      static String keyToTXXX(const String &);

      static String txxxToKey(const String &);

    private:
      UserTextIdentificationFrame(const ByteVector &data, Header *h);

      void checkFields();

      class UserTextIdentificationFramePrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<UserTextIdentificationFramePrivate> d;
    };

  }  // namespace ID3v2
}  // namespace TagLib
#endif