mpegfile.h
Go to the documentation of this file.
1 /***************************************************************************
2  copyright : (C) 2002 - 2008 by Scott Wheeler
3  email : wheeler@kde.org
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_MPEGFILE_H
27 #define TAGLIB_MPEGFILE_H
28 
29 #include "taglib_export.h"
30 #include "tfile.h"
31 #include "tag.h"
32 
33 #include "mpegproperties.h"
34 
35 namespace TagLib {
36 
37  namespace ID3v2 { class Tag; class FrameFactory; }
38  namespace ID3v1 { class Tag; }
39  namespace APE { class Tag; }
40 
42 
43  namespace MPEG {
44 
46 
54  {
55  public:
60  enum TagTypes {
62  NoTags = 0x0000,
64  ID3v1 = 0x0001,
66  ID3v2 = 0x0002,
68  APE = 0x0004,
70  AllTags = 0xffff
71  };
72 
82  File(FileName file, bool readProperties = true,
83  Properties::ReadStyle propertiesStyle = Properties::Average);
84 
94  // BIC: merge with the above constructor
95  File(FileName file, ID3v2::FrameFactory *frameFactory,
96  bool readProperties = true,
97  Properties::ReadStyle propertiesStyle = Properties::Average);
98 
111  File(IOStream *stream, ID3v2::FrameFactory *frameFactory,
112  bool readProperties = true,
113  Properties::ReadStyle propertiesStyle = Properties::Average);
114 
118  virtual ~File();
119 
137  virtual Tag *tag() const;
138 
145  PropertyMap properties() const;
146 
147  void removeUnsupportedProperties(const StringList &properties);
148 
157  PropertyMap setProperties(const PropertyMap &);
158 
163  virtual Properties *audioProperties() const;
164 
180  virtual bool save();
181 
191  bool save(int tags);
192 
202  // BIC: combine with the above method
203  bool save(int tags, bool stripOthers);
204 
217  // BIC: combine with the above method
218  bool save(int tags, bool stripOthers, int id3v2Version);
219 
235  // BIC: combine with the above method
236  bool save(int tags, bool stripOthers, int id3v2Version, bool duplicateTags);
237 
255  ID3v2::Tag *ID3v2Tag(bool create = false);
256 
274  ID3v1::Tag *ID3v1Tag(bool create = false);
275 
293  APE::Tag *APETag(bool create = false);
294 
305  bool strip(int tags = AllTags);
306 
315  // BIC: merge with the method above
316  bool strip(int tags, bool freeMemory);
317 
323  void setID3v2FrameFactory(const ID3v2::FrameFactory *factory);
324 
328  long firstFrameOffset();
329 
334  long nextFrameOffset(long position);
335 
340  long previousFrameOffset(long position);
341 
345  long lastFrameOffset();
346 
352  bool hasID3v1Tag() const;
353 
359  bool hasID3v2Tag() const;
360 
366  bool hasAPETag() const;
367 
368  private:
369  File(const File &);
370  File &operator=(const File &);
371 
372  void read(bool readProperties, Properties::ReadStyle propertiesStyle);
373  long findID3v2();
374  long findID3v1();
375  void findAPE();
376 
382  static bool secondSynchByte(char byte);
383 
384  class FilePrivate;
385  FilePrivate *d;
386  };
387  }
388 }
389 
390 #endif