xiphcomment.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_VORBISCOMMENT_H
27 #define TAGLIB_VORBISCOMMENT_H
28 
29 #include "tag.h"
30 #include "tlist.h"
31 #include "tmap.h"
32 #include "tstring.h"
33 #include "tstringlist.h"
34 #include "tbytevector.h"
35 #include "taglib_export.h"
36 
37 namespace TagLib {
38 
39  namespace Ogg {
40 
48 
50 
65  {
66  public:
70  XiphComment();
71 
75  XiphComment(const ByteVector &data);
76 
80  virtual ~XiphComment();
81 
82  virtual String title() const;
83  virtual String artist() const;
84  virtual String album() const;
85  virtual String comment() const;
86  virtual String genre() const;
87  virtual uint year() const;
88  virtual uint track() const;
89 
90  virtual void setTitle(const String &s);
91  virtual void setArtist(const String &s);
92  virtual void setAlbum(const String &s);
93  virtual void setComment(const String &s);
94  virtual void setGenre(const String &s);
95  virtual void setYear(uint i);
96  virtual void setTrack(uint i);
97 
98  virtual bool isEmpty() const;
99 
103  uint fieldCount() const;
104 
141  const FieldListMap &fieldListMap() const;
142 
150  PropertyMap properties() const;
151 
159  PropertyMap setProperties(const PropertyMap&);
160 
164  static bool checkKey(const String&);
165 
170  String vendorID() const;
171 
179  void addField(const String &key, const String &value, bool replace = true);
180 
185  void removeField(const String &key, const String &value = String::null);
186 
192  bool contains(const String &key) const;
193 
197  ByteVector render() const; // BIC: remove and merge with below
198 
206  ByteVector render(bool addFramingBit) const;
207 
208  protected:
213  void parse(const ByteVector &data);
214 
215  private:
216  XiphComment(const XiphComment &);
217  XiphComment &operator=(const XiphComment &);
218 
219  class XiphCommentPrivate;
220  XiphCommentPrivate *d;
221  };
222  }
223 }
224 
225 #endif