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 "tag.h"
#include "tbytevector.h"
#include "tstring.h"
#include "tlist.h"
#include "tmap.h"
#include "taglib_export.h"
 
#include "id3v2framefactory.h"
 
namespace TagLib {
 
  class File;
 
 
  namespace ID3v2 {
 
    class Header;
    class ExtendedHeader;
    class Footer;
 
    typedef List<Frame *> FrameList;
    typedef Map<ByteVector, FrameList> FrameListMap;
 
 
    class TAGLIB_EXPORT Latin1StringHandler
    {
    public:
      Latin1StringHandler();
      virtual ~Latin1StringHandler();
 
      virtual String parse(const ByteVector &data) const;
    };
 
 
    class TAGLIB_EXPORT Tag : public TagLib::Tag
    {
    public:
      Tag();
 
      Tag(File *file, long tagOffset,
          const FrameFactory *factory = FrameFactory::instance());
 
      virtual ~Tag();
 
      // Reimplementations.
 
      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;
 
      Header *header() const;
 
      ExtendedHeader *extendedHeader() const;
 
      Footer *footer() 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;
 
      void removeUnsupportedProperties(const StringList &properties);
 
      PropertyMap setProperties(const PropertyMap &);
 
      ByteVector render() const;
 
      // BIC: combine with the above method
      ByteVector render(int version) const;
 
      static Latin1StringHandler const *latin1StringHandler();
 
      static void setLatin1StringHandler(const Latin1StringHandler *handler);
 
    protected:
      void read();
 
      void parse(const ByteVector &data);
 
      void setTextFrame(const ByteVector &id, const String &value);
 
      void downgradeFrames(FrameList *existingFrames, FrameList *newFrames) const;
 
    private:
      Tag(const Tag &);
      Tag &operator=(const Tag &);
 
      class TagPrivate;
      TagPrivate *d;
    };
 
  }
}
 
#endif