Added TagLib (with AUTORS and COPYING files)

[someplayer] / src / taglib / mpeg / mpegheader.h

diff --git a/src/taglib/mpeg/mpegheader.h b/src/taglib/mpeg/mpegheader.h
new file mode 100644 (file)
index 0000000..c774de8
--- /dev/null
+++ b/src/taglib/mpeg/mpegheader.h
@@ -0,0 +1,166 @@
+/***************************************************************************
+    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_MPEGHEADER_H
+#define TAGLIB_MPEGHEADER_H
+
+#include "taglib_export.h"
+
+namespace TagLib {
+
+  class ByteVector;
+
+  namespace MPEG {
+
+    //! An implementation of MP3 frame headers
+
+    /*!
+     * This is an implementation of MPEG Layer III headers.  The API follows more
+     * or less the binary format of these headers.  I've used
+     * <a href="http://www.mp3-tech.org/programmer/frame_header.html">this</a>
+     * document as a reference.
+     */
+
+    class TAGLIB_EXPORT Header
+    {
+    public:
+      /*!
+       * Parses an MPEG header based on \a data.
+       */
+      Header(const ByteVector &data);
+
+      /*!
+       * Does a shallow copy of \a h.
+       */
+      Header(const Header &h);
+
+      /*!
+       * Destroys this Header instance.
+       */
+      virtual ~Header();
+
+      /*!
+       * Returns true if the frame is at least an appropriate size and has
+       * legal values.
+       */
+      bool isValid() const;
+
+      /*!
+       * The MPEG Version.
+       */
+      enum Version {
+        //! MPEG Version 1
+        Version1 = 0,
+        //! MPEG Version 2
+        Version2 = 1,
+        //! MPEG Version 2.5
+        Version2_5 = 2
+      };
+
+      /*!
+       * Returns the MPEG Version of the header.
+       */
+      Version version() const;
+
+      /*!
+       * Returns the layer version.  This will be between the values 1-3.
+       */
+      int layer() const;
+
+      /*!
+       * Returns true if the MPEG protection bit is enabled.
+       */
+      bool protectionEnabled() const;
+
+      /*!
+       * Returns the bitrate encoded in the header.
+       */
+      int bitrate() const;
+
+      /*!
+       * Returns the sample rate in Hz.
+       */
+      int sampleRate() const;
+
+      /*!
+       * Returns true if the frame is padded.
+       */
+      bool isPadded() const;
+
+      /*!
+       * There are a few combinations or one or two channel audio that are
+       * possible:
+       */
+      enum ChannelMode {
+        //! Stereo
+        Stereo        = 0,
+        //! Stereo
+        JointStereo   = 1,
+        //! Dual Mono
+        DualChannel   = 2,
+        //! Mono
+        SingleChannel = 3
+      };
+
+      /*!
+       * Returns the channel mode for this frame.
+       */
+      ChannelMode channelMode() const;
+
+      /*!
+       * Returns true if the copyrighted bit is set.
+       */
+      bool isCopyrighted() const;
+
+      /*!
+       * Returns true if the "original" bit is set.
+       */
+      bool isOriginal() const;
+
+      /*!
+       * Returns the frame length.
+       */
+      int frameLength() const;
+
+      /*!
+       * Returns the number of frames per sample.
+       */
+      int samplesPerFrame() const;
+
+      /*!
+       * Makes a shallow copy of the header.
+       */
+      Header &operator=(const Header &h);
+
+    private:
+      void parse(const ByteVector &data);
+
+      class HeaderPrivate;
+      HeaderPrivate *d;
+    };
+  }
+}
+
+#endif