TagLib API Documentation
rifffile.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_RIFFFILE_H
27#define TAGLIB_RIFFFILE_H
28
29#include "tfile.h"
30#include "taglib_export.h"
31
32namespace TagLib {
33
35
36 namespace RIFF {
37
39
47 {
48 public:
52 ~File() override;
53
54 File(const File &) = delete;
55 File &operator=(const File &) = delete;
56
57 protected:
58
59 enum Endianness { BigEndian, LittleEndian };
60
61 File(FileName file, Endianness endianness);
62 File(IOStream *stream, Endianness endianness);
63
67 unsigned int riffSize() const;
68
72 unsigned int chunkCount() const;
73
77 offset_t chunkOffset(unsigned int i) const;
78
82 unsigned int chunkDataSize(unsigned int i) const;
83
87 unsigned int chunkPadding(unsigned int i) const;
88
92 ByteVector chunkName(unsigned int i) const;
93
99 ByteVector chunkData(unsigned int i);
100
106 void setChunkData(unsigned int i, const ByteVector &data);
107
115 void setChunkData(const ByteVector &name, const ByteVector &data);
116
128 void setChunkData(const ByteVector &name, const ByteVector &data, bool alwaysCreate);
129
135 void removeChunk(unsigned int i);
136
143 void removeChunk(const ByteVector &name);
144
145 private:
146 void read();
147 void writeChunk(const ByteVector &name, const ByteVector &data,
148 offset_t offset, unsigned long replace = 0);
149
153 void updateGlobalSize();
154
155 class FilePrivate;
157 std::unique_ptr<FilePrivate> d;
158 };
159 } // namespace RIFF
160} // namespace TagLib
161
162#endif
A byte vector.
Definition: tbytevector.h:46
A file class with some useful methods for tag manipulation.
Definition: tfile.h:51
An abstract class that provides operations on a sequence of bytes.
Definition: tiostream.h:65
A RIFF file class with some useful methods specific to RIFF.
Definition: rifffile.h:47
void setChunkData(const ByteVector &name, const ByteVector &data, bool alwaysCreate)
File & operator=(const File &)=delete
void removeChunk(unsigned int i)
unsigned int chunkCount() const
File(const File &)=delete
void removeChunk(const ByteVector &name)
ByteVector chunkData(unsigned int i)
void setChunkData(const ByteVector &name, const ByteVector &data)
unsigned int chunkDataSize(unsigned int i) const
offset_t chunkOffset(unsigned int i) const
unsigned int riffSize() const
unsigned int chunkPadding(unsigned int i) const
File(FileName file, Endianness endianness)
File(IOStream *stream, Endianness endianness)
void setChunkData(unsigned int i, const ByteVector &data)
Endianness
Definition: rifffile.h:59
@ BigEndian
Definition: rifffile.h:59
ByteVector chunkName(unsigned int i) const
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
off_t offset_t
Definition: taglib.h:64
const char * FileName
Definition: tiostream.h:59
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
#define TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
Definition: taglib_export.h:55