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:
77  File(FileName file, bool readProperties = true,
78  Properties::ReadStyle propertiesStyle = Properties::Average);
79 
88  // BIC: merge with the above constructor
89  File(FileName file, ID3v2::FrameFactory *frameFactory,
90  bool readProperties = true,
91  Properties::ReadStyle propertiesStyle = Properties::Average);
92 
104  // BIC: merge with the above constructor
105  File(IOStream *stream, ID3v2::FrameFactory *frameFactory,
106  bool readProperties = true,
107  Properties::ReadStyle propertiesStyle = Properties::Average);
108 
112  virtual ~File();
113 
122  virtual TagLib::Tag *tag() const;
123 
130  PropertyMap properties() const;
131 
132  void removeUnsupportedProperties(const StringList &);
133 
141  PropertyMap setProperties(const PropertyMap &);
142 
147  virtual Properties *audioProperties() const;
148 
156  virtual bool save();
157 
169  ID3v2::Tag *ID3v2Tag(bool create = false);
170 
182  ID3v1::Tag *ID3v1Tag(bool create = false);
183 
195  Ogg::XiphComment *xiphComment(bool create = false);
196 
204  void setID3v2FrameFactory(const ID3v2::FrameFactory *factory);
205 
212  ByteVector streamInfoData(); // BIC: remove
213 
220  long streamLength(); // BIC: remove
221 
225  List<Picture *> pictureList();
226 
231  void removePicture(Picture *picture, bool del = true);
232 
236  void removePictures();
237 
244  void addPicture(Picture *picture);
245 
246  private:
247  File(const File &);
248  File &operator=(const File &);
249 
250  void read(bool readProperties, Properties::ReadStyle propertiesStyle);
251  void scan();
252  long findID3v2();
253  long findID3v1();
254  ByteVector xiphCommentData() const;
255  long findPaddingBreak(long nextPageOffset, long targetOffset, bool *isLast);
256 
257  class FilePrivate;
258  FilePrivate *d;
259  };
260  }
261 }
262 
263 #endif