infotag.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2012 by Tsuda Kageyu
    email                : tsuda.kageyu@gmail.com
 ***************************************************************************/
 
/***************************************************************************
 *   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_INFOTAG_H
#define TAGLIB_INFOTAG_H
 
#include "tag.h"
#include "tmap.h"
#include "tstring.h"
#include "tstringlist.h"
#include "tbytevector.h"
#include "taglib_export.h"
 
namespace TagLib {
 
  class File;
 
  namespace RIFF {
  namespace Info {
 
    typedef Map<ByteVector, String> FieldListMap;
 
 
    class TAGLIB_EXPORT StringHandler
    {
    public:
      StringHandler();
      ~StringHandler();
 
      virtual String parse(const ByteVector &data) const;
 
      virtual ByteVector render(const String &s) const;
    };
 
 
    class TAGLIB_EXPORT Tag : public TagLib::Tag
    {
    public:
      Tag();
 
      Tag(const ByteVector &data);
 
      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;
 
      FieldListMap fieldListMap() const;
 
      /*
       * Gets the value of the field with the ID \a id.
       */
      String fieldText(const ByteVector &id) const;
 
      /*
        * Sets the value of the field with the ID \a id to \a s.
        * If the field does not exist, it is created.
        * If \s is empty, the field is removed.
        *
        * \note fieldId must be four-byte long pure ASCII string.  This function
        * performs nothing if fieldId is invalid.
        */
      void setFieldText(const ByteVector &id, const String &s);
 
      /*
       * Removes the field with the ID \a id.
       */
      void removeField(const ByteVector &id);
 
      ByteVector render() const;
 
      static void setStringHandler(const StringHandler *handler);
 
    protected:
      void parse(const ByteVector &data);
 
 
    private:
      Tag(const Tag &);
      Tag &operator=(const Tag &);
 
      class TagPrivate;
      TagPrivate *d;
    };
  }}
}
 
#endif