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 
33 #include "flacpicture.h"
34 #include "flacproperties.h"
35 
36 namespace TagLib {
37 
38  class Tag;
39 
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 
96  virtual ~File();
97 
106  virtual TagLib::Tag *tag() const;
107 
112  virtual Properties *audioProperties() const;
113 
121  virtual bool save();
122 
134  ID3v2::Tag *ID3v2Tag(bool create = false);
135 
147  ID3v1::Tag *ID3v1Tag(bool create = false);
148 
160  Ogg::XiphComment *xiphComment(bool create = false);
161 
169  void setID3v2FrameFactory(const ID3v2::FrameFactory *factory);
170 
177  ByteVector streamInfoData(); // BIC: remove
178 
185  long streamLength(); // BIC: remove
186 
190  List<Picture *> pictureList();
191 
195  void removePictures();
196 
203  void addPicture(Picture *picture);
204 
205  private:
206  File(const File &);
207  File &operator=(const File &);
208 
209  void read(bool readProperties, Properties::ReadStyle propertiesStyle);
210  void scan();
211  long findID3v2();
212  long findID3v1();
213  ByteVector xiphCommentData() const;
214  long findPaddingBreak(long nextPageOffset, long targetOffset, bool *isLast);
215 
216  class FilePrivate;
217  FilePrivate *d;
218  };
219  }
220 }
221 
222 #endif