1 /***************************************************************************
2 copyright : (C) 2002 - 2008 by Scott Wheeler
3 email : wheeler@kde.org
4 ***************************************************************************/
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. *
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. *
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
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 ***************************************************************************/
26 #ifndef TAGLIB_RIFFFILE_H
27 #define TAGLIB_RIFFFILE_H
29 #include "taglib_export.h"
34 //! An implementation of TagLib::File with RIFF specific methods
38 //! An RIFF file class with some useful methods specific to RIFF
41 * This implements the generic TagLib::File API and additionally provides
42 * access to properties that are distinct to RIFF files, notably access
43 * to the different ID3 tags.
46 class TAGLIB_EXPORT File : public TagLib::File
50 * Destroys this instance of the File.
56 enum Endianness { BigEndian, LittleEndian };
58 File(FileName file, Endianness endianness);
61 * \return The number of chunks in the file.
63 uint chunkCount() const;
66 * \return The offset within the file for the selected chunk number.
68 uint chunkOffset(uint i) const;
71 * \return The name of the specified chunk, for instance, "COMM" or "ID3 "
73 ByteVector chunkName(uint i) const;
76 * Reads the chunk data from the file and returns it.
78 * \note This \e will move the read pointer for the file.
80 ByteVector chunkData(uint i);
83 * Sets the data for the chunk \a name to \a data. If a chunk with the
84 * given name already exists it will be overwritten, otherwise it will be
85 * created after the existing chunks.
87 * \warning This will update the file immediately.
89 void setChunkData(const ByteVector &name, const ByteVector &data);
93 File &operator=(const File &);
96 void writeChunk(const ByteVector &name, const ByteVector &data,
97 ulong offset, ulong replace = 0);