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 "tag.h"
#include "tlist.h"
#include "tmap.h"
#include "tstring.h"
#include "tstringlist.h"
#include "tbytevector.h"
#include "flacpicture.h"
#include "taglib_export.h"
 
namespace TagLib {
 
  namespace Ogg {
 
    typedef Map<String, StringList> FieldListMap;
 
 
    class TAGLIB_EXPORT XiphComment : public TagLib::Tag
    {
    public:
      XiphComment();
 
      XiphComment(const ByteVector &data);
 
      virtual ~XiphComment();
 
      virtual String title() const;
      virtual String artist() const;
      virtual String album() const;
      virtual String comment() const;
      virtual String genre() const;
      virtual unsigned int year() const;
      virtual unsigned int track() const;
 
      virtual void setTitle(const String &s);
      virtual void setArtist(const String &s);
      virtual void setAlbum(const String &s);
      virtual void setComment(const String &s);
      virtual void setGenre(const String &s);
      virtual void setYear(unsigned int i);
      virtual void setTrack(unsigned int i);
 
      virtual bool isEmpty() const;
 
      unsigned int fieldCount() const;
 
      const FieldListMap &fieldListMap() const;
 
      PropertyMap properties() const;
 
      PropertyMap setProperties(const PropertyMap&);
 
      static bool checkKey(const String&);
 
      String vendorID() const;
 
      void addField(const String &key, const String &value, bool replace = true);
 
      // BIC: remove and merge with below
      void removeField(const String &key, const String &value = String::null);
 
      void removeFields(const String &key);
 
      void removeFields(const String &key, const String &value);
 
      void removeAllFields();
 
      bool contains(const String &key) const;
 
      ByteVector render() const; // BIC: remove and merge with below
 
      ByteVector render(bool addFramingBit) 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:
      XiphComment(const XiphComment &);
      XiphComment &operator=(const XiphComment &);
 
      class XiphCommentPrivate;
      XiphCommentPrivate *d;
    };
  }
}
 
#endif