mpegheader.h

Go to the documentation of this file.

/***************************************************************************
    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., 51 Franklin Street, Fifth Floor, Boston, MA         *
 *   02110-1301  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 <memory>

#include "taglib.h"
#include "taglib_export.h"

namespace TagLib {

  class ByteVector;
  class File;

  namespace MPEG {


    class TAGLIB_EXPORT Header
    {
    public:
      Header(File *file, offset_t offset, bool checkLength = true);

      Header(const Header &h);

      ~Header();

      bool isValid() const;

      enum Version {
        Version1 = 0,
        Version2 = 1,
        Version2_5 = 2,
        Version4 = 3
      };

      Version version() const;

      int layer() const;

      bool protectionEnabled() const;

      int bitrate() const;

      int sampleRate() const;

      bool isPadded() const;

      enum ChannelMode {
        Stereo        = 0,
        JointStereo   = 1,
        DualChannel   = 2,
        SingleChannel = 3
      };

      ChannelMode channelMode() const;

      enum ChannelConfiguration {
        Custom = 0,
        FrontCenter = 1,
        FrontLeftRight = 2,
        FrontCenterLeftRight = 3,
        FrontCenterLeftRightBackCenter = 4,
        FrontCenterLeftRightBackLeftRight = 5,
        FrontCenterLeftRightBackLeftRightLFE = 6,
        FrontCenterLeftRightSideLeftRightBackLeftRightLFE = 7
      };

      ChannelConfiguration channelConfiguration() const;

      bool isADTS() const;

      bool isCopyrighted() const;

      bool isOriginal() const;

      int frameLength() const;

      int samplesPerFrame() const;

      Header &operator=(const Header &h);

    private:
      void parse(File *file, offset_t offset, bool checkLength);

      class HeaderPrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::shared_ptr<HeaderPrivate> d;
    };
  }  // namespace MPEG
}  // namespace TagLib

#endif