xiphcomment.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_VORBISCOMMENT_H
#define TAGLIB_VORBISCOMMENT_H

#include "tlist.h"
#include "tmap.h"
#include "tstring.h"
#include "tstringlist.h"
#include "tbytevector.h"
#include "taglib_export.h"
#include "tag.h"
#include "flacpicture.h"

#ifdef _MSC_VER
// Explained at end of tpropertymap.cpp
extern template class TagLib::Map<TagLib::String, TagLib::StringList>;
#endif

namespace TagLib {

  namespace Ogg {

    using FieldListMap = Map<String, StringList>;


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

      XiphComment(const ByteVector &data);

      ~XiphComment() override;

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

      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;

      unsigned int fieldCount() const;

      const FieldListMap &fieldListMap() const;

      PropertyMap properties() const 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;

      static bool checkKey(const String&);

      String vendorID() const;

      void addField(const String &key, const String &value, bool replace = true);

      void removeFields(const String &key);

      void removeFields(const String &key, const String &value);

      void removeAllFields();

      bool contains(const String &key) const;

      ByteVector render(bool addFramingBit = true) const;


      List<FLAC::Picture *> pictureList();

      void removePicture(FLAC::Picture *picture, bool del = true);

      void removeAllPictures();

      void addPicture(FLAC::Picture *picture);

    protected:
      void parse(const ByteVector &data);

    private:
      class XiphCommentPrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<XiphCommentPrivate> d;
    };
  }  // namespace Ogg
}  // namespace TagLib

#endif