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,            *
00019  *   MA  02110-1301  USA                                                   *
00020  ***************************************************************************/
00021 
00022 #ifndef TAGLIB_S3MFILE_H
00023 #define TAGLIB_S3MFILE_H
00024 
00025 #include "tfile.h"
00026 #include "audioproperties.h"
00027 #include "taglib_export.h"
00028 #include "modfilebase.h"
00029 #include "modtag.h"
00030 #include "s3mproperties.h"
00031 
00032 namespace TagLib {
00033 
00034   namespace S3M {
00035 
00036     class TAGLIB_EXPORT File : public Mod::FileBase {
00037       public:
00043         File(FileName file, bool readProperties = true,
00044              AudioProperties::ReadStyle propertiesStyle =
00045              AudioProperties::Average);
00046 
00055         File(IOStream *stream, bool readProperties = true,
00056              AudioProperties::ReadStyle propertiesStyle =
00057              AudioProperties::Average);
00058 
00062         virtual ~File();
00063 
00064         Mod::Tag *tag() const;
00065 
00070         PropertyMap properties() const;
00071 
00076         PropertyMap setProperties(const PropertyMap &);
00077 
00082         S3M::Properties *audioProperties() const;
00083 
00090         bool save();
00091 
00092       private:
00093         File(const File &);
00094         File &operator=(const File &);
00095 
00096         void read(bool readProperties);
00097 
00098         class FilePrivate;
00099         FilePrivate *d;
00100     };
00101   }
00102 }
00103 
00104 #endif