id3v1tag.h

Go to the documentation of this file.
00001 /***************************************************************************
00002     copyright            : (C) 2002 - 2008 by Scott Wheeler
00003     email                : wheeler@kde.org
00004  ***************************************************************************/
00005 
00006 /***************************************************************************
00007  *   This library is free software; you can redistribute it and/or modify  *
00008  *   it under the terms of the GNU Lesser General Public License version   *
00009  *   2.1 as published by the Free Software Foundation.                     *
00010  *                                                                         *
00011  *   This library is distributed in the hope that it will be useful, but   *
00012  *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
00013  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00014  *   Lesser General Public License for more details.                       *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU Lesser General Public      *
00017  *   License along with this library; if not, write to the Free Software   *
00018  *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
00019  *   02110-1301  USA                                                       *
00020  *                                                                         *
00021  *   Alternatively, this file is available under the Mozilla Public        *
00022  *   License Version 1.1.  You may obtain a copy of the License at         *
00023  *   http://www.mozilla.org/MPL/                                           *
00024  ***************************************************************************/
00025 
00026 #ifndef TAGLIB_ID3V1TAG_H
00027 #define TAGLIB_ID3V1TAG_H
00028 
00029 #include "tag.h"
00030 #include "tbytevector.h"
00031 #include "taglib_export.h"
00032 
00033 namespace TagLib {
00034 
00035   class File;
00036 
00038 
00039   namespace ID3v1 {
00040 
00042 
00060     class TAGLIB_EXPORT StringHandler
00061     {
00062       TAGLIB_IGNORE_MISSING_DESTRUCTOR
00063     public:
00064       // BIC: Add virtual destructor.
00065       StringHandler();
00066 
00071       virtual String parse(const ByteVector &data) const;
00072 
00082       virtual ByteVector render(const String &s) const;
00083     };
00084 
00086 
00105     class TAGLIB_EXPORT Tag : public TagLib::Tag
00106     {
00107     public:
00111       Tag();
00112 
00117       Tag(File *file, long tagOffset);
00118 
00122       virtual ~Tag();
00123 
00128       ByteVector render() const;
00129 
00134       static ByteVector fileIdentifier();
00135 
00136       // Reimplementations.
00137 
00138       virtual String title() const;
00139       virtual String artist() const;
00140       virtual String album() const;
00141       virtual String comment() const;
00142       virtual String genre() const;
00143       virtual TagLib::uint year() const;
00144       virtual TagLib::uint track() const;
00145 
00146       virtual void setTitle(const String &s);
00147       virtual void setArtist(const String &s);
00148       virtual void setAlbum(const String &s);
00149       virtual void setComment(const String &s);
00150       virtual void setGenre(const String &s);
00151       virtual void setYear(TagLib::uint i);
00152       virtual void setTrack(TagLib::uint i);
00153 
00159       TagLib::uint genreNumber() const;
00160 
00167       void setGenreNumber(TagLib::uint i);
00168 
00180       static void setStringHandler(const StringHandler *handler);
00181 
00182     protected:
00186       void read();
00190       void parse(const ByteVector &data);
00191 
00192     private:
00193       Tag(const Tag &);
00194       Tag &operator=(const Tag &);
00195 
00196       class TagPrivate;
00197       TagPrivate *d;
00198     };
00199   }
00200 }
00201 
00202 #endif