Added TagLib (with AUTORS and COPYING files)

[someplayer] / src / taglib / ogg / vorbis / vorbisfile.h

diff --git a/src/taglib/ogg/vorbis/vorbisfile.h b/src/taglib/ogg/vorbis/vorbisfile.h
new file mode 100644 (file)
index 0000000..9eb5ac6
--- /dev/null
+++ b/src/taglib/ogg/vorbis/vorbisfile.h
@@ -0,0 +1,118 @@
+/***************************************************************************
+    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_VORBISFILE_H
+#define TAGLIB_VORBISFILE_H
+
+#include "taglib_export.h"
+#include "oggfile.h"
+#include "xiphcomment.h"
+
+#include "vorbisproperties.h"
+
+namespace TagLib {
+
+/*
+ * This is just to make this appear to be in the Ogg namespace in the
+ * documentation.  The typedef below will make this work with the current code.
+ * In the next BIC version of TagLib this will be really moved into the Ogg
+ * namespace.
+ */
+
+#ifdef DOXYGEN
+  namespace Ogg {
+#endif
+
+  //! A namespace containing classes for Vorbis metadata
+
+  namespace Vorbis {
+
+
+    //! An implementation of Ogg::File with Vorbis specific methods
+
+    /*!
+     * This is the central class in the Ogg Vorbis metadata processing collection
+     * of classes.  It's built upon Ogg::File which handles processing of the Ogg
+     * logical bitstream and breaking it down into pages which are handled by
+     * the codec implementations, in this case Vorbis specifically.
+     */
+
+    class TAGLIB_EXPORT File : public Ogg::File
+    {
+    public:
+      /*!
+       * Contructs a Vorbis file from \a file.  If \a readProperties is true the
+       * file's audio properties will also be read using \a propertiesStyle.  If
+       * false, \a propertiesStyle is ignored.
+       */
+      File(FileName file, bool readProperties = true,
+           Properties::ReadStyle propertiesStyle = Properties::Average);
+
+      /*!
+       * Destroys this instance of the File.
+       */
+      virtual ~File();
+
+      /*!
+       * Returns the XiphComment for this file.  XiphComment implements the tag
+       * interface, so this serves as the reimplementation of
+       * TagLib::File::tag().
+       */
+      virtual Ogg::XiphComment *tag() const;
+
+      /*!
+       * Returns the Vorbis::Properties for this file.  If no audio properties
+       * were read then this will return a null pointer.
+       */
+      virtual Properties *audioProperties() const;
+
+      virtual bool save();
+
+    private:
+      File(const File &);
+      File &operator=(const File &);
+
+      void read(bool readProperties, Properties::ReadStyle propertiesStyle);
+
+      class FilePrivate;
+      FilePrivate *d;
+    };
+  }
+
+/*
+ * To keep compatibility with the current version put Vorbis in the Ogg namespace
+ * only in the docs and provide a typedef to make it work.  In the next BIC
+ * version this will be removed and it will only exist in the Ogg namespace.
+ */
+
+#ifdef DOXYGEN
+  }
+#else
+  namespace Ogg { namespace Vorbis { typedef TagLib::Vorbis::File File; } }
+#endif
+
+}
+
+#endif