flacfile.h
Go to the documentation of this file.
1 /***************************************************************************
2  copyright : (C) 2003 by Allan Sandfeld Jensen
3  email : kde@carewolf.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_FLACFILE_H
27 #define TAGLIB_FLACFILE_H
28 
29 #include "taglib_export.h"
30 #include "tfile.h"
31 #include "tlist.h"
32 #include "tag.h"
33 
34 #include "flacpicture.h"
35 #include "flacproperties.h"
36 
37 namespace TagLib {
38 
39  class Tag;
40  namespace ID3v2 { class FrameFactory; class Tag; }
41  namespace ID3v1 { class Tag; }
42  namespace Ogg { class XiphComment; }
43 
45 
55  namespace FLAC {
56 
58 
67  {
68  public:
78  File(FileName file, bool readProperties = true,
79  Properties::ReadStyle propertiesStyle = Properties::Average);
80 
90  // BIC: merge with the above constructor
91  File(FileName file, ID3v2::FrameFactory *frameFactory,
92  bool readProperties = true,
93  Properties::ReadStyle propertiesStyle = Properties::Average);
94 
107  // BIC: merge with the above constructor
108  File(IOStream *stream, ID3v2::FrameFactory *frameFactory,
109  bool readProperties = true,
110  Properties::ReadStyle propertiesStyle = Properties::Average);
111 
115  virtual ~File();
116 
125  virtual TagLib::Tag *tag() const;
126 
133  PropertyMap properties() const;
134 
135  void removeUnsupportedProperties(const StringList &);
136 
144  PropertyMap setProperties(const PropertyMap &);
145 
150  virtual Properties *audioProperties() const;
151 
159  virtual bool save();
160 
178  ID3v2::Tag *ID3v2Tag(bool create = false);
179 
197  ID3v1::Tag *ID3v1Tag(bool create = false);
198 
216  Ogg::XiphComment *xiphComment(bool create = false);
217 
225  void setID3v2FrameFactory(const ID3v2::FrameFactory *factory);
226 
233  ByteVector streamInfoData(); // BIC: remove
234 
241  long streamLength(); // BIC: remove
242 
246  List<Picture *> pictureList();
247 
252  void removePicture(Picture *picture, bool del = true);
253 
257  void removePictures();
258 
265  void addPicture(Picture *picture);
266 
272  bool hasXiphComment() const;
273 
279  bool hasID3v1Tag() const;
280 
286  bool hasID3v2Tag() const;
287 
288  private:
289  File(const File &);
290  File &operator=(const File &);
291 
292  void read(bool readProperties, Properties::ReadStyle propertiesStyle);
293  void scan();
294  long findID3v2();
295  long findID3v1();
296  ByteVector xiphCommentData() const;
297  long findPaddingBreak(long nextPageOffset, long targetOffset, bool *isLast);
298 
299  class FilePrivate;
300  FilePrivate *d;
301  };
302  }
303 }
304 
305 #endif