Added TagLib (with AUTORS and COPYING files)

[someplayer] / src / taglib / riff / rifffile.h

diff --git a/src/taglib/riff/rifffile.h b/src/taglib/riff/rifffile.h
new file mode 100644 (file)
index 0000000..3b375e2
--- /dev/null
+++ b/src/taglib/riff/rifffile.h
@@ -0,0 +1,105 @@
+/***************************************************************************
+    copyright            : (C) 2002 - 2008 by Scott Wheeler
+    email                : wheeler@kde.org
+ ***************************************************************************/
+
+/***************************************************************************
+ *   This library is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU Lesser General Public License version   *
+ *   2.1 as published by the Free Software Foundation.                     *
+ *                                                                         *
+ *   This library is distributed in the hope that it will be useful, but   *
+ *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
+ *   Lesser General Public License for more details.                       *
+ *                                                                         *
+ *   You should have received a copy of the GNU Lesser General Public      *
+ *   License along with this library; if not, write to the Free Software   *
+ *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
+ *   USA                                                                   *
+ *                                                                         *
+ *   Alternatively, this file is available under the Mozilla Public        *
+ *   License Version 1.1.  You may obtain a copy of the License at         *
+ *   http://www.mozilla.org/MPL/                                           *
+ ***************************************************************************/
+
+#ifndef TAGLIB_RIFFFILE_H
+#define TAGLIB_RIFFFILE_H
+
+#include "taglib_export.h"
+#include "tfile.h"
+
+namespace TagLib {
+
+  //! An implementation of TagLib::File with RIFF specific methods
+
+  namespace RIFF {
+
+    //! An RIFF file class with some useful methods specific to RIFF
+
+    /*!
+     * This implements the generic TagLib::File API and additionally provides
+     * access to properties that are distinct to RIFF files, notably access
+     * to the different ID3 tags.
+     */
+
+    class TAGLIB_EXPORT File : public TagLib::File
+    {
+    public:
+      /*!
+       * Destroys this instance of the File.
+       */
+      virtual ~File();
+
+    protected:
+
+      enum Endianness { BigEndian, LittleEndian };
+
+      File(FileName file, Endianness endianness);
+
+      /*!
+       * \return The number of chunks in the file.
+       */
+      uint chunkCount() const;
+
+      /*!
+       * \return The offset within the file for the selected chunk number.
+       */
+      uint chunkOffset(uint i) const;
+
+      /*!
+       * \return The name of the specified chunk, for instance, "COMM" or "ID3 "
+       */
+      ByteVector chunkName(uint i) const;
+
+      /*!
+       * Reads the chunk data from the file and returns it.
+       *
+       * \note This \e will move the read pointer for the file.
+       */
+      ByteVector chunkData(uint i);
+
+      /*!
+       * Sets the data for the chunk \a name to \a data.  If a chunk with the
+       * given name already exists it will be overwritten, otherwise it will be
+       * created after the existing chunks.
+       *
+       * \warning This will update the file immediately.
+       */
+      void setChunkData(const ByteVector &name, const ByteVector &data);
+
+    private:
+      File(const File &);
+      File &operator=(const File &);
+
+      void read();
+      void writeChunk(const ByteVector &name, const ByteVector &data,
+                      ulong offset, ulong replace = 0);
+
+      class FilePrivate;
+      FilePrivate *d;
+    };
+  }
+}
+
+#endif