s3mproperties.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, *
19  * MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef TAGLIB_S3MPROPERTIES_H
23 #define TAGLIB_S3MPROPERTIES_H
24 
25 #include "taglib.h"
26 #include "audioproperties.h"
27 
28 namespace TagLib {
29  namespace S3M {
31  friend class File;
32  public:
34  enum {
35  ST2Vibrato = 1,
36  ST2Tempo = 2,
37  AmigaSlides = 4,
38  Vol0MixOptimizations = 8,
39  AmigaLimits = 16,
40  EnableFilter = 32,
41  CustomData = 128
42  };
43 
44  Properties(AudioProperties::ReadStyle propertiesStyle);
45  virtual ~Properties();
46 
47  int length() const;
48  int lengthInSeconds() const;
49  int lengthInMilliseconds() const;
50  int bitrate() const;
51  int sampleRate() const;
52  int channels() const;
53 
54  ushort lengthInPatterns() const;
55  bool stereo() const;
56  ushort sampleCount() const;
57  ushort patternCount() const;
58  ushort flags() const;
59  ushort trackerVersion() const;
60  ushort fileFormatVersion() const;
61  uchar globalVolume() const;
62  uchar masterVolume() const;
63  uchar tempo() const;
64  uchar bpmSpeed() const;
65 
66  void setChannels(int channels);
67 
68  void setLengthInPatterns (ushort lengthInPatterns);
69  void setStereo (bool stereo);
70  void setSampleCount (ushort sampleCount);
71  void setPatternCount (ushort patternCount);
72  void setFlags (ushort flags);
73  void setTrackerVersion (ushort trackerVersion);
74  void setFileFormatVersion(ushort fileFormatVersion);
75  void setGlobalVolume (uchar globalVolume);
76  void setMasterVolume (uchar masterVolume);
77  void setTempo (uchar tempo);
78  void setBpmSpeed (uchar bpmSpeed);
79 
80  private:
81  Properties(const Properties&);
82  Properties &operator=(const Properties&);
83 
84  class PropertiesPrivate;
85  PropertiesPrivate *d;
86  };
87  }
88 }
89 
90 #endif
Definition: s3mproperties.h:30
unsigned short ushort
Definition: taglib.h:65
unsigned char uchar
Definition: taglib.h:64
ReadStyle
Definition: audioproperties.h:53
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
A simple, abstract interface to common audio properties.
Definition: audioproperties.h:42
Definition: s3mfile.h:36
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41