s3mfile.h
Go to the documentation of this file.
00001 /***************************************************************************
00002     copyright           : (C) 2011 by Mathias Panzenböck
00003     email               : grosser.meister.morti@gmx.net
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_S3MFILE_H
00027 #define TAGLIB_S3MFILE_H
00028 
00029 #include "tfile.h"
00030 #include "audioproperties.h"
00031 #include "taglib_export.h"
00032 #include "modfilebase.h"
00033 #include "modtag.h"
00034 #include "s3mproperties.h"
00035 
00036 namespace TagLib {
00037 
00038   namespace S3M {
00039 
00040     class TAGLIB_EXPORT File : public Mod::FileBase {
00041       public:
00049         File(FileName file, bool readProperties = true,
00050              AudioProperties::ReadStyle propertiesStyle =
00051              AudioProperties::Average);
00052 
00063         File(IOStream *stream, bool readProperties = true,
00064              AudioProperties::ReadStyle propertiesStyle =
00065              AudioProperties::Average);
00066 
00070         virtual ~File();
00071 
00072         Mod::Tag *tag() const;
00073 
00078         PropertyMap properties() const;
00079 
00084         PropertyMap setProperties(const PropertyMap &);
00085 
00090         S3M::Properties *audioProperties() const;
00091 
00098         bool save();
00099 
00100       private:
00101         File(const File &);
00102         File &operator=(const File &);
00103 
00104         void read(bool readProperties);
00105 
00106         class FilePrivate;
00107         FilePrivate *d;
00108     };
00109   }
00110 }
00111 
00112 #endif