TagLib API Documentation
s3mfile.h
Go to the documentation of this file.
1/***************************************************************************
2 copyright : (C) 2011 by Mathias Panzenböck
3 email : grosser.meister.morti@gmx.net
4 ***************************************************************************/
5
6/***************************************************************************
7 * This library is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU Lesser General Public License version *
9 * 2.1 as published by the Free Software Foundation. *
10 * *
11 * This library is distributed in the hope that it will be useful, but *
12 * WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the Free Software *
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
19 * 02110-1301 USA *
20 * *
21 * Alternatively, this file is available under the Mozilla Public *
22 * License Version 1.1. You may obtain a copy of the License at *
23 * http://www.mozilla.org/MPL/ *
24 ***************************************************************************/
25
26#ifndef TAGLIB_S3MFILE_H
27#define TAGLIB_S3MFILE_H
28
29#include "tfile.h"
30#include "taglib_export.h"
31#include "audioproperties.h"
32#include "modfilebase.h"
33#include "modtag.h"
34#include "s3mproperties.h"
35
36namespace TagLib {
37
39
44 namespace S3M {
45
47
56 public:
64 File(FileName file, bool readProperties = true,
65 AudioProperties::ReadStyle propertiesStyle =
67
78 File(IOStream *stream, bool readProperties = true,
79 AudioProperties::ReadStyle propertiesStyle =
81
85 ~File() override;
86
87 File(const File &) = delete;
88 File &operator=(const File &) = delete;
89
90 Mod::Tag *tag() const override;
91
96 PropertyMap properties() const override;
97
103
109
116 bool save() override;
117
118 private:
119 void read(bool readProperties);
120
121 class FilePrivate;
123 std::unique_ptr<FilePrivate> d;
124 };
125 } // namespace S3M
126} // namespace TagLib
127
128#endif
ReadStyle
Definition: audioproperties.h:56
@ Average
Read more of the file and make better values guesses.
Definition: audioproperties.h:60
An abstract class that provides operations on a sequence of bytes.
Definition: tiostream.h:65
Base class for module files.
Definition: modfilebase.h:38
A module file tag implementation.
Definition: modtag.h:49
A map for format-independent <key,values> tag representations.
Definition: tpropertymap.h:123
An implementation of TagLib::File with S3M specific methods.
Definition: s3mfile.h:55
File(const File &)=delete
S3M::Properties * audioProperties() const override
File & operator=(const File &)=delete
bool save() override
PropertyMap properties() const override
PropertyMap setProperties(const PropertyMap &) override
Mod::Tag * tag() const override
File(IOStream *stream, bool readProperties=true, AudioProperties::ReadStyle propertiesStyle=AudioProperties::Average)
~File() override
File(FileName file, bool readProperties=true, AudioProperties::ReadStyle propertiesStyle=AudioProperties::Average)
An implementation of audio property reading for S3M.
Definition: s3mproperties.h:34
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
const char * FileName
Definition: tiostream.h:59
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
#define TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
Definition: taglib_export.h:55